From 4c1b9f5c19c00278f0b01bdbc820c761dedf6524 Mon Sep 17 00:00:00 2001 From: Michał Górny Date: Fri, 3 Jun 2022 11:12:51 +0200 Subject: Update Guide to a71e618 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Michał Górny --- guide/_sources/pytest.rst.txt | 2 +- guide/_static/basic.css | 40 +- guide/_static/doctools.js | 480 ++++++++------------ guide/_static/documentation_options.js | 4 +- guide/_static/jquery.js | 4 +- guide/_static/language_data.js | 100 +---- guide/_static/searchtools.js | 784 +++++++++++++++++---------------- guide/any.html | 21 +- guide/basic.html | 23 +- guide/buildsys.html | 33 +- guide/concept.html | 23 +- guide/depend.html | 17 +- guide/distutils-legacy.html | 27 +- guide/distutils.html | 86 ++-- guide/eclass.html | 21 +- guide/expert-multi.html | 27 +- guide/genindex.html | 7 +- guide/helper.html | 19 +- guide/index.html | 17 +- guide/interpreter-maintenance.html | 27 +- guide/interpreter.html | 19 +- guide/migration.html | 21 +- guide/multi.html | 21 +- guide/package-maintenance.html | 21 +- guide/porting.html | 39 +- guide/preface.html | 11 +- guide/pytest.html | 39 +- guide/search.html | 5 +- guide/searchindex.js | 2 +- guide/single.html | 23 +- guide/test.html | 27 +- 31 files changed, 918 insertions(+), 1072 deletions(-) (limited to 'guide') diff --git a/guide/_sources/pytest.rst.txt b/guide/_sources/pytest.rst.txt index e373715..1ebd276 100644 --- a/guide/_sources/pytest.rst.txt +++ b/guide/_sources/pytest.rst.txt @@ -47,7 +47,7 @@ requires using the local scope. python_test() { local EPYTEST_IGNORE=( # ignore whole file with missing dep - --ignore tests/test_client.py + tests/test_client.py ) local EPYTEST_DESELECT=( # deselect a single test diff --git a/guide/_static/basic.css b/guide/_static/basic.css index bf18350..9039e02 100644 --- a/guide/_static/basic.css +++ b/guide/_static/basic.css @@ -222,7 +222,7 @@ table.modindextable td { /* -- general body styles --------------------------------------------------- */ div.body { - min-width: 450px; + min-width: 360px; max-width: 800px; } @@ -335,13 +335,13 @@ p.sidebar-title { font-weight: bold; } -div.admonition, div.topic, blockquote { +div.admonition, div.topic, aside.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ -div.topic { +div.topic, aside.topic { border: 1px solid #ccc; padding: 7px; margin: 10px 0 10px 0; @@ -380,6 +380,7 @@ div.body p.centered { div.sidebar > :last-child, aside.sidebar > :last-child, div.topic > :last-child, +aside.topic > :last-child, div.admonition > :last-child { margin-bottom: 0; } @@ -387,6 +388,7 @@ div.admonition > :last-child { div.sidebar::after, aside.sidebar::after, div.topic::after, +aside.topic::after, div.admonition::after, blockquote::after { display: block; @@ -428,10 +430,6 @@ table.docutils td, table.docutils th { border-bottom: 1px solid #aaa; } -table.footnote td, table.footnote th { - border: 0 !important; -} - th { text-align: left; padding-right: 5px; @@ -615,6 +613,7 @@ ul.simple p { margin-bottom: 0; } +/* Docutils 0.17 and older (footnotes & citations) */ dl.footnote > dt, dl.citation > dt { float: left; @@ -632,6 +631,33 @@ dl.citation > dd:after { clear: both; } +/* Docutils 0.18+ (footnotes & citations) */ +aside.footnote > span, +div.citation > span { + float: left; +} +aside.footnote > span:last-of-type, +div.citation > span:last-of-type { + padding-right: 0.5em; +} +aside.footnote > p { + margin-left: 2em; +} +div.citation > p { + margin-left: 4em; +} +aside.footnote > p:last-of-type, +div.citation > p:last-of-type { + margin-bottom: 0em; +} +aside.footnote > p:last-of-type:after, +div.citation > p:last-of-type:after { + content: ""; + clear: both; +} + +/* Footnotes & citations ends */ + dl.field-list { display: grid; grid-template-columns: fit-content(30%) auto; diff --git a/guide/_static/doctools.js b/guide/_static/doctools.js index e1bfd70..c3db08d 100644 --- a/guide/_static/doctools.js +++ b/guide/_static/doctools.js @@ -2,357 +2,263 @@ * doctools.js * ~~~~~~~~~~~ * - * Sphinx JavaScript utilities for all documentation. + * Base JavaScript utilities for all Sphinx HTML documentation. * * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ +"use strict"; -/** - * select a different prefix for underscore - */ -$u = _.noConflict(); - -/** - * make the code below compatible with browsers without - * an installed firebug like debugger -if (!window.console || !console.firebug) { - var names = ["log", "debug", "info", "warn", "error", "assert", "dir", - "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", - "profile", "profileEnd"]; - window.console = {}; - for (var i = 0; i < names.length; ++i) - window.console[names[i]] = function() {}; -} - */ - -/** - * small helper function to urldecode strings - * - * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL - */ -jQuery.urldecode = function(x) { - if (!x) { - return x +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); } - return decodeURIComponent(x.replace(/\+/g, ' ')); }; /** - * small helper function to urlencode strings + * highlight a given string on a node by wrapping it in + * span elements with the given class name. */ -jQuery.urlencode = encodeURIComponent; +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; -/** - * This function returns the parsed url parameters of the - * current request. Multiple values per key are supported, - * it will always return arrays of strings for the value parts. - */ -jQuery.getQueryParameters = function(s) { - if (typeof s === 'undefined') - s = document.location.search; - var parts = s.substr(s.indexOf('?') + 1).split('&'); - var result = {}; - for (var i = 0; i < parts.length; i++) { - var tmp = parts[i].split('=', 2); - var key = jQuery.urldecode(tmp[0]); - var value = jQuery.urldecode(tmp[1]); - if (key in result) - result[key].push(value); - else - result[key] = [value]; - } - return result; -}; + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } -/** - * highlight a given string on a jquery object by wrapping it in - * span elements with the given class name. - */ -jQuery.fn.highlightText = function(text, className) { - function highlight(node, addItems) { - if (node.nodeType === 3) { - var val = node.nodeValue; - var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && - !jQuery(node.parentNode).hasClass(className) && - !jQuery(node.parentNode).hasClass("nohighlight")) { - var span; - var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.className = className; - } - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - node.parentNode.insertBefore(span, node.parentNode.insertBefore( + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + parent.insertBefore( + span, + parent.insertBefore( document.createTextNode(val.substr(pos + text.length)), - node.nextSibling)); - node.nodeValue = val.substr(0, pos); - if (isInSVG) { - var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); - var bbox = node.parentElement.getBBox(); - rect.x.baseVal.value = bbox.x; - rect.y.baseVal.value = bbox.y; - rect.width.baseVal.value = bbox.width; - rect.height.baseVal.value = bbox.height; - rect.setAttribute('class', className); - addItems.push({ - "parent": node.parentNode, - "target": rect}); - } + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); } } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this, addItems); - }); - } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); } - var addItems = []; - var result = this.each(function() { - highlight(this, addItems); - }); - for (var i = 0; i < addItems.length; ++i) { - jQuery(addItems[i].parent).before(addItems[i].target); - } - return result; }; - -/* - * backward compatibility for jQuery.browser - * This will be supported until firefox bug is fixed. - */ -if (!jQuery.browser) { - jQuery.uaMatch = function(ua) { - ua = ua.toLowerCase(); - - var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || - /(webkit)[ \/]([\w.]+)/.exec(ua) || - /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || - /(msie) ([\w.]+)/.exec(ua) || - ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || - []; - - return { - browser: match[ 1 ] || "", - version: match[ 2 ] || "0" - }; - }; - jQuery.browser = {}; - jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; -} +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; /** * Small JavaScript module for the documentation. */ -var Documentation = { - - init : function() { - this.fixFirefoxAnchorBug(); - this.highlightSearchWords(); - this.initIndexTable(); - this.initOnKeyListeners(); +const Documentation = { + init: () => { + Documentation.highlightSearchWords(); + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); }, /** * i18n support */ - TRANSLATIONS : {}, - PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, - LOCALE : 'unknown', + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", // gettext and ngettext don't access this so that the functions // can safely bound to a different name (_ = Documentation.gettext) - gettext : function(string) { - var translated = Documentation.TRANSLATIONS[string]; - if (typeof translated === 'undefined') - return string; - return (typeof translated === 'string') ? translated : translated[0]; - }, - - ngettext : function(singular, plural, n) { - var translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated === 'undefined') - return (n == 1) ? singular : plural; - return translated[Documentation.PLURALEXPR(n)]; - }, - - addTranslations : function(catalog) { - for (var key in catalog.messages) - this.TRANSLATIONS[key] = catalog.messages[key]; - this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); - this.LOCALE = catalog.locale; + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } }, - /** - * add context elements like header anchor links - */ - addContextElements : function() { - $('div[id] > :header:first').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this headline')). - appendTo(this); - }); - $('dt[id]').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this definition')). - appendTo(this); - }); + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; }, - /** - * workaround a firefox stupidity - * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 - */ - fixFirefoxAnchorBug : function() { - if (document.location.hash && $.browser.mozilla) - window.setTimeout(function() { - document.location.href += ''; - }, 10); + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; }, /** * highlight the search words provided in the url in the text */ - highlightSearchWords : function() { - var params = $.getQueryParameters(); - var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; - if (terms.length) { - var body = $('div.body'); - if (!body.length) { - body = $('body'); - } - window.setTimeout(function() { - $.each(terms, function() { - body.highlightText(this.toLowerCase(), 'highlighted'); - }); - }, 10); - $('

' + _('Hide Search Matches') + '

') - .appendTo($('#searchbox')); - } - }, + highlightSearchWords: () => { + const highlight = + new URLSearchParams(window.location.search).get("highlight") || ""; + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do - /** - * init the domain index toggle buttons - */ - initIndexTable : function() { - var togglers = $('img.toggler').click(function() { - var src = $(this).attr('src'); - var idnum = $(this).attr('id').substr(7); - $('tr.cg-' + idnum).toggle(); - if (src.substr(-9) === 'minus.png') - $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); - else - $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); - }).css('display', ''); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { - togglers.click(); - } + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '

' + + '' + + Documentation.gettext("Hide Search Matches") + + "

" + ) + ); }, /** * helper function to hide the search marks again */ - hideSearchWords : function() { - $('#searchbox .highlight-link').fadeOut(300); - $('span.highlighted').removeClass('highlighted'); - var url = new URL(window.location); - url.searchParams.delete('highlight'); - window.history.replaceState({}, '', url); + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + const url = new URL(window.location); + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); }, - /** + /** * helper function to focus on search bar */ - focusSearchBar : function() { - $('input[name=q]').first().focus(); + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); }, /** - * make the url absolute + * Initialise the domain index toggle buttons */ - makeURL : function(relativeURL) { - return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; - }, + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; - /** - * get the current relative url - */ - getCurrentURL : function() { - var path = document.location.pathname; - var parts = path.split(/\//); - $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { - if (this === '..') - parts.pop(); - }); - var url = parts.join('/'); - return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); }, - initOnKeyListeners: function() { + initOnKeyListeners: () => { // only install a listener if it is really needed - if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && - !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) - return; + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; - $(document).keydown(function(event) { - var activeElementType = document.activeElement.tagName; - // don't navigate when in search box, textarea, dropdown or button - if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' - && activeElementType !== 'BUTTON') { - if (event.altKey || event.ctrlKey || event.metaKey) - return; + const blacklistedElements = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", + ]); + document.addEventListener("keydown", (event) => { + if (blacklistedElements.has(document.activeElement.tagName)) return; // bail for input elements + if (event.altKey || event.ctrlKey || event.metaKey) return; // bail with special keys - if (!event.shiftKey) { - switch (event.key) { - case 'ArrowLeft': - if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) - break; - var prevHref = $('link[rel="prev"]').prop('href'); - if (prevHref) { - window.location.href = prevHref; - return false; - } - break; - case 'ArrowRight': - if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) - break; - var nextHref = $('link[rel="next"]').prop('href'); - if (nextHref) { - window.location.href = nextHref; - return false; - } - break; - case 'Escape': - if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) - break; - Documentation.hideSearchWords(); - return false; - } - } - - // some keyboard layouts may need Shift to get / + if (!event.shiftKey) { switch (event.key) { - case '/': - if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) - break; - Documentation.focusSearchBar(); - return false; + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); + } + break; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); + } + break; + case "Escape": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.hideSearchWords(); + event.preventDefault(); } } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } }); - } + }, }; // quick alias for translations -_ = Documentation.gettext; +const _ = Documentation.gettext; -$(document).ready(function() { - Documentation.init(); -}); +_ready(Documentation.init); diff --git a/guide/_static/documentation_options.js b/guide/_static/documentation_options.js index 724e382..a750e4d 100644 --- a/guide/_static/documentation_options.js +++ b/guide/_static/documentation_options.js @@ -1,7 +1,7 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), VERSION: '', - LANGUAGE: 'None', + LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', FILE_SUFFIX: '.html', @@ -10,5 +10,5 @@ var DOCUMENTATION_OPTIONS = { SOURCELINK_SUFFIX: '.txt', NAVIGATION_WITH_KEYS: false, SHOW_SEARCH_SUMMARY: true, - ENABLE_SEARCH_SHORTCUTS: true, + ENABLE_SEARCH_SHORTCUTS: false, }; \ No newline at end of file diff --git a/guide/_static/jquery.js b/guide/_static/jquery.js index b061403..c4c6022 100644 --- a/guide/_static/jquery.js +++ b/guide/_static/jquery.js @@ -1,2 +1,2 @@ -/*! jQuery v3.5.1 | (c) JS Foundation and other contributors | jquery.org/license */ -!function(e,t){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=e.document?t(e,!0):function(e){if(!e.document)throw new Error("jQuery requires a window with a document");return t(e)}:t(e)}("undefined"!=typeof window?window:this,function(C,e){"use strict";var t=[],r=Object.getPrototypeOf,s=t.slice,g=t.flat?function(e){return t.flat.call(e)}:function(e){return t.concat.apply([],e)},u=t.push,i=t.indexOf,n={},o=n.toString,v=n.hasOwnProperty,a=v.toString,l=a.call(Object),y={},m=function(e){return"function"==typeof e&&"number"!=typeof e.nodeType},x=function(e){return null!=e&&e===e.window},E=C.document,c={type:!0,src:!0,nonce:!0,noModule:!0};function b(e,t,n){var r,i,o=(n=n||E).createElement("script");if(o.text=e,t)for(r in c)(i=t[r]||t.getAttribute&&t.getAttribute(r))&&o.setAttribute(r,i);n.head.appendChild(o).parentNode.removeChild(o)}function w(e){return null==e?e+"":"object"==typeof e||"function"==typeof e?n[o.call(e)]||"object":typeof e}var f="3.5.1",S=function(e,t){return new S.fn.init(e,t)};function p(e){var t=!!e&&"length"in e&&e.length,n=w(e);return!m(e)&&!x(e)&&("array"===n||0===t||"number"==typeof t&&0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e.namespaceURI,n=(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},D=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function D(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||j,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,j=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function qe(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function Le(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function He(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Oe(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var Ut,Xt=[],Vt=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=Xt.pop()||S.expando+"_"+Ct.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Vt.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Vt.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Vt,"$1"+r):!1!==e.jsonp&&(e.url+=(Et.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,Xt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((Ut=E.implementation.createHTMLDocument("").body).innerHTML="
",2===Ut.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):("number"==typeof f.top&&(f.top+="px"),"number"==typeof f.left&&(f.left+="px"),c.css(f))}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=$e(y.pixelPosition,function(e,t){if(t)return t=Be(e,n),Me.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0+~]|"+M+")"+M+"*"),U=new RegExp(M+"|>"),X=new RegExp(F),V=new RegExp("^"+I+"$"),G={ID:new RegExp("^#("+I+")"),CLASS:new RegExp("^\\.("+I+")"),TAG:new RegExp("^("+I+"|[*])"),ATTR:new RegExp("^"+W),PSEUDO:new RegExp("^"+F),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+R+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/HTML$/i,Q=/^(?:input|select|textarea|button)$/i,J=/^h\d$/i,K=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ee=/[+~]/,te=new RegExp("\\\\[\\da-fA-F]{1,6}"+M+"?|\\\\([^\\r\\n\\f])","g"),ne=function(e,t){var n="0x"+e.slice(1)-65536;return t||(n<0?String.fromCharCode(n+65536):String.fromCharCode(n>>10|55296,1023&n|56320))},re=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,ie=function(e,t){return t?"\0"===e?"\ufffd":e.slice(0,-1)+"\\"+e.charCodeAt(e.length-1).toString(16)+" ":"\\"+e},oe=function(){T()},ae=be(function(e){return!0===e.disabled&&"fieldset"===e.nodeName.toLowerCase()},{dir:"parentNode",next:"legend"});try{H.apply(t=O.call(p.childNodes),p.childNodes),t[p.childNodes.length].nodeType}catch(e){H={apply:t.length?function(e,t){L.apply(e,O.call(t))}:function(e,t){var n=e.length,r=0;while(e[n++]=t[r++]);e.length=n-1}}}function se(t,e,n,r){var i,o,a,s,u,l,c,f=e&&e.ownerDocument,p=e?e.nodeType:9;if(n=n||[],"string"!=typeof t||!t||1!==p&&9!==p&&11!==p)return n;if(!r&&(T(e),e=e||C,E)){if(11!==p&&(u=Z.exec(t)))if(i=u[1]){if(9===p){if(!(a=e.getElementById(i)))return n;if(a.id===i)return n.push(a),n}else if(f&&(a=f.getElementById(i))&&y(e,a)&&a.id===i)return n.push(a),n}else{if(u[2])return H.apply(n,e.getElementsByTagName(t)),n;if((i=u[3])&&d.getElementsByClassName&&e.getElementsByClassName)return H.apply(n,e.getElementsByClassName(i)),n}if(d.qsa&&!N[t+" "]&&(!v||!v.test(t))&&(1!==p||"object"!==e.nodeName.toLowerCase())){if(c=t,f=e,1===p&&(U.test(t)||z.test(t))){(f=ee.test(t)&&ye(e.parentNode)||e)===e&&d.scope||((s=e.getAttribute("id"))?s=s.replace(re,ie):e.setAttribute("id",s=S)),o=(l=h(t)).length;while(o--)l[o]=(s?"#"+s:":scope")+" "+xe(l[o]);c=l.join(",")}try{return H.apply(n,f.querySelectorAll(c)),n}catch(e){N(t,!0)}finally{s===S&&e.removeAttribute("id")}}}return g(t.replace($,"$1"),e,n,r)}function ue(){var r=[];return function e(t,n){return r.push(t+" ")>b.cacheLength&&delete e[r.shift()],e[t+" "]=n}}function le(e){return e[S]=!0,e}function ce(e){var t=C.createElement("fieldset");try{return!!e(t)}catch(e){return!1}finally{t.parentNode&&t.parentNode.removeChild(t),t=null}}function fe(e,t){var n=e.split("|"),r=n.length;while(r--)b.attrHandle[n[r]]=t}function pe(e,t){var n=t&&e,r=n&&1===e.nodeType&&1===t.nodeType&&e.sourceIndex-t.sourceIndex;if(r)return r;if(n)while(n=n.nextSibling)if(n===t)return-1;return e?1:-1}function de(t){return function(e){return"input"===e.nodeName.toLowerCase()&&e.type===t}}function he(n){return function(e){var t=e.nodeName.toLowerCase();return("input"===t||"button"===t)&&e.type===n}}function ge(t){return function(e){return"form"in e?e.parentNode&&!1===e.disabled?"label"in e?"label"in e.parentNode?e.parentNode.disabled===t:e.disabled===t:e.isDisabled===t||e.isDisabled!==!t&&ae(e)===t:e.disabled===t:"label"in e&&e.disabled===t}}function ve(a){return le(function(o){return o=+o,le(function(e,t){var n,r=a([],e.length,o),i=r.length;while(i--)e[n=r[i]]&&(e[n]=!(t[n]=e[n]))})})}function ye(e){return e&&"undefined"!=typeof e.getElementsByTagName&&e}for(e in d=se.support={},i=se.isXML=function(e){var t=e&&e.namespaceURI,n=e&&(e.ownerDocument||e).documentElement;return!Y.test(t||n&&n.nodeName||"HTML")},T=se.setDocument=function(e){var t,n,r=e?e.ownerDocument||e:p;return r!=C&&9===r.nodeType&&r.documentElement&&(a=(C=r).documentElement,E=!i(C),p!=C&&(n=C.defaultView)&&n.top!==n&&(n.addEventListener?n.addEventListener("unload",oe,!1):n.attachEvent&&n.attachEvent("onunload",oe)),d.scope=ce(function(e){return a.appendChild(e).appendChild(C.createElement("div")),"undefined"!=typeof e.querySelectorAll&&!e.querySelectorAll(":scope fieldset div").length}),d.attributes=ce(function(e){return e.className="i",!e.getAttribute("className")}),d.getElementsByTagName=ce(function(e){return e.appendChild(C.createComment("")),!e.getElementsByTagName("*").length}),d.getElementsByClassName=K.test(C.getElementsByClassName),d.getById=ce(function(e){return a.appendChild(e).id=S,!C.getElementsByName||!C.getElementsByName(S).length}),d.getById?(b.filter.ID=function(e){var t=e.replace(te,ne);return function(e){return e.getAttribute("id")===t}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n=t.getElementById(e);return n?[n]:[]}}):(b.filter.ID=function(e){var n=e.replace(te,ne);return function(e){var t="undefined"!=typeof e.getAttributeNode&&e.getAttributeNode("id");return t&&t.value===n}},b.find.ID=function(e,t){if("undefined"!=typeof t.getElementById&&E){var n,r,i,o=t.getElementById(e);if(o){if((n=o.getAttributeNode("id"))&&n.value===e)return[o];i=t.getElementsByName(e),r=0;while(o=i[r++])if((n=o.getAttributeNode("id"))&&n.value===e)return[o]}return[]}}),b.find.TAG=d.getElementsByTagName?function(e,t){return"undefined"!=typeof t.getElementsByTagName?t.getElementsByTagName(e):d.qsa?t.querySelectorAll(e):void 0}:function(e,t){var n,r=[],i=0,o=t.getElementsByTagName(e);if("*"===e){while(n=o[i++])1===n.nodeType&&r.push(n);return r}return o},b.find.CLASS=d.getElementsByClassName&&function(e,t){if("undefined"!=typeof t.getElementsByClassName&&E)return t.getElementsByClassName(e)},s=[],v=[],(d.qsa=K.test(C.querySelectorAll))&&(ce(function(e){var t;a.appendChild(e).innerHTML="",e.querySelectorAll("[msallowcapture^='']").length&&v.push("[*^$]="+M+"*(?:''|\"\")"),e.querySelectorAll("[selected]").length||v.push("\\["+M+"*(?:value|"+R+")"),e.querySelectorAll("[id~="+S+"-]").length||v.push("~="),(t=C.createElement("input")).setAttribute("name",""),e.appendChild(t),e.querySelectorAll("[name='']").length||v.push("\\["+M+"*name"+M+"*="+M+"*(?:''|\"\")"),e.querySelectorAll(":checked").length||v.push(":checked"),e.querySelectorAll("a#"+S+"+*").length||v.push(".#.+[+~]"),e.querySelectorAll("\\\f"),v.push("[\\r\\n\\f]")}),ce(function(e){e.innerHTML="";var t=C.createElement("input");t.setAttribute("type","hidden"),e.appendChild(t).setAttribute("name","D"),e.querySelectorAll("[name=d]").length&&v.push("name"+M+"*[*^$|!~]?="),2!==e.querySelectorAll(":enabled").length&&v.push(":enabled",":disabled"),a.appendChild(e).disabled=!0,2!==e.querySelectorAll(":disabled").length&&v.push(":enabled",":disabled"),e.querySelectorAll("*,:x"),v.push(",.*:")})),(d.matchesSelector=K.test(c=a.matches||a.webkitMatchesSelector||a.mozMatchesSelector||a.oMatchesSelector||a.msMatchesSelector))&&ce(function(e){d.disconnectedMatch=c.call(e,"*"),c.call(e,"[s!='']:x"),s.push("!=",F)}),v=v.length&&new RegExp(v.join("|")),s=s.length&&new RegExp(s.join("|")),t=K.test(a.compareDocumentPosition),y=t||K.test(a.contains)?function(e,t){var n=9===e.nodeType?e.documentElement:e,r=t&&t.parentNode;return e===r||!(!r||1!==r.nodeType||!(n.contains?n.contains(r):e.compareDocumentPosition&&16&e.compareDocumentPosition(r)))}:function(e,t){if(t)while(t=t.parentNode)if(t===e)return!0;return!1},j=t?function(e,t){if(e===t)return l=!0,0;var n=!e.compareDocumentPosition-!t.compareDocumentPosition;return n||(1&(n=(e.ownerDocument||e)==(t.ownerDocument||t)?e.compareDocumentPosition(t):1)||!d.sortDetached&&t.compareDocumentPosition(e)===n?e==C||e.ownerDocument==p&&y(p,e)?-1:t==C||t.ownerDocument==p&&y(p,t)?1:u?P(u,e)-P(u,t):0:4&n?-1:1)}:function(e,t){if(e===t)return l=!0,0;var n,r=0,i=e.parentNode,o=t.parentNode,a=[e],s=[t];if(!i||!o)return e==C?-1:t==C?1:i?-1:o?1:u?P(u,e)-P(u,t):0;if(i===o)return pe(e,t);n=e;while(n=n.parentNode)a.unshift(n);n=t;while(n=n.parentNode)s.unshift(n);while(a[r]===s[r])r++;return r?pe(a[r],s[r]):a[r]==p?-1:s[r]==p?1:0}),C},se.matches=function(e,t){return se(e,null,null,t)},se.matchesSelector=function(e,t){if(T(e),d.matchesSelector&&E&&!N[t+" "]&&(!s||!s.test(t))&&(!v||!v.test(t)))try{var n=c.call(e,t);if(n||d.disconnectedMatch||e.document&&11!==e.document.nodeType)return n}catch(e){N(t,!0)}return 0":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(e){return e[1]=e[1].replace(te,ne),e[3]=(e[3]||e[4]||e[5]||"").replace(te,ne),"~="===e[2]&&(e[3]=" "+e[3]+" "),e.slice(0,4)},CHILD:function(e){return e[1]=e[1].toLowerCase(),"nth"===e[1].slice(0,3)?(e[3]||se.error(e[0]),e[4]=+(e[4]?e[5]+(e[6]||1):2*("even"===e[3]||"odd"===e[3])),e[5]=+(e[7]+e[8]||"odd"===e[3])):e[3]&&se.error(e[0]),e},PSEUDO:function(e){var t,n=!e[6]&&e[2];return G.CHILD.test(e[0])?null:(e[3]?e[2]=e[4]||e[5]||"":n&&X.test(n)&&(t=h(n,!0))&&(t=n.indexOf(")",n.length-t)-n.length)&&(e[0]=e[0].slice(0,t),e[2]=n.slice(0,t)),e.slice(0,3))}},filter:{TAG:function(e){var t=e.replace(te,ne).toLowerCase();return"*"===e?function(){return!0}:function(e){return e.nodeName&&e.nodeName.toLowerCase()===t}},CLASS:function(e){var t=m[e+" "];return t||(t=new RegExp("(^|"+M+")"+e+"("+M+"|$)"))&&m(e,function(e){return t.test("string"==typeof e.className&&e.className||"undefined"!=typeof e.getAttribute&&e.getAttribute("class")||"")})},ATTR:function(n,r,i){return function(e){var t=se.attr(e,n);return null==t?"!="===r:!r||(t+="","="===r?t===i:"!="===r?t!==i:"^="===r?i&&0===t.indexOf(i):"*="===r?i&&-1:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i;function j(e,n,r){return m(n)?S.grep(e,function(e,t){return!!n.call(e,t,e)!==r}):n.nodeType?S.grep(e,function(e){return e===n!==r}):"string"!=typeof n?S.grep(e,function(e){return-1)[^>]*|#([\w-]+))$/;(S.fn.init=function(e,t,n){var r,i;if(!e)return this;if(n=n||D,"string"==typeof e){if(!(r="<"===e[0]&&">"===e[e.length-1]&&3<=e.length?[null,e,null]:q.exec(e))||!r[1]&&t)return!t||t.jquery?(t||n).find(e):this.constructor(t).find(e);if(r[1]){if(t=t instanceof S?t[0]:t,S.merge(this,S.parseHTML(r[1],t&&t.nodeType?t.ownerDocument||t:E,!0)),N.test(r[1])&&S.isPlainObject(t))for(r in t)m(this[r])?this[r](t[r]):this.attr(r,t[r]);return this}return(i=E.getElementById(r[2]))&&(this[0]=i,this.length=1),this}return e.nodeType?(this[0]=e,this.length=1,this):m(e)?void 0!==n.ready?n.ready(e):e(S):S.makeArray(e,this)}).prototype=S.fn,D=S(E);var L=/^(?:parents|prev(?:Until|All))/,H={children:!0,contents:!0,next:!0,prev:!0};function O(e,t){while((e=e[t])&&1!==e.nodeType);return e}S.fn.extend({has:function(e){var t=S(e,this),n=t.length;return this.filter(function(){for(var e=0;e\x20\t\r\n\f]*)/i,he=/^$|^module$|\/(?:java|ecma)script/i;ce=E.createDocumentFragment().appendChild(E.createElement("div")),(fe=E.createElement("input")).setAttribute("type","radio"),fe.setAttribute("checked","checked"),fe.setAttribute("name","t"),ce.appendChild(fe),y.checkClone=ce.cloneNode(!0).cloneNode(!0).lastChild.checked,ce.innerHTML="",y.noCloneChecked=!!ce.cloneNode(!0).lastChild.defaultValue,ce.innerHTML="",y.option=!!ce.lastChild;var ge={thead:[1,"","
"],col:[2,"","
"],tr:[2,"","
"],td:[3,"","
"],_default:[0,"",""]};function ve(e,t){var n;return n="undefined"!=typeof e.getElementsByTagName?e.getElementsByTagName(t||"*"):"undefined"!=typeof e.querySelectorAll?e.querySelectorAll(t||"*"):[],void 0===t||t&&A(e,t)?S.merge([e],n):n}function ye(e,t){for(var n=0,r=e.length;n",""]);var me=/<|&#?\w+;/;function xe(e,t,n,r,i){for(var o,a,s,u,l,c,f=t.createDocumentFragment(),p=[],d=0,h=e.length;d\s*$/g;function je(e,t){return A(e,"table")&&A(11!==t.nodeType?t:t.firstChild,"tr")&&S(e).children("tbody")[0]||e}function De(e){return e.type=(null!==e.getAttribute("type"))+"/"+e.type,e}function qe(e){return"true/"===(e.type||"").slice(0,5)?e.type=e.type.slice(5):e.removeAttribute("type"),e}function Le(e,t){var n,r,i,o,a,s;if(1===t.nodeType){if(Y.hasData(e)&&(s=Y.get(e).events))for(i in Y.remove(t,"handle events"),s)for(n=0,r=s[i].length;n").attr(n.scriptAttrs||{}).prop({charset:n.scriptCharset,src:n.url}).on("load error",i=function(e){r.remove(),i=null,e&&t("error"===e.type?404:200,e.type)}),E.head.appendChild(r[0])},abort:function(){i&&i()}}});var _t,zt=[],Ut=/(=)\?(?=&|$)|\?\?/;S.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var e=zt.pop()||S.expando+"_"+wt.guid++;return this[e]=!0,e}}),S.ajaxPrefilter("json jsonp",function(e,t,n){var r,i,o,a=!1!==e.jsonp&&(Ut.test(e.url)?"url":"string"==typeof e.data&&0===(e.contentType||"").indexOf("application/x-www-form-urlencoded")&&Ut.test(e.data)&&"data");if(a||"jsonp"===e.dataTypes[0])return r=e.jsonpCallback=m(e.jsonpCallback)?e.jsonpCallback():e.jsonpCallback,a?e[a]=e[a].replace(Ut,"$1"+r):!1!==e.jsonp&&(e.url+=(Tt.test(e.url)?"&":"?")+e.jsonp+"="+r),e.converters["script json"]=function(){return o||S.error(r+" was not called"),o[0]},e.dataTypes[0]="json",i=C[r],C[r]=function(){o=arguments},n.always(function(){void 0===i?S(C).removeProp(r):C[r]=i,e[r]&&(e.jsonpCallback=t.jsonpCallback,zt.push(r)),o&&m(i)&&i(o[0]),o=i=void 0}),"script"}),y.createHTMLDocument=((_t=E.implementation.createHTMLDocument("").body).innerHTML="
",2===_t.childNodes.length),S.parseHTML=function(e,t,n){return"string"!=typeof e?[]:("boolean"==typeof t&&(n=t,t=!1),t||(y.createHTMLDocument?((r=(t=E.implementation.createHTMLDocument("")).createElement("base")).href=E.location.href,t.head.appendChild(r)):t=E),o=!n&&[],(i=N.exec(e))?[t.createElement(i[1])]:(i=xe([e],t,o),o&&o.length&&S(o).remove(),S.merge([],i.childNodes)));var r,i,o},S.fn.load=function(e,t,n){var r,i,o,a=this,s=e.indexOf(" ");return-1").append(S.parseHTML(e)).find(r):e)}).always(n&&function(e,t){a.each(function(){n.apply(this,o||[e.responseText,t,e])})}),this},S.expr.pseudos.animated=function(t){return S.grep(S.timers,function(e){return t===e.elem}).length},S.offset={setOffset:function(e,t,n){var r,i,o,a,s,u,l=S.css(e,"position"),c=S(e),f={};"static"===l&&(e.style.position="relative"),s=c.offset(),o=S.css(e,"top"),u=S.css(e,"left"),("absolute"===l||"fixed"===l)&&-1<(o+u).indexOf("auto")?(a=(r=c.position()).top,i=r.left):(a=parseFloat(o)||0,i=parseFloat(u)||0),m(t)&&(t=t.call(e,n,S.extend({},s))),null!=t.top&&(f.top=t.top-s.top+a),null!=t.left&&(f.left=t.left-s.left+i),"using"in t?t.using.call(e,f):c.css(f)}},S.fn.extend({offset:function(t){if(arguments.length)return void 0===t?this:this.each(function(e){S.offset.setOffset(this,t,e)});var e,n,r=this[0];return r?r.getClientRects().length?(e=r.getBoundingClientRect(),n=r.ownerDocument.defaultView,{top:e.top+n.pageYOffset,left:e.left+n.pageXOffset}):{top:0,left:0}:void 0},position:function(){if(this[0]){var e,t,n,r=this[0],i={top:0,left:0};if("fixed"===S.css(r,"position"))t=r.getBoundingClientRect();else{t=this.offset(),n=r.ownerDocument,e=r.offsetParent||n.documentElement;while(e&&(e===n.body||e===n.documentElement)&&"static"===S.css(e,"position"))e=e.parentNode;e&&e!==r&&1===e.nodeType&&((i=S(e).offset()).top+=S.css(e,"borderTopWidth",!0),i.left+=S.css(e,"borderLeftWidth",!0))}return{top:t.top-i.top-S.css(r,"marginTop",!0),left:t.left-i.left-S.css(r,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var e=this.offsetParent;while(e&&"static"===S.css(e,"position"))e=e.offsetParent;return e||re})}}),S.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(t,i){var o="pageYOffset"===i;S.fn[t]=function(e){return $(this,function(e,t,n){var r;if(x(e)?r=e:9===e.nodeType&&(r=e.defaultView),void 0===n)return r?r[i]:e[t];r?r.scrollTo(o?r.pageXOffset:n,o?n:r.pageYOffset):e[t]=n},t,e,arguments.length)}}),S.each(["top","left"],function(e,n){S.cssHooks[n]=Fe(y.pixelPosition,function(e,t){if(t)return t=We(e,n),Pe.test(t)?S(e).position()[n]+"px":t})}),S.each({Height:"height",Width:"width"},function(a,s){S.each({padding:"inner"+a,content:s,"":"outer"+a},function(r,o){S.fn[o]=function(e,t){var n=arguments.length&&(r||"boolean"!=typeof e),i=r||(!0===e||!0===t?"margin":"border");return $(this,function(e,t,n){var r;return x(e)?0===o.indexOf("outer")?e["inner"+a]:e.document.documentElement["client"+a]:9===e.nodeType?(r=e.documentElement,Math.max(e.body["scroll"+a],r["scroll"+a],e.body["offset"+a],r["offset"+a],r["client"+a])):void 0===n?S.css(e,t,i):S.style(e,t,n,i)},s,n?e:void 0,n)}})}),S.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(e,t){S.fn[t]=function(e){return this.on(t,e)}}),S.fn.extend({bind:function(e,t,n){return this.on(e,null,t,n)},unbind:function(e,t){return this.off(e,null,t)},delegate:function(e,t,n,r){return this.on(t,e,n,r)},undelegate:function(e,t,n){return 1===arguments.length?this.off(e,"**"):this.off(t,e||"**",n)},hover:function(e,t){return this.mouseenter(e).mouseleave(t||e)}}),S.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(e,n){S.fn[n]=function(e,t){return 0 { + const [docname, title, anchor, descr, score, filename] = result + return score }, */ @@ -28,9 +30,11 @@ if (!Scorer) { // or matches in the last dotted part of the object name objPartialMatch: 6, // Additive scores depending on the priority of the object - objPrio: {0: 15, // used to be importantResults - 1: 5, // used to be objectResults - 2: -5}, // used to be unimportantResults + objPrio: { + 0: 15, // used to be importantResults + 1: 5, // used to be objectResults + 2: -5, // used to be unimportantResults + }, // Used when the priority is not in the mapping. objPrioDefault: 0, @@ -39,452 +43,455 @@ if (!Scorer) { partialTitle: 7, // query found in terms term: 5, - partialTerm: 2 + partialTerm: 2, }; } -if (!splitQuery) { - function splitQuery(query) { - return query.split(/\s+/); +const _removeChildren = (element) => { + while (element && element.lastChild) element.removeChild(element.lastChild); +}; + +/** + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping + */ +const _escapeRegExp = (string) => + string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string + +const _displayItem = (item, highlightTerms, searchTerms) => { + const docBuilder = DOCUMENTATION_OPTIONS.BUILDER; + const docUrlRoot = DOCUMENTATION_OPTIONS.URL_ROOT; + const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX; + const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX; + const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY; + + const [docName, title, anchor, descr] = item; + + let listItem = document.createElement("li"); + let requestUrl; + let linkUrl; + if (docBuilder === "dirhtml") { + // dirhtml builder + let dirname = docName + "/"; + if (dirname.match(/\/index\/$/)) + dirname = dirname.substring(0, dirname.length - 6); + else if (dirname === "index/") dirname = ""; + requestUrl = docUrlRoot + dirname; + linkUrl = requestUrl; + } else { + // normal html builders + requestUrl = docUrlRoot + docName + docFileSuffix; + linkUrl = docName + docLinkSuffix; + } + const params = new URLSearchParams(); + params.set("highlight", [...highlightTerms].join(" ")); + let linkEl = listItem.appendChild(document.createElement("a")); + linkEl.href = linkUrl + "?" + params.toString() + anchor; + linkEl.innerHTML = title; + if (descr) + listItem.appendChild(document.createElement("span")).innerText = + " (" + descr + ")"; + else if (showSearchSummary) + fetch(requestUrl) + .then((responseData) => responseData.text()) + .then((data) => { + if (data) + listItem.appendChild( + Search.makeSearchSummary(data, searchTerms, highlightTerms) + ); + }); + Search.output.appendChild(listItem); +}; +const _finishSearch = (resultCount) => { + Search.stopPulse(); + Search.title.innerText = _("Search Results"); + if (!resultCount) + Search.status.innerText = Documentation.gettext( + "Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories." + ); + else + Search.status.innerText = _( + `Search finished, found ${resultCount} page(s) matching the search query.` + ); +}; +const _displayNextItem = ( + results, + resultCount, + highlightTerms, + searchTerms +) => { + // results left, load the summary and display it + // this is intended to be dynamic (don't sub resultsCount) + if (results.length) { + _displayItem(results.pop(), highlightTerms, searchTerms); + setTimeout( + () => _displayNextItem(results, resultCount, highlightTerms, searchTerms), + 5 + ); } + // search finished, update title and status message + else _finishSearch(resultCount); +}; + +/** + * Default splitQuery function. Can be overridden in ``sphinx.search`` with a + * custom function per language. + * + * The regular expression works by splitting the string on consecutive characters + * that are not Unicode letters, numbers, underscores, or emoji characters. + * This is the same as ``\W+`` in Python, preserving the surrogate pair area. + */ +if (typeof splitQuery === "undefined") { + var splitQuery = (query) => query + .split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu) + .filter(term => term) // remove remaining empty strings } /** * Search Module */ -var Search = { - - _index : null, - _queued_query : null, - _pulse_status : -1, - - htmlToText : function(htmlString) { - var virtualDocument = document.implementation.createHTMLDocument('virtual'); - var htmlElement = $(htmlString, virtualDocument); - htmlElement.find('.headerlink').remove(); - docContent = htmlElement.find('[role=main]')[0]; - if(docContent === undefined) { - console.warn("Content block not found. Sphinx search tries to obtain it " + - "via '[role=main]'. Could you check your theme or template."); - return ""; - } - return docContent.textContent || docContent.innerText; +const Search = { + _index: null, + _queued_query: null, + _pulse_status: -1, + + htmlToText: (htmlString) => { + const htmlElement = document + .createRange() + .createContextualFragment(htmlString); + _removeChildren(htmlElement.querySelectorAll(".headerlink")); + const docContent = htmlElement.querySelector('[role="main"]'); + if (docContent !== undefined) return docContent.textContent; + console.warn( + "Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template." + ); + return ""; }, - init : function() { - var params = $.getQueryParameters(); - if (params.q) { - var query = params.q[0]; - $('input[name="q"]')[0].value = query; - this.performSearch(query); - } + init: () => { + const query = new URLSearchParams(window.location.search).get("q"); + document + .querySelectorAll('input[name="q"]') + .forEach((el) => (el.value = query)); + if (query) Search.performSearch(query); }, - loadIndex : function(url) { - $.ajax({type: "GET", url: url, data: null, - dataType: "script", cache: true, - complete: function(jqxhr, textstatus) { - if (textstatus != "success") { - document.getElementById("searchindexloader").src = url; - } - }}); - }, + loadIndex: (url) => + (document.body.appendChild(document.createElement("script")).src = url), - setIndex : function(index) { - var q; - this._index = index; - if ((q = this._queued_query) !== null) { - this._queued_query = null; - Search.query(q); + setIndex: (index) => { + Search._index = index; + if (Search._queued_query !== null) { + const query = Search._queued_query; + Search._queued_query = null; + Search.query(query); } }, - hasIndex : function() { - return this._index !== null; - }, + hasIndex: () => Search._index !== null, - deferQuery : function(query) { - this._queued_query = query; - }, + deferQuery: (query) => (Search._queued_query = query), - stopPulse : function() { - this._pulse_status = 0; - }, + stopPulse: () => (Search._pulse_status = -1), - startPulse : function() { - if (this._pulse_status >= 0) - return; - function pulse() { - var i; + startPulse: () => { + if (Search._pulse_status >= 0) return; + + const pulse = () => { Search._pulse_status = (Search._pulse_status + 1) % 4; - var dotString = ''; - for (i = 0; i < Search._pulse_status; i++) - dotString += '.'; - Search.dots.text(dotString); - if (Search._pulse_status > -1) - window.setTimeout(pulse, 500); - } + Search.dots.innerText = ".".repeat(Search._pulse_status); + if (Search._pulse_status >= 0) window.setTimeout(pulse, 500); + }; pulse(); }, /** * perform a search for something (or wait until index is loaded) */ - performSearch : function(query) { + performSearch: (query) => { // create the required interface elements - this.out = $('#search-results'); - this.title = $('

' + _('Searching') + '

').appendTo(this.out); - this.dots = $('').appendTo(this.title); - this.status = $('

 

').appendTo(this.out); - this.output = $('
    ').appendTo(this.out); - - $('#search-progress').text(_('Preparing search...')); - this.startPulse(); + const searchText = document.createElement("h2"); + searchText.textContent = _("Searching"); + const searchSummary = document.createElement("p"); + searchSummary.classList.add("search-summary"); + searchSummary.innerText = ""; + const searchList = document.createElement("ul"); + searchList.classList.add("search"); + + const out = document.getElementById("search-results"); + Search.title = out.appendChild(searchText); + Search.dots = Search.title.appendChild(document.createElement("span")); + Search.status = out.appendChild(searchSummary); + Search.output = out.appendChild(searchList); + + const searchProgress = document.getElementById("search-progress"); + // Some themes don't use the search progress node + if (searchProgress) { + searchProgress.innerText = _("Preparing search..."); + } + Search.startPulse(); // index already loaded, the browser was quick! - if (this.hasIndex()) - this.query(query); - else - this.deferQuery(query); + if (Search.hasIndex()) Search.query(query); + else Search.deferQuery(query); }, /** * execute search (requires search index to be loaded) */ - query : function(query) { - var i; - - // stem the searchterms and add them to the correct list - var stemmer = new Stemmer(); - var searchterms = []; - var excluded = []; - var hlterms = []; - var tmp = splitQuery(query); - var objectterms = []; - for (i = 0; i < tmp.length; i++) { - if (tmp[i] !== "") { - objectterms.push(tmp[i].toLowerCase()); - } + query: (query) => { + // stem the search terms and add them to the correct list + const stemmer = new Stemmer(); + const searchTerms = new Set(); + const excludedTerms = new Set(); + const highlightTerms = new Set(); + const objectTerms = new Set(splitQuery(query.toLowerCase().trim())); + splitQuery(query.trim()).forEach((queryTerm) => { + const queryTermLower = queryTerm.toLowerCase(); + + // maybe skip this "word" + // stopwords array is from language_data.js + if ( + stopwords.indexOf(queryTermLower) !== -1 || + queryTerm.match(/^\d+$/) + ) + return; - if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i] === "") { - // skip this "word" - continue; - } // stem the word - var word = stemmer.stemWord(tmp[i].toLowerCase()); - var toAppend; + let word = stemmer.stemWord(queryTermLower); // select the correct list - if (word[0] == '-') { - toAppend = excluded; - word = word.substr(1); - } + if (word[0] === "-") excludedTerms.add(word.substr(1)); else { - toAppend = searchterms; - hlterms.push(tmp[i].toLowerCase()); + searchTerms.add(word); + highlightTerms.add(queryTermLower); } - // only add if not already in the list - if (!$u.contains(toAppend, word)) - toAppend.push(word); - } - var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" ")); - - // console.debug('SEARCH: searching for:'); - // console.info('required: ', searchterms); - // console.info('excluded: ', excluded); + }); - // prepare search - var terms = this._index.terms; - var titleterms = this._index.titleterms; + // console.debug("SEARCH: searching for:"); + // console.info("required: ", [...searchTerms]); + // console.info("excluded: ", [...excludedTerms]); - // array of [filename, title, anchor, descr, score] - var results = []; - $('#search-progress').empty(); + // array of [docname, title, anchor, descr, score, filename] + let results = []; + _removeChildren(document.getElementById("search-progress")); // lookup as object - for (i = 0; i < objectterms.length; i++) { - var others = [].concat(objectterms.slice(0, i), - objectterms.slice(i+1, objectterms.length)); - results = results.concat(this.performObjectSearch(objectterms[i], others)); - } + objectTerms.forEach((term) => + results.push(...Search.performObjectSearch(term, objectTerms)) + ); // lookup as search terms in fulltext - results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms)); + results.push(...Search.performTermsSearch(searchTerms, excludedTerms)); // let the scorer override scores with a custom scoring function - if (Scorer.score) { - for (i = 0; i < results.length; i++) - results[i][4] = Scorer.score(results[i]); - } + if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item))); // now sort the results by score (in opposite order of appearance, since the // display function below uses pop() to retrieve items) and then // alphabetically - results.sort(function(a, b) { - var left = a[4]; - var right = b[4]; - if (left > right) { - return 1; - } else if (left < right) { - return -1; - } else { + results.sort((a, b) => { + const leftScore = a[4]; + const rightScore = b[4]; + if (leftScore === rightScore) { // same score: sort alphabetically - left = a[1].toLowerCase(); - right = b[1].toLowerCase(); - return (left > right) ? -1 : ((left < right) ? 1 : 0); + const leftTitle = a[1].toLowerCase(); + const rightTitle = b[1].toLowerCase(); + if (leftTitle === rightTitle) return 0; + return leftTitle > rightTitle ? -1 : 1; // inverted is intentional } + return leftScore > rightScore ? 1 : -1; }); + // remove duplicate search results + // note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept + let seen = new Set(); + results = results.reverse().reduce((acc, result) => { + let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(','); + if (!seen.has(resultStr)) { + acc.push(result); + seen.add(resultStr); + } + return acc; + }, []); + + results = results.reverse(); + // for debugging //Search.lastresults = results.slice(); // a copy - //console.info('search results:', Search.lastresults); + // console.info("search results:", Search.lastresults); // print the results - var resultCount = results.length; - function displayNextItem() { - // results left, load the summary and display it - if (results.length) { - var item = results.pop(); - var listItem = $('
  • '); - var requestUrl = ""; - var linkUrl = ""; - if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') { - // dirhtml builder - var dirname = item[0] + '/'; - if (dirname.match(/\/index\/$/)) { - dirname = dirname.substring(0, dirname.length-6); - } else if (dirname == 'index/') { - dirname = ''; - } - requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname; - linkUrl = requestUrl; - - } else { - // normal html builders - requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX; - linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX; - } - listItem.append($('').attr('href', - linkUrl + - highlightstring + item[2]).html(item[1])); - if (item[3]) { - listItem.append($(' (' + item[3] + ')')); - Search.output.append(listItem); - setTimeout(function() { - displayNextItem(); - }, 5); - } else if (DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY) { - $.ajax({url: requestUrl, - dataType: "text", - complete: function(jqxhr, textstatus) { - var data = jqxhr.responseText; - if (data !== '' && data !== undefined) { - var summary = Search.makeSearchSummary(data, searchterms, hlterms); - if (summary) { - listItem.append(summary); - } - } - Search.output.append(listItem); - setTimeout(function() { - displayNextItem(); - }, 5); - }}); - } else { - // just display title - Search.output.append(listItem); - setTimeout(function() { - displayNextItem(); - }, 5); - } - } - // search finished, update title and status message - else { - Search.stopPulse(); - Search.title.text(_('Search Results')); - if (!resultCount) - Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.')); - else - Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount)); - Search.status.fadeIn(500); - } - } - displayNextItem(); + _displayNextItem(results, results.length, highlightTerms, searchTerms); }, /** * search for object names */ - performObjectSearch : function(object, otherterms) { - var filenames = this._index.filenames; - var docnames = this._index.docnames; - var objects = this._index.objects; - var objnames = this._index.objnames; - var titles = this._index.titles; - - var i; - var results = []; - - for (var prefix in objects) { - for (var iMatch = 0; iMatch != objects[prefix].length; ++iMatch) { - var match = objects[prefix][iMatch]; - var name = match[4]; - var fullname = (prefix ? prefix + '.' : '') + name; - var fullnameLower = fullname.toLowerCase() - if (fullnameLower.indexOf(object) > -1) { - var score = 0; - var parts = fullnameLower.split('.'); - // check for different match types: exact matches of full name or - // "last name" (i.e. last dotted part) - if (fullnameLower == object || parts[parts.length - 1] == object) { - score += Scorer.objNameMatch; - // matches in last name - } else if (parts[parts.length - 1].indexOf(object) > -1) { - score += Scorer.objPartialMatch; - } - var objname = objnames[match[1]][2]; - var title = titles[match[0]]; - // If more than one term searched for, we require other words to be - // found in the name/title/description - if (otherterms.length > 0) { - var haystack = (prefix + ' ' + name + ' ' + - objname + ' ' + title).toLowerCase(); - var allfound = true; - for (i = 0; i < otherterms.length; i++) { - if (haystack.indexOf(otherterms[i]) == -1) { - allfound = false; - break; - } - } - if (!allfound) { - continue; - } - } - var descr = objname + _(', in ') + title; - - var anchor = match[3]; - if (anchor === '') - anchor = fullname; - else if (anchor == '-') - anchor = objnames[match[1]][1] + '-' + fullname; - // add custom score for some objects according to scorer - if (Scorer.objPrio.hasOwnProperty(match[2])) { - score += Scorer.objPrio[match[2]]; - } else { - score += Scorer.objPrioDefault; - } - results.push([docnames[match[0]], fullname, '#'+anchor, descr, score, filenames[match[0]]]); - } + performObjectSearch: (object, objectTerms) => { + const filenames = Search._index.filenames; + const docNames = Search._index.docnames; + const objects = Search._index.objects; + const objNames = Search._index.objnames; + const titles = Search._index.titles; + + const results = []; + + const objectSearchCallback = (prefix, match) => { + const name = match[4] + const fullname = (prefix ? prefix + "." : "") + name; + const fullnameLower = fullname.toLowerCase(); + if (fullnameLower.indexOf(object) < 0) return; + + let score = 0; + const parts = fullnameLower.split("."); + + // check for different match types: exact matches of full name or + // "last name" (i.e. last dotted part) + if (fullnameLower === object || parts.slice(-1)[0] === object) + score += Scorer.objNameMatch; + else if (parts.slice(-1)[0].indexOf(object) > -1) + score += Scorer.objPartialMatch; // matches in last name + + const objName = objNames[match[1]][2]; + const title = titles[match[0]]; + + // If more than one term searched for, we require other words to be + // found in the name/title/description + const otherTerms = new Set(objectTerms); + otherTerms.delete(object); + if (otherTerms.size > 0) { + const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase(); + if ( + [...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0) + ) + return; } - } + let anchor = match[3]; + if (anchor === "") anchor = fullname; + else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname; + + const descr = objName + _(", in ") + title; + + // add custom score for some objects according to scorer + if (Scorer.objPrio.hasOwnProperty(match[2])) + score += Scorer.objPrio[match[2]]; + else score += Scorer.objPrioDefault; + + results.push([ + docNames[match[0]], + fullname, + "#" + anchor, + descr, + score, + filenames[match[0]], + ]); + }; + Object.keys(objects).forEach((prefix) => + objects[prefix].forEach((array) => + objectSearchCallback(prefix, array) + ) + ); return results; }, - /** - * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions - */ - escapeRegExp : function(string) { - return string.replace(/[.*+\-?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string - }, - /** * search for full-text terms in the index */ - performTermsSearch : function(searchterms, excluded, terms, titleterms) { - var docnames = this._index.docnames; - var filenames = this._index.filenames; - var titles = this._index.titles; + performTermsSearch: (searchTerms, excludedTerms) => { + // prepare search + const terms = Search._index.terms; + const titleTerms = Search._index.titleterms; + const docNames = Search._index.docnames; + const filenames = Search._index.filenames; + const titles = Search._index.titles; - var i, j, file; - var fileMap = {}; - var scoreMap = {}; - var results = []; + const scoreMap = new Map(); + const fileMap = new Map(); // perform the search on the required terms - for (i = 0; i < searchterms.length; i++) { - var word = searchterms[i]; - var files = []; - var _o = [ - {files: terms[word], score: Scorer.term}, - {files: titleterms[word], score: Scorer.title} + searchTerms.forEach((word) => { + const files = []; + const arr = [ + { files: terms[word], score: Scorer.term }, + { files: titleTerms[word], score: Scorer.title }, ]; // add support for partial matches if (word.length > 2) { - var word_regex = this.escapeRegExp(word); - for (var w in terms) { - if (w.match(word_regex) && !terms[word]) { - _o.push({files: terms[w], score: Scorer.partialTerm}) - } - } - for (var w in titleterms) { - if (w.match(word_regex) && !titleterms[word]) { - _o.push({files: titleterms[w], score: Scorer.partialTitle}) - } - } + const escapedWord = _escapeRegExp(word); + Object.keys(terms).forEach((term) => { + if (term.match(escapedWord) && !terms[word]) + arr.push({ files: terms[term], score: Scorer.partialTerm }); + }); + Object.keys(titleTerms).forEach((term) => { + if (term.match(escapedWord) && !titleTerms[word]) + arr.push({ files: titleTerms[word], score: Scorer.partialTitle }); + }); } // no match but word was a required one - if ($u.every(_o, function(o){return o.files === undefined;})) { - break; - } + if (arr.every((record) => record.files === undefined)) return; + // found search word in contents - $u.each(_o, function(o) { - var _files = o.files; - if (_files === undefined) - return - - if (_files.length === undefined) - _files = [_files]; - files = files.concat(_files); - - // set score for the word in each file to Scorer.term - for (j = 0; j < _files.length; j++) { - file = _files[j]; - if (!(file in scoreMap)) - scoreMap[file] = {}; - scoreMap[file][word] = o.score; - } + arr.forEach((record) => { + if (record.files === undefined) return; + + let recordFiles = record.files; + if (recordFiles.length === undefined) recordFiles = [recordFiles]; + files.push(...recordFiles); + + // set score for the word in each file + recordFiles.forEach((file) => { + if (!scoreMap.has(file)) scoreMap.set(file, {}); + scoreMap.get(file)[word] = record.score; + }); }); // create the mapping - for (j = 0; j < files.length; j++) { - file = files[j]; - if (file in fileMap && fileMap[file].indexOf(word) === -1) - fileMap[file].push(word); - else - fileMap[file] = [word]; - } - } + files.forEach((file) => { + if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1) + fileMap.get(file).push(word); + else fileMap.set(file, [word]); + }); + }); // now check if the files don't contain excluded terms - for (file in fileMap) { - var valid = true; - + const results = []; + for (const [file, wordList] of fileMap) { // check if all requirements are matched - var filteredTermCount = // as search terms with length < 3 are discarded: ignore - searchterms.filter(function(term){return term.length > 2}).length + + // as search terms with length < 3 are discarded + const filteredTermCount = [...searchTerms].filter( + (term) => term.length > 2 + ).length; if ( - fileMap[file].length != searchterms.length && - fileMap[file].length != filteredTermCount - ) continue; + wordList.length !== searchTerms.size && + wordList.length !== filteredTermCount + ) + continue; // ensure that none of the excluded terms is in the search result - for (i = 0; i < excluded.length; i++) { - if (terms[excluded[i]] == file || - titleterms[excluded[i]] == file || - $u.contains(terms[excluded[i]] || [], file) || - $u.contains(titleterms[excluded[i]] || [], file)) { - valid = false; - break; - } - } + if ( + [...excludedTerms].some( + (term) => + terms[term] === file || + titleTerms[term] === file || + (terms[term] || []).includes(file) || + (titleTerms[term] || []).includes(file) + ) + ) + break; - // if we have still a valid result we can add it to the result list - if (valid) { - // select one (max) score for the file. - // for better ranking, we should calculate ranking by using words statistics like basic tf-idf... - var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]})); - results.push([docnames[file], titles[file], '', null, score, filenames[file]]); - } + // select one (max) score for the file. + const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w])); + // add result to the result list + results.push([ + docNames[file], + titles[file], + "", + null, + score, + filenames[file], + ]); } return results; }, @@ -492,34 +499,33 @@ var Search = { /** * helper function to return a node containing the * search summary for a given text. keywords is a list - * of stemmed words, hlwords is the list of normal, unstemmed + * of stemmed words, highlightWords is the list of normal, unstemmed * words. the first one is used to find the occurrence, the * latter for highlighting it. */ - makeSearchSummary : function(htmlText, keywords, hlwords) { - var text = Search.htmlToText(htmlText); - if (text == "") { - return null; - } - var textLower = text.toLowerCase(); - var start = 0; - $.each(keywords, function() { - var i = textLower.indexOf(this.toLowerCase()); - if (i > -1) - start = i; - }); - start = Math.max(start - 120, 0); - var excerpt = ((start > 0) ? '...' : '') + - $.trim(text.substr(start, 240)) + - ((start + 240 - text.length) ? '...' : ''); - var rv = $('

    ').text(excerpt); - $.each(hlwords, function() { - rv = rv.highlightText(this, 'highlighted'); - }); - return rv; - } + makeSearchSummary: (htmlText, keywords, highlightWords) => { + const text = Search.htmlToText(htmlText).toLowerCase(); + if (text === "") return null; + + const actualStartPosition = [...keywords] + .map((k) => text.indexOf(k.toLowerCase())) + .filter((i) => i > -1) + .slice(-1)[0]; + const startWithContext = Math.max(actualStartPosition - 120, 0); + + const top = startWithContext === 0 ? "" : "..."; + const tail = startWithContext + 240 < text.length ? "..." : ""; + + let summary = document.createElement("div"); + summary.classList.add("context"); + summary.innerText = top + text.substr(startWithContext, 240).trim() + tail; + + highlightWords.forEach((highlightWord) => + _highlightText(summary, highlightWord, "highlighted") + ); + + return summary; + }, }; -$(document).ready(function() { - Search.init(); -}); +_ready(Search.init); diff --git a/guide/any.html b/guide/any.html index 4060af0..1330ad6 100644 --- a/guide/any.html +++ b/guide/any.html @@ -1,10 +1,10 @@ - + - + python-any-r1 — build-time dependency — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,12 +35,12 @@
    -

    python-any-r1 — build-time dependency

    +

    python-any-r1 — build-time dependency

    The python-any-r1 eclass is used to enable Python support in packages needing it purely at build time.

    Eclass reference: python-any-r1.eclass(5)

    -

    Basic use for unconditional Python

    +

    Basic use for unconditional Python

    The defining feature of this eclass is that it defines a pkg_setup phase. It normally calls python_setup function in order to find a suitable Python interpreter, and set the global environment @@ -77,7 +78,7 @@ the three highlighted lines are specific to Python eclasses, plus the implicitly exported pkg_setup phase.

    -

    Dependencies

    +

    Dependencies

    When depending on other Python packages, USE dependencies need to be declared in order to ensure that the dependencies would be built against the Python implementation used for the package. When Python @@ -158,7 +159,7 @@ called at most once. In particular, it is invalid to split the above example into multiple python_gen_any_dep calls.

    -

    Conditional Python use

    +

    Conditional Python use

    In some packages, Python is only necessary with specific USE flag combinations. This is particularly common when Python is used for the test suite. In that case, the dependencies and pkg_setup call @@ -203,7 +204,7 @@ need to be wrapped in appropriate USE conditions:

    -

    Additional conditional dependencies

    +

    Additional conditional dependencies

    Another possible case is that Python is required unconditionally but some dependencies are required only conditionally to USE flags. The simplest way to achieve that is to use ${PYTHON_DEPS} globally @@ -243,7 +244,7 @@ a similar condition in -

    Multiple sets of conditional dependencies

    +

    Multiple sets of conditional dependencies

    The hardest case for this eclass is to declare multiple Python dependencies conditional to different USE flags. While there are multiple possible ways of doing that, the least error-prone is to move @@ -359,7 +360,7 @@ USE conditional blocks inside - + @@ -376,7 +377,7 @@ USE conditional blocks inside Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/basic.html b/guide/basic.html index 53970e8..bd31abd 100644 --- a/guide/basic.html +++ b/guide/basic.html @@ -1,10 +1,10 @@ - + - + Common basics — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,13 +35,13 @@

    -

    Common basics

    +

    Common basics

    The various eclasses in python-r1 try to follow a single design. You will probably use more than one of them, so it is worthwhile to shortly explain the common bits used by all of them, as well as the non-obvious differences between them.

    -

    PYTHON_COMPAT

    +

    PYTHON_COMPAT

    The PYTHON_COMPAT variable is used by all Python eclasses, and must be declared in all ebuilds before they are inherited. It specifies the list of Python implementations supported by the package.

    @@ -56,7 +57,7 @@ inherit python-single-r1
    -

    PYTHON_DEPS and PYTHON_REQUIRED_USE

    +

    PYTHON_DEPS and PYTHON_REQUIRED_USE

    The python-any-r1, python-single-r1 and python-r1 eclasses all assume that the developer is responsible for explicitly putting the dependency strings and USE requirements in correct variables. @@ -78,7 +79,7 @@ Python unconditionally is to define the following:

    by default.

    -

    Python environment

    +

    Python environment

    The eclasses commonly use the concept of Python environment. This means a state of environment enforcing a particular Python implementation. Whenever the ebuild code is run inside this @@ -112,7 +113,7 @@ via calling python_ pkg_setup in python-any-r1 and python-single-r1.

    -

    Dependencies in Python packages

    +

    Dependencies in Python packages

    Note

    The following sections focus specifically on dependencies that @@ -121,7 +122,7 @@ tools, libraries written in other programming languages, etc. For these dependencies, the usual Gentoo rules apply.

    -

    The most common dependency types

    +

    The most common dependency types

    The dependencies found in Python packages can usually be classified into two categories: runtime dependencies and build-time dependencies.

    Runtime dependencies are packages that are required to be present @@ -188,7 +189,7 @@ in all three of RDE or for tests).

    -

    Finding dependency lists from build systems

    +

    Finding dependency lists from build systems

    Most of the modern Python build systems include all the package metadata in the pyproject.toml file. Setuptools are using setup.cfg and/or setup.py. Some packages also include custom code to read @@ -321,7 +322,7 @@ or noxfile.py - + @@ -338,7 +339,7 @@ or noxfile.pySphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/buildsys.html b/guide/buildsys.html index 711d411..ca0b5dd 100644 --- a/guide/buildsys.html +++ b/guide/buildsys.html @@ -1,10 +1,10 @@ - + - + Integration with build systems written in Python — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,21 +35,21 @@

    -

    Integration with build systems written in Python

    +

    Integration with build systems written in Python

    Besides the build systems commonly used by Python packages there are a few build systems written in Python and requiring the packages to script them in Python. This makes it necessary to use a proper Python eclass in order to declare their compatibility with Python versions.

    -

    Meson

    +

    Meson

    Meson build system is a fairly recent addition. While it is written in Python, its scripts use a custom Python-agnostic script language. Hence, it can be treated as an arbitrary external tool and does not need any Python eclass.

    -

    SCons

    +

    SCons

    SCons has gained Python 3 support quite recently. At the same time, many old script files were written for Python 2 and fail when run via Python 3 SCons. For this reason, it is necessary to use Python @@ -62,7 +63,7 @@ The latter eclass takes care of setting as much as possible.

    for them and use an appropriate eclass as detailed in the eclass choice chapter.

    -

    Build-time use with no extra dependencies

    +

    Build-time use with no extra dependencies

    If the package either has no other Python components than SCons, or all of them are purely build-time and have no dependencies, it is sufficient to inherit python-any-r1. The eclass takes care of setting @@ -123,7 +124,7 @@ to inherit python-a

    -

    Build-time use with extra dependencies

    +

    Build-time use with extra dependencies

    If the package has extra dependencies, you need to take care of all dependencies yourself. This is because python_gen_any_dep cannot be combined.

    @@ -218,7 +219,7 @@ be combined.

    -

    Single-impl package

    +

    Single-impl package

    If the package needs to install some Python components, and single-impl install is appropriate, you need to combine python-single-r1 with scons-utils. In this case, the eclass takes care of everything @@ -288,7 +289,7 @@ package.

    -

    Single-impl package with conditional Python install

    +

    Single-impl package with conditional Python install

    If the runtime part of the package uses Python only conditionally, the use is similar to a package with unconditional build-time and conditional runtime dependency on Python. That is, build-time @@ -393,7 +394,7 @@ unconditionally.

    -

    Pure Python multi-impl package

    +

    Pure Python multi-impl package

    When you are dealing with a pure Python package using SCons, it makes sense to use plain python-r1 API. This means that SCons is going to be called from a python_foreach_impl loop only.

    @@ -469,7 +470,7 @@ to be called from a
    -

    Hybrid python-r1 + SCons package

    +

    Hybrid python-r1 + SCons package

    Finally, let’s consider a package that uses SCons as a build system and installs Python components independently of it. This could be e.g. a C/C++ program with separate Python bindings.

    @@ -540,7 +541,7 @@ case, the any-r1 API is recommended.

    -

    waf

    +

    waf

    The waf build system is written in Python and bundled with the packages using it. Therefore, it is necessary to combine waf-utils eclass with one of the Python eclasses.

    @@ -553,7 +554,7 @@ interpreter, it is necessary to add < all waf packages (combined with individual package requirements if applicable).

    -

    Build-time use

    +

    Build-time use

    If waf is the only build-time Python script in the package, it is only necessary to add PYTHON_REQ_USE and ${PYTHON_DEPS} to build-time dependencies. If the package had other Python dependencies, you would @@ -584,7 +585,7 @@ specify them instead.

    -

    Single-impl package

    +

    Single-impl package

    The rules for integrating simple-impl package are roughly the same as for pure python-single-r1 use. Again, waf requires only plain build-time ${PYTHON_DEPS} and PYTHON_REQ_USE.

    @@ -713,7 +714,7 @@ build-time ${PYTHON - + @@ -730,7 +731,7 @@ build-time ${PYTHON ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/concept.html b/guide/concept.html index 15e72e8..9e2c713 100644 --- a/guide/concept.html +++ b/guide/concept.html @@ -1,10 +1,10 @@ - + - + Advanced concepts — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,11 +35,11 @@
    -

    Advanced concepts

    +

    Advanced concepts

    -

    Namespace packages

    +

    Namespace packages

    -

    Hierarchical package structure

    +

    Hierarchical package structure

    Traditionally, Python packages were organized into a hierarchical structure with modules and subpackages being located inside the parent package directory. When submodules are imported, they are represented @@ -83,7 +84,7 @@ package directory:

    to the build directory. However, there is a better solution.

    -

    Namespace package structure

    +

    Namespace package structure

    Unlike traditional packages, namespace packages act as a kind of proxy. They are not strictly bound to the containing directory, and instead permit loading subpackages from all directories found in module search @@ -129,7 +130,7 @@ of Python.

    namespace packages in Python Packaging User Guide.

    -

    Determining whether namespaces are used

    +

    Determining whether namespaces are used

    The exact method of detecting namespace packages depends on the type of namespace used.

    PEP 420 namespaces can generally be recognized by the lack @@ -150,7 +151,7 @@ they can also be recognized by setup.py or setup.cfg.

    -

    Adding new namespace packages to Gentoo

    +

    Adding new namespace packages to Gentoo

    If the package uses PEP 420 namespaces, no special action is required. Per PEP 420 layout, the package must not install __init__.py files for namespaces.

    @@ -198,7 +199,7 @@ sources, this dependency needs to be stripped, e.g.:

    -

    Legacy namespace packages in Gentoo

    +

    Legacy namespace packages in Gentoo

    Historically, Gentoo has used dev-python/namespace-* packages to support namespaces. This method is deprecated and it is in process of being retired.

    @@ -268,7 +269,7 @@ of being retired.

    - + @@ -285,7 +286,7 @@ of being retired.

    ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/depend.html b/guide/depend.html index 60963e7..b723e87 100644 --- a/guide/depend.html +++ b/guide/depend.html @@ -1,10 +1,10 @@ - + - + Advanced dependencies — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,9 +35,9 @@
    -

    Advanced dependencies

    +

    Advanced dependencies

    -

    Requesting USE flags on the Python interpreter

    +

    Requesting USE flags on the Python interpreter

    While the majority of Python standard library modules are available unconditionally, a few are controlled by USE flags. For example, the sqlite3 module requires sqlite flag to be enabled @@ -127,7 +128,7 @@ SQLite support when running tests:

    -

    Dependencies conditional to Python version

    +

    Dependencies conditional to Python version

    When packaging software for multiple Python versions, it is quite likely that you’ll find yourself needing some packages only with some of the versions, and not with others. This is the case with backports @@ -201,7 +202,7 @@ Python 3.7 was removed:

    -

    Dependencies on CFFI and greenlet

    +

    Dependencies on CFFI and greenlet

    The PyPy distribution includes special versions of the cffi and greenlet packages. For this reason, packages using CFFI and/or greenlet and supporting PyPy3 need to make the explicit @@ -280,7 +281,7 @@ dependencies conditional to CPython:

    - + @@ -297,7 +298,7 @@ dependencies conditional to CPython:

    ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/distutils-legacy.html b/guide/distutils-legacy.html index ad99c49..ed2188c 100644 --- a/guide/distutils-legacy.html +++ b/guide/distutils-legacy.html @@ -1,10 +1,10 @@ - + - + distutils-r1 legacy concepts — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,12 +35,12 @@
    -

    distutils-r1 legacy concepts

    +

    distutils-r1 legacy concepts

    This section describes concepts specific to the legacy mode of the distutils-r1 eclass. When using the modern PEP 517 mode, none of the features described here are available.

    -

    Different build system variations

    +

    Different build system variations

    The commonly used build systems specific to Python packages can be classified for eclass support into following groups:

      @@ -56,7 +57,7 @@ are used, the package needs to have a runtime dependency on dev-python/setuptools. Otherwise, a build-time dependency is sufficient.

      -

      DISTUTILS_USE_SETUPTOOLS

      +

      DISTUTILS_USE_SETUPTOOLS

      The most common case right now is a package using setuptools as a build system, and therefore needing a build-time dependency only. This is the eclass’ default. If your package does not fit this profile, @@ -107,7 +108,7 @@ An example report is:

    -

    distutils and setuptools build systems

    +

    distutils and setuptools build systems

    Distutils and setuptools are the two most common build systems for Python packages right now. Their common feature is that they use a setup.py script that interfaces with the build system. Generally, @@ -148,7 +149,7 @@ be necessary if you want to force distutils (e.g. to enable clean bootstrap) or the upstream condition requiers that.

    -

    Setuptools’ entry points

    +

    Setuptools’ entry points

    Important

    With removal of Python 3.7, the correct DISTUTILS_USE_SETUPTOOLS @@ -197,7 +198,7 @@ the QA check will also trigger the wrong value because of leftover explicit dependencies on setuptools.

    -

    Other runtime uses of setuptools

    +

    Other runtime uses of setuptools

    Besides the generated wrapper scripts, the package code itself may use the setuptools or pkg_resources packages. The common cases for this include getting package metadata and resource files. This @@ -211,7 +212,7 @@ dependency. If ins in the installed modules, please submit a patch upstream.

    -

    pyproject.toml-based projects

    +

    pyproject.toml-based projects

    The newer build systems used for Python packages avoid supplying setup.py and instead declare package’s metadata and build system information in pyproject.toml. Examples of these build systems @@ -231,7 +232,7 @@ points is not updated.

    -

    In-source vs out-of-source builds

    +

    In-source vs out-of-source builds

    In the general definition, an out-of-source build is a build where output files are placed in a directory separate from source files. By default, distutils and its derivatives always do out-of-source builds @@ -282,7 +283,7 @@ files are contained within the copy used for the current interpreter.

    -

    Installing the package before testing

    +

    Installing the package before testing

    The tests are executed in src_test phase, after src_compile installed package files into the build directory. The eclass automatically adds appropriate PYTHONPATH so that the installed @@ -390,7 +391,7 @@ has broken it for most of the consumers.

    - + @@ -407,7 +408,7 @@ has broken it for most of the consumers.

    ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/distutils.html b/guide/distutils.html index 99c72b0..adb3145 100644 --- a/guide/distutils.html +++ b/guide/distutils.html @@ -1,10 +1,10 @@ - + - + distutils-r1 — standard Python build systems — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,7 +35,7 @@
    -

    distutils-r1 — standard Python build systems

    +

    distutils-r1 — standard Python build systems

    The distutils-r1 eclass is used to facilitate build systems using setup.py (distutils and its derivatives, notably setuptools) or pyproject.toml (flit, poetry). It is built on top @@ -42,7 +43,7 @@ of python-r1 efficiently building multi-impl and single-impl packages.

    Eclass reference: distutils-r1.eclass(5)

    -

    The PEP 517 and legacy modes

    +

    The PEP 517 and legacy modes

    Warning

    The PEP 517 mode is still experimental and it is not guaranteed @@ -73,7 +74,7 @@ pyproject2setuppy hack. This mode relies on deprecated features.

    variable. Otherwise, the legacy mode is used.

    -

    Basic use (PEP 517 mode)

    +

    Basic use (PEP 517 mode)

    By default, distutils-r1 sets appropriate metadata variables and exports a full set of phase functions necessary to install packages using Python build systems.

    @@ -102,7 +103,7 @@ for the build system.

    -

    Source archives

    +

    Source archives

    The vast majority of Python packages can be found in the Python Package Index (PyPI). Often this includes both source (sdist) and binary (wheel) packages. In addition to that, many packages have public VCS @@ -141,7 +142,7 @@ that may require Internet access or have problematic dependencies (e.g. NodeJS).

    -

    Dependencies

    +

    Dependencies

    Dependencies on Python packages are declared using the same method as the underlying eclass — that is, python-r1 or python-single-r1.

    @@ -181,7 +182,7 @@ the widest test coverage, and avoid unpredictable test failures on users who have more dependencies installed).

    -

    python-single-r1 variant

    +

    python-single-r1 variant

    Normally, distutils-r1 uses python-r1 to build multi-impl packages, and this is the recommended mode. However, in some cases you will need to use python-single-r1 instead, especially if you @@ -227,7 +228,7 @@ to be rewritten.

    -

    PEP 517 build systems

    +

    PEP 517 build systems

    The majority of examples in this guide assume using setuptools build system. However, PEP 517 mode provides support for other build systems.

    In order to determine the correct build system used, read @@ -244,11 +245,6 @@ The eclass maintains a mapping of backend paths to the respective DISTUTILS_USE_PEP517 and automatically suggests the correct value.

    The following table summarizes supported backends.

    ----- @@ -309,9 +305,9 @@ as well). The eclass automatically uses the legacy setuptools backend for them.

    -

    Deprecated PEP 517 backends

    +

    Deprecated PEP 517 backends

    -

    flit.buildapi

    +

    flit.buildapi

    Some packages are still found using the historical flit build backend. Their pyproject.toml files contain a section similar to the following:

    @@ -333,7 +329,7 @@ reduces the build-time dependency footprint and therefore makes isolated PEP 517 builds faster.

    -

    poetry.masonry.api

    +

    poetry.masonry.api

    A similar problem applies to the packages using poetry. The respective pyproject.toml files contain:

    [build-system]
@@ -353,7 +349,7 @@ dependency footprint and makes isolated builds much faster.
    -

    setuptools_scm and snapshots

    +

    setuptools_scm and snapshots

    setuptools_scm is a package providing additional features for running inside a VCS checkout, in particular the ability to determine version from VCS tags. However, this works correctly only when the package @@ -393,7 +389,7 @@ via SETUPTOOLS_SCM_

    -

    Packages using Cython

    +

    Packages using Cython

    Cython is a static compiler that permits writing Python extensions in a hybrid of C and Python. Cython files are compiled into C code that is compatible with multiple Python interpreters. This makes it @@ -430,7 +426,7 @@ src_configure() { is compatible with all Python versions.

    -

    Parallel build race conditions

    +

    Parallel build race conditions

    The distutils build system has a major unresolved bug regarding race conditions. If the same source file is used to build multiple Python extensions, the build can start multiple simultaneous compiler processes @@ -462,7 +458,7 @@ additional .c files that

    -

    Sub-phase functions

    +

    Sub-phase functions

    Ebuilds define phase functions in order to conveniently override parts of the build process. distutils-r1 extends this concept by introducing sub-phases. All src_* phases in ebuild are split @@ -493,7 +489,7 @@ defining ${BUILD_DI implementation. However, if in-source builds are enabled, all phases are run in these build directories.

    -

    python_prepare

    +

    python_prepare

    python_prepare_all is responsible for applying changes to the package sources that are common to all Python implementations. The default implementation performs the tasks of default_src_prepare @@ -537,7 +533,7 @@ enables in-source builds.

    -

    python_configure

    +

    python_configure

    python_configure and python_configure_all have no default functionality. The former is convenient for running additional configuration steps if needed by the package, the latter for defining @@ -557,7 +553,7 @@ global environment variables.

    -

    python_compile

    +

    python_compile

    python_compile normally builds the package. It is sometimes used to pass additional arguments to the build step. For example, it can be used to disable parallel extension builds in packages that are broken @@ -578,7 +574,7 @@ the documentation (see

    -

    python_test

    +

    python_test

    python_test is responsible for running tests. It has no default implementation but you are strongly encouraged to provide one (either directly or via distutils_enable_tests). python_test_all @@ -591,7 +587,7 @@ to Python.

    -

    python_install

    +

    python_install

    python_install installs the package’s Python part. It is usually redefined in order to pass additional setup.py arguments or to install additional Python modules.

    @@ -620,7 +616,7 @@ such as bash completions or examples.

    -

    Passing arguments to setup.py

    +

    Passing arguments to setup.py

    There are two main methods of accepting additional command-line options in setup.py scripts: using global options and via command options.

    Global options are usually implemented through manipulating sys.path @@ -659,7 +655,7 @@ take boolean arguments. In this case, the ebuild can use:

    -

    Calling custom setup.py commands

    +

    Calling custom setup.py commands

    When working on packages using setuptools or modified distutils, you sometimes need to manually invoke setup.py. The eclass provides a esetup.py helper that wraps it with additional checks, error @@ -673,7 +669,7 @@ beforehand (much like -

    Preventing test directory from being installed

    +

    Preventing test directory from being installed

    Many packages using the setuptools build system utilize the convenient find_packages() method to locate the Python sources. In some cases, this method also wrongly grabs top-level test directories or other files @@ -706,7 +702,7 @@ directories in the install phase:

    -

    Enabling tests

    +

    Enabling tests

    Since Python performs only minimal build-time (or more precisely, import-time) checking of correctness, it is important to run tests of Python packages in order to catch any problems early. This is @@ -719,7 +715,7 @@ specify a test runner that’s not strictly necessary — e.g. specify anywhere and work just fine with built-in modules. The best way to determine the test runner to use is to grep the test sources.

    -

    Using distutils_enable_tests

    +

    Using distutils_enable_tests

    The simplest way of enabling tests is to call distutils_enable_tests in global scope, passing the test runner name as the first argument. This function takes care of declaring test phase, setting appropriate @@ -758,7 +754,7 @@ setting RDEPEND

    -

    Adding more test dependencies

    +

    Adding more test dependencies

    Additional test dependencies can be specified in test? conditional. The flag normally does not need to be explicitly declared, as distutils_enable_tests does that in the majority of cases.

    @@ -798,7 +794,7 @@ can be rewritten as:

    -

    Installing the package before running tests

    +

    Installing the package before running tests

    In PEP 517 mode, the eclass automatically exposes a venv-style install tree to the test phase. No explicit action in necessary.

    In the legacy mode, distutils_enable_tests has an optional @@ -807,7 +803,7 @@ to a temporary directory. More information can be found in the legacy section.

    -

    Undesirable test dependencies

    +

    Undesirable test dependencies

    There is a number of packages that are frequently listed as test dependencies upstream but have little to no value for Gentoo users. It is recommended to skip those test dependencies whenever possible. @@ -832,7 +828,7 @@ for the former, and an environment close enough to the latter. Do not use tox in ebuilds.

    -

    Customizing the test phase

    +

    Customizing the test phase

    If additional pre-/post-test phase actions need to be performed, they can be easily injected via overriding src_test() and making it call distutils-r1_src_test:

    @@ -920,7 +916,7 @@ of its logic.

    so you must make sure to call it if you override src_test.

    -

    Customizing the test phase for pytest

    +

    Customizing the test phase for pytest

    For the relatively frequent case of pytest-based packages needing additional customization, a epytest helper is provided. The helper runs pytest with a standard set of options and automatic handling @@ -937,7 +933,7 @@ python_test() {

    -

    Running tests with virtualx

    +

    Running tests with virtualx

    Test suites requiring a display to work correctly can often be appeased usng Xvfb. If the package in question does not start Xvfb directly, virtualx.eclass can be used to do that. Whenever possible, it is @@ -973,7 +969,7 @@ this. In other contexts,

    -

    Building documentation via Sphinx

    +

    Building documentation via Sphinx

    dev-python/sphinx is commonly used to document Python packages. It comes with a number of plugins and themes that make it convenient to write and combine large text documents (such as this Guide!), @@ -986,7 +982,7 @@ for Sphinx, and packages that use plugins need to guarantee the same implementation across all plugins. To cover all those use cases easily, the distutils_enable_sphinx function is provided.

    -

    Basic documentation with autodoc

    +

    Basic documentation with autodoc

    The most common case is a package that uses Sphinx along with autodoc. It can be recognized by conf.py listing sphinx.ext.autodoc in the extension list. In order to support building documentation, @@ -1025,7 +1021,7 @@ of the supported implementations, and appropriate -

    Additional Sphinx extensions

    +

    Additional Sphinx extensions

    It is not uncommon for packages to require additional third-party extensions to Sphinx. Those include themes. In order to specify dependencies on the additional packages, pass them as extra arguments @@ -1058,7 +1054,7 @@ packages. However, it does not have to be the one in -

    Sphinx without autodoc or extensions

    +

    Sphinx without autodoc or extensions

    Finally, there are packages that use Sphinx purely to build documentation from text files, without inspecting Python code. For those packages, the any-r1 API can be omitted entirely and plain @@ -1092,7 +1088,7 @@ should be used, and issue a warning if it’s missing or incorrect.

    -

    Packages with optional Python build system usage

    +

    Packages with optional Python build system usage

    The eclass has been written with the assumption that the vast majority of its consumers will be using the Python build systems unconditionally. For this reason, it sets the ebuild metadata variables (dependencies, @@ -1201,7 +1197,7 @@ follows:

    -

    Packages with Rust extensions (using Cargo)

    +

    Packages with Rust extensions (using Cargo)

    Some Python build systems include support for writing extensions in the Rust programming language. Two examples of these are setuptools using dev-python/setuptools_rust plugin and Maturin. Normally, @@ -1346,7 +1342,7 @@ warnings. Finally, the ebuild needs to call @@ -1363,7 +1359,7 @@ warnings. Finally, the ebuild needs to call Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/eclass.html b/guide/eclass.html index 5833a4c..ceb6066 100644 --- a/guide/eclass.html +++ b/guide/eclass.html @@ -1,10 +1,10 @@ - + - + Choosing between Python eclasses — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,9 +35,9 @@

    -

    Choosing between Python eclasses

    +

    Choosing between Python eclasses

    -

    Build-time vs runtime use

    +

    Build-time vs runtime use

    The first basis for choosing Python eclass is whether Python is used merely at build-time or at runtime as well.

    A runtime use occurs if the package explicitly needs Python to be @@ -63,7 +64,7 @@ loads Python code from the package and a compatible Python version must be enforced.

    -

    Single-impl vs multi-impl

    +

    Single-impl vs multi-impl

    The second important basis for packages using Python at runtime is whether the package in question should support multi-implementation install or not.

    @@ -101,7 +102,7 @@ These USE flag sets can be set independently to provide greater flexibility for developers and end users.

    -

    A rule of thumb

    +

    A rule of thumb

    As a rule of thumb, the following checklist can be used to determine the eclass to use:

      @@ -128,7 +129,7 @@ at runtime, use pyt
    -

    python-utils-r1

    +

    python-utils-r1

    Besides the aforementioned eclasses, the suite includes a common utility eclass python-utils-r1. This eclass is inherited by all other eclasses, and it is considered to be a part of their API. Therefore, @@ -208,7 +209,7 @@ and are not suitable for being used otherwise.

    - + @@ -225,7 +226,7 @@ and are not suitable for being used otherwise.

    ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/expert-multi.html b/guide/expert-multi.html index 470a4cf..841f654 100644 --- a/guide/expert-multi.html +++ b/guide/expert-multi.html @@ -1,10 +1,10 @@ - + - + Expert python-r1 usage — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,12 +35,12 @@
    -

    Expert python-r1 usage

    +

    Expert python-r1 usage

    The APIs described in this chapter are powerful but even harder to use than those described in python-r1 chapter. You should not consider using them unless you have a proper ninja training.

    -

    Partially restricting Python implementation

    +

    Partially restricting Python implementation

    There are packages that have been ported to Python 3 only partially. They may still have some optional dependencies that support Python 2 only, they may have some components that do not support Python 3 yet. @@ -153,7 +154,7 @@ list.

    -

    Restricting interpreters for python_setup

    +

    Restricting interpreters for python_setup

    A specific case of the restriction described above is when the build step supports a subset of Python targets for the runtime part. This could happen e.g. if package’s Python bindings have been ported @@ -289,7 +290,7 @@ call).

    package’s files, the any-r1 API described below is preferable to this.

    -

    Disjoint build dependencies (any-r1 API)

    +

    Disjoint build dependencies (any-r1 API)

    Some packages have disjoint sets of runtime and pure build-time dependencies. The former need to be built for all enabled implementations, the latter only for one of them. The any-r1 API @@ -298,7 +299,7 @@ in python-r1 to build documentation. Naturally, you’re going to build the documents only once, not separately for every enabled target.

    -

    Using regular python-r1 API

    +

    Using regular python-r1 API

    If you were using the regular API, you’d have to use ${PYTHON_USEDEP} on the dependencies. The resulting code could look like the following:

    @@ -328,7 +329,7 @@ to the old version of -

    Using any-r1 API with python-r1

    +

    Using any-r1 API with python-r1

    As the name suggests, the any-r1 API resembles the API used by python-any-r1 eclass. The disjoint build-time dependencies are declared using python_gen_any_dep, and need to be tested @@ -369,7 +370,7 @@ we have used this API to add Python 3.8 support to packages before another implementation for Sphinx.

    -

    Different sets of build-time dependencies

    +

    Different sets of build-time dependencies

    Let’s consider the case when Python is used at build-time for something else still. In that case, we want python_setup to work unconditionally but enforce dependencies only with doc flag enabled.

    @@ -402,7 +403,7 @@ it will use any interpreter that is supported and installed, even if it is not enabled explicitly in PYTHON_TARGETS.

    -

    Using any-r1 API with distutils-r1

    +

    Using any-r1 API with distutils-r1

    The alternate build dependency API also integrates with distutils-r1 eclass. If python_check_deps() is declared, the python_*_all() sub-phase functions are called with the interpreter selected according @@ -433,7 +434,7 @@ therefore python_ch

    -

    Combining any-r1 API with implementation restrictions

    +

    Combining any-r1 API with implementation restrictions

    Both APIs described above can be combined. This can be used when build-time scripts support a subset of implementations supported by the package itself, and by its build-time dependencies. For example, @@ -610,7 +611,7 @@ to python_gen_any_d - + @@ -627,7 +628,7 @@ to python_gen_any_d ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/genindex.html b/guide/genindex.html index b24fd44..5477d3e 100644 --- a/guide/genindex.html +++ b/guide/genindex.html @@ -1,7 +1,7 @@ - + @@ -11,6 +11,7 @@ + @@ -340,7 +341,7 @@ - + @@ -357,7 +358,7 @@ ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 diff --git a/guide/helper.html b/guide/helper.html index cb86425..d411753 100644 --- a/guide/helper.html +++ b/guide/helper.html @@ -1,10 +1,10 @@ - + - + Common helper functions — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,7 +35,7 @@

    -

    Common helper functions

    +

    Common helper functions

    The functions described in this chapter are common to all three basic eclasses. To facilitate code reuse, they are declared in python-utils-r1.eclass. However, you should not inherit this @@ -42,7 +43,7 @@ eclass directly and instead assume the functions are provided as part of the API of other eclasses.

    Eclass reference: python-utils-r1.eclass(5)

    -

    Install helpers

    +

    Install helpers

    The install helpers are provided commonly for python-single-r1 and python-r1 eclasses. Their main purpose is to facilitate installing Python scripts, modules and extensions whenever the package @@ -108,7 +109,7 @@ extensions:

    -

    Fixing shebangs on installed scripts

    +

    Fixing shebangs on installed scripts

    If upstream build system installs Python scripts, it should also update their shebangs to match the interpreter used for install. Otherwise, the scripts could end up being run via another implementation, one @@ -157,7 +158,7 @@ to install a script with

    -

    Byte-compiling Python modules

    +

    Byte-compiling Python modules

    Python modules are byte compiled in order to speed up their loading. Byte-compilation is normally done by the build system when the modules are installed. However, sometimes packages fail to compile them @@ -196,7 +197,7 @@ to them can be passed to the function:

    -

    Querying the implementation information

    +

    Querying the implementation information

    Most of the time, various build systems manage to detect and query the Python implementation correctly for necessary build details. Ocassionally, you need to provide those values or override bad detection @@ -319,7 +320,7 @@ helpers instead.

    - + @@ -336,7 +337,7 @@ helpers instead.

    ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/index.html b/guide/index.html index 10c530c..8ff8454 100644 --- a/guide/index.html +++ b/guide/index.html @@ -1,10 +1,10 @@ - + - + Gentoo Python Guide — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -33,12 +34,12 @@
    -

    Gentoo Python Guide

    +

    Gentoo Python Guide

    -
    Author
    +
    Author:

    Michał Górny

    -
    License
    +
    License:

    Creative Commons Attribution 4.0 International

    @@ -207,7 +208,7 @@
    -

    Indices and tables

    +

    Indices and tables

    • Index

    • Search Page

      • @@ -273,7 +274,7 @@ - + @@ -290,7 +291,7 @@ ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/interpreter-maintenance.html b/guide/interpreter-maintenance.html index f0ab8b4..9407e9e 100644 --- a/guide/interpreter-maintenance.html +++ b/guide/interpreter-maintenance.html @@ -1,10 +1,10 @@ - + - + Maintenance of Python implementations — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -33,9 +34,9 @@
      -

      Maintenance of Python implementations

      +

      Maintenance of Python implementations

      -

      Life cycle of a Python implementation

      +

      Life cycle of a Python implementation

      Every Python implementation (understood as a potential target) in Gentoo follows roughly the following life cycle:

        @@ -91,9 +92,9 @@ at stage 8, as the targets were removed already and it is kept as a dependency and testing target.

      -

      Notes specific to Python interpreters

      +

      Notes specific to Python interpreters

      -

      CPython patchsets

      +

      CPython patchsets

      Gentoo is maintaining patchsets for all CPython versions. These include some non-upstreamable Gentoo patches and upstream backports. While it is considered acceptable to add a new patch (e.g. a security bug fix) @@ -134,7 +135,7 @@ create the tag and push it:

    -

    PyPy

    +

    PyPy

    Due to high resource requirements and long build time, PyPy on Gentoo is provided both in source and precompiled form. This creates a bit unusual ebuild structure:

    @@ -168,9 +169,9 @@ in ~/binpkg/${arch}
    -

    Adding a new Python implementation

    +

    Adding a new Python implementation

    -

    Eclass and profile changes

    +

    Eclass and profile changes

    When adding a new Python target, please remember to perform all the following tasks:

      @@ -195,7 +196,7 @@ in app-portage/gpyu
    -

    Porting initial packages

    +

    Porting initial packages

    The initial porting is quite hard due to a number of circular dependencies. To ease the process, it is recommended to temporarily limit testing of the packages that feature many additional test @@ -282,7 +283,7 @@ on reenabling tests in the packages where they were skipped.

    -

    Python build system bootstrap

    +

    Python build system bootstrap

    Python build systems are often facing the bootstrap problem — that is, the build system itself has some dependencies, while these dependencies require the same build system to build. The common upstream way @@ -378,7 +379,7 @@ dependencies will be added or vendored into flit_core.

    - + @@ -395,7 +396,7 @@ dependencies will be added or vendored into flit_core.

    ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/interpreter.html b/guide/interpreter.html index 1f00c19..b2ce233 100644 --- a/guide/interpreter.html +++ b/guide/interpreter.html @@ -1,10 +1,10 @@ - + - + Python interpreters — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,9 +35,9 @@
    -

    Python interpreters

    +

    Python interpreters

    -

    Versions of Python

    +

    Versions of Python

    By a version of Python we usually mean the variant of Python language and standard library interface as used by a specific version of CPython, the reference implementation of Python.

    @@ -66,7 +67,7 @@ window of 3-4 versions of Python 3. They are provided as slots of dev-lang/python.

    -

    Alternative Python implementations

    +

    Alternative Python implementations

    CPython is the reference and most commonly used Python implementation. However, there are other interpreters that aim to maintain reasonable compatibility with it.

    @@ -103,7 +104,7 @@ features and standard library modules while preserving backwards compatibility with existing code. It is not packaged in Gentoo.

    -

    Support for multiple implementations

    +

    Support for multiple implementations

    The support for simultaneously using multiple Python implementations is implemented primarily through USE flags. The packages installing or using Python files define either PYTHON_TARGETS @@ -127,7 +128,7 @@ nor python3< also be modified to call specific version of Python directly.

    -

    Backports

    +

    Backports

    A common method of improving compatibility with older versions of Python is to backport new standard library modules or features. Packages doing that are generally called backports.

    @@ -253,7 +254,7 @@ syntax than native asyncio code.

    - + @@ -270,7 +271,7 @@ syntax than native asyncio code.

    ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/migration.html b/guide/migration.html index 63112b2..828a085 100644 --- a/guide/migration.html +++ b/guide/migration.html @@ -1,10 +1,10 @@ - + - + Migration guides — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,9 +35,9 @@
    -

    Migration guides

    +

    Migration guides

    -

    Migrating from old PYTHON_USEDEP syntax in python-single-r1

    +

    Migrating from old PYTHON_USEDEP syntax in python-single-r1

    Prior to February 2020, python-single-r1 used to provide a single PYTHON_USEDEP variable alike the two other eclasses. However, getting it to work correctly both on single-impl and multi-impl packages @@ -67,16 +68,12 @@ you probably got single-impl vs. multi-impl wrong.

    method.

    -

    Migrating from EAPI 7 to EAPI 8

    +

    Migrating from EAPI 7 to EAPI 8

    EAPI 8 has banned everything that’s been deprecated in EAPI 7, as well as some other obsolete stuff. The following table lists all banned things along with their suggested replacements.

    USE_PEP517 value

    Provider package
    ---- @@ -196,7 +193,7 @@ of Python 2 support, it always evaluated to true.

    All the aforementioned replacements are available in all EAPIs.

    -

    Migrating to PEP 517 builds

    +

    Migrating to PEP 517 builds

    As of January 2022, the distutils-r1 can use PEP 517 build backends instead of calling setuptools directly. The new mode is particularly useful for:

    @@ -297,7 +294,7 @@ necessary and tests should work out of the box.

    - + @@ -314,7 +311,7 @@ necessary and tests should work out of the box.

    ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/multi.html b/guide/multi.html index 9c2bec6..392e5bb 100644 --- a/guide/multi.html +++ b/guide/multi.html @@ -1,10 +1,10 @@ - + - + python-r1 — multi-impl packages — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,7 +35,7 @@
    -

    python-r1 — multi-impl packages

    +

    python-r1 — multi-impl packages

    The python-r1 eclass is used to install multi-impl packages. It is considered an expert eclass — when possible, you should prefer using python-single-r1 instead. For packages using distutils @@ -42,7 +43,7 @@ or a similar Python build system,

    Eclass reference: python-r1.eclass(5)

    -

    Manual install

    +

    Manual install

    The simplest case of multi-impl package is a package without a specific build system. The modules need to be installed manually here, and python_foreach_impl function is used to repeat the install step @@ -110,7 +111,7 @@ need to be executed:

    -

    Dependencies

    +

    Dependencies

    When depending on other Python packages, USE dependencies need to be declared in order to ensure that the dependencies would be built against all the Python implementations enabled for the package. This is easily @@ -124,7 +125,7 @@ to the dependencies:

    -

    Pure Python autotools package

    +

    Pure Python autotools package

    Another typical case for this eclass is to handle a pure Python package with a non-standard build system. In this case, it is generally necessary to call phase functions via python_foreach_impl. Whenever @@ -249,7 +250,7 @@ to do that:

    has been removed in order to disable out-of-source builds.

    -

    Conditional Python use

    +

    Conditional Python use

    When the package installs Python components conditionally to a USE flag, the respective USE conditional needs to be consistently used in metadata variables and in python_foreach_impl calls.

    @@ -309,7 +310,7 @@ rules for installing Python files as they are suitable only for single-impl installs.

    -

    Additional build-time Python use

    +

    Additional build-time Python use

    Some packages additionally require Python at build time, independently of Python components installed (i.e. outside python_foreach_impl). The eclass provides extensive API for this purpose but for now we’ll @@ -436,7 +437,7 @@ flag, while parts affecting build time ( @@ -453,7 +454,7 @@ flag, while parts affecting build time (Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/package-maintenance.html b/guide/package-maintenance.html index 320466d..9fb1d4e 100644 --- a/guide/package-maintenance.html +++ b/guide/package-maintenance.html @@ -1,10 +1,10 @@ - + - + Python package maintenance — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,9 +35,9 @@

    -

    Python package maintenance

    +

    Python package maintenance

    -

    Support for Python 2

    +

    Support for Python 2

    Since Python 2.7 reached EOL, Gentoo is currently phasing out support for Python 2. Unless your package or its reverse dependencies really need it, you should omit it from PYTHON_COMPAT. If you’re adding @@ -49,7 +50,7 @@ of reverse dependencies afterwards.

    supporting it soon are being slowly removed.

    -

    Which implementations to test new packages for?

    +

    Which implementations to test new packages for?

    The absolute minimum set of targets are the current default targets found in profiles/base/make.defaults. However, developers are strongly encouraged to test at least the next Python 3 version @@ -58,7 +59,7 @@ in order to ease future transition, and preferably all future versions.

    coverage of PyPy3 support.

    -

    Adding new Python implementations to existing packages

    +

    Adding new Python implementations to existing packages

    New Python implementations can generally be added to existing packages without a revision bump. This is because the new dependencies are added conditionally to new USE flags. Since the existing users can not have @@ -70,7 +71,7 @@ will not be able to enable newly added flags and therefore the risk of the change breaking stable systems is minimal.

    -

    Which packages can be (co-)maintained by the Python project?

    +

    Which packages can be (co-)maintained by the Python project?

    A large part of the Python ecosystem is fairly consistent, making it feasible for (co-)maintenance by the Gentoo Python team.

    As a rule of thumb, Python team is ready to maintain packages specific @@ -87,7 +88,7 @@ the package. However, if you are not a member of the project, please do not add us without asking first.

    -

    Porting packages to a new EAPI

    +

    Porting packages to a new EAPI

    When porting packages to a new EAPI, please take care not to port the dependencies of Portage prematurely. This generally includes app-portage/gemato, dev-python/setuptools and their recursive @@ -169,7 +170,7 @@ necessary to install a new Portage version.

    - + @@ -186,7 +187,7 @@ necessary to install a new Portage version.

    ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/porting.html b/guide/porting.html index 82dd7bc..3ff19a5 100644 --- a/guide/porting.html +++ b/guide/porting.html @@ -1,10 +1,10 @@ - + - + Porting tips — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,7 +35,7 @@
    -

    Porting tips

    +

    Porting tips

    This section highlights some of the known incompatible changes made in Python that could break Python scripts and modules that used to work in prior versions. The sections are split into retroactive changes made @@ -44,9 +45,9 @@ to all Python releases, and information specific to every Python branch of other problems you’ve hit while porting your packages, please let me know and I will update it.

    -

    Retroactive changes

    +

    Retroactive changes

    -

    bpo43882: urlsplit now strips LF, CR and HT characters

    +

    bpo43882: urlsplit now strips LF, CR and HT characters

    Changed in: 2.7.18_p9, 3.6.13_p3, 3.7.10_p3, 3.8.9_p2, 3.9.4_p1

    Historically, various urllib.parse methods have passed special characters such as LF, CR and HT through into the split URL components. @@ -74,10 +75,10 @@ PR#14349 for an example of impact and a fix.

    -

    Python 3.11

    +

    Python 3.11

    See also: what’s new in Python 3.11

    -

    Generator-based coroutine removal (asyncio.coroutine)

    +

    Generator-based coroutine removal (asyncio.coroutine)

    Support for generator-based coroutines has been deprecated since Python 3.8, and is finally removed in 3.11. This usually results in the following error:

    @@ -101,7 +102,7 @@ and yield
    -

    inspect.getargspec() and inspect.formatargspec() removal

    +

    inspect.getargspec() and inspect.formatargspec() removal

    The inspect.getargspec() (deprecated since Python 3.0) and inspect.formatargspec() (deprecated since Python 3.5) functions are both removed in Python 3.11.

    @@ -202,10 +203,10 @@ of Signature
    -

    Python 3.10

    +

    Python 3.10

    See also: what’s new in Python 3.10

    -

    configure: No package ‘python-3.1’ found

    +

    configure: No package ‘python-3.1’ found

    automake prior to 1.16.3 wrongly recognized Python 3.10 as 3.1. As a result, build with Python 3.10 fails:

    checking for python version... 3.1
@@ -241,17 +242,13 @@ distribution of automake:
    
 
    The upstream fix is to create new distfiles using automake-1.16.3+.
    -

    distutils.sysconfig deprecation

    +

    distutils.sysconfig deprecation

    Upstream intends to remove distutils by Python 3.12. Python 3.10 starts throwing deprecation warnings for various distutils modules. The distutils.sysconfig is usually easy to port.

    The following table summarizes replacements for common path getters.

    Deprecated thing

    Replacement

    ---- @@ -284,10 +281,10 @@ no trivial replacement for the variants with -

    Python 3.9

    +

    Python 3.9

    See also: what’s new in Python 3.9

    -

    base64.encodestring / base64.decodestring removal

    +

    base64.encodestring / base64.decodestring removal

    Python 3.9 removes the deprecated base64.encodestring() and base64.decodestring() functions. While they were deprecated since Python 3.1, many packages still use them today.

    @@ -316,10 +313,10 @@ of base64-encoded data for any length of output.

    -

    Python 3.8

    +

    Python 3.8

    See also: what’s new in Python 3.8

    -

    python-config and pkg-config no longer list Python library by default

    +

    python-config and pkg-config no longer list Python library by default

    Until Python 3.7, the python-X.Y pkg-config file and python-config tool listed the Python library. Starting with 3.8, this is no longer the case. If you are building Python extensions, this is fine (they @@ -407,7 +404,7 @@ are provided for the purpose.

    - + @@ -424,7 +421,7 @@ are provided for the purpose.

    ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/preface.html b/guide/preface.html index 2616fc1..18b3e1e 100644 --- a/guide/preface.html +++ b/guide/preface.html @@ -1,10 +1,10 @@ - + - + Preface — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,7 +35,7 @@
    -

    Preface

    +

    Preface

    Gentoo provides one of the best frameworks for providing Python support in packages among operating systems. This includes support for running multiple versions of Python (while most other distributions @@ -116,7 +117,7 @@ and improvements are welcome.

    - + @@ -133,7 +134,7 @@ and improvements are welcome.

    ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/pytest.html b/guide/pytest.html index ad3f8bc..6a29ca2 100644 --- a/guide/pytest.html +++ b/guide/pytest.html @@ -1,10 +1,10 @@ - + - + pytest recipes — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,9 +35,9 @@
    -

    pytest recipes

    +

    pytest recipes

    -

    Skipping tests based on markers

    +

    Skipping tests based on markers

    A few packages use custom pytest markers to indicate e.g. tests requiring Internet access. These markers can be used to conveniently disable whole test groups, e.g.:

    @@ -47,7 +48,7 @@ disable whole test groups, e.g.:

    -

    Skipping tests based on paths/names

    +

    Skipping tests based on paths/names

    There are two primary methods of skipping tests based on path (and name) in pytest: using --ignore and --deselect.

    --ignore causes pytest to entirely ignore a file or a directory @@ -71,7 +72,7 @@ requires using the local scope.

    python_test() {
     local EPYTEST_IGNORE=(
         # ignore whole file with missing dep
-        --ignore tests/test_client.py
+        tests/test_client.py
     )
     local EPYTEST_DESELECT=(
         # deselect a single test
@@ -89,7 +90,7 @@ requires using the local scope.
    -

    Avoiding the dependency on pytest-runner

    +

    Avoiding the dependency on pytest-runner

    pytest-runner is a package providing pytest command to setuptools. While it might be convenient upstream, there is no real reason to use it in Gentoo packages. It has no real advantage over calling pytest @@ -107,7 +108,7 @@ tests. If this is the case, the dependency must be stripped.

    -

    Using pytest-xdist to run tests in parallel

    +

    Using pytest-xdist to run tests in parallel

    pytest-xdist is a plugin that makes it possible to run multiple tests in parallel. This is especially useful for programs with large test suites that take significant time to run single-threaded.

    @@ -141,7 +142,7 @@ gain from doing so. If the package’s tests take a short time to finish, please avoid the dependency and strip it if necessary.

    -

    Avoiding dependencies on other pytest plugins

    +

    Avoiding dependencies on other pytest plugins

    There is a number of pytest plugins that have little value to Gentoo users. They include plugins for test coverage (dev-python/pytest-cov), coding style (dev-python/pytest-flake8) @@ -166,7 +167,7 @@ to strip options enabling them from <

    -

    Explicitly disabling automatic pytest plugins

    +

    Explicitly disabling automatic pytest plugins

    Besides plugins explicitly used by the package, there are a few pytest plugins that enable themselves automatically for all test suites when installed. In some cases, their presence causes tests of packages @@ -182,7 +183,7 @@ it explicitly:

    -

    Expert: disabling plugin autoloading entirely

    +

    Expert: disabling plugin autoloading entirely

    If a test suite invokes pytest recursively (this is particularly the case when packaging other pytest plugins), the -p option can be insufficient to disable problematic plugins, as it does not @@ -207,7 +208,7 @@ the entry_points.tx

    -

    TypeError: _make_test_flaky() got an unexpected keyword argument ‘reruns’

    +

    TypeError: _make_test_flaky() got an unexpected keyword argument ‘reruns’

    If you see a test error resembling the following:

    TypeError: _make_test_flaky() got an unexpected keyword argument 'reruns'
    @@ -230,7 +231,7 @@ python_test() {
    -

    ImportPathMismatchError

    +

    ImportPathMismatchError

    An ImportPathMismatchError generally indicates that the same Python module (or one that supposedly looks the same) has been loaded twice using different paths, e.g.:

    @@ -258,17 +259,13 @@ discovery to the actual test directories, e.g.:

    -

    fixture ‘…’ not found

    +

    fixture ‘…’ not found

    Most of the time, a missing fixture indicates that some pytest plugin is not installed. In rare cases, it can signify an incompatible pytest version or package issue.

    The following table maps common fixture names to their respective plugins.

    distutils.sysconfig call

    sysconfig replacement

    ---- @@ -294,7 +291,7 @@ plugins.

    Fixture name

    Package

    -

    Warnings

    +

    Warnings

    pytest captures all warnings from the test suite by default, and prints a summary of them at the end of the test suite run:

    =============================== warnings summary ===============================
@@ -419,7 +416,7 @@ setting ignores Dep
    - + @@ -436,7 +433,7 @@ setting ignores Dep ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/search.html b/guide/search.html index d0ad692..56e63f2 100644 --- a/guide/search.html +++ b/guide/search.html @@ -1,7 +1,7 @@ - + @@ -12,6 +12,7 @@ + @@ -130,7 +131,7 @@ ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 diff --git a/guide/searchindex.js b/guide/searchindex.js index 493976e..fc71c41 100644 --- a/guide/searchindex.js +++ b/guide/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["any","basic","buildsys","concept","depend","distutils","distutils-legacy","eclass","expert-multi","helper","index","interpreter","interpreter-maintenance","migration","multi","package-maintenance","porting","preface","pytest","single","test"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,sphinx:56},filenames:["any.rst","basic.rst","buildsys.rst","concept.rst","depend.rst","distutils.rst","distutils-legacy.rst","eclass.rst","expert-multi.rst","helper.rst","index.rst","interpreter.rst","interpreter-maintenance.rst","migration.rst","multi.rst","package-maintenance.rst","porting.rst","preface.rst","pytest.rst","single.rst","test.rst"],objects:{},objnames:{},objtypes:{},terms:{"0":[0,2,4,5,6,8,10,12,14,16,18,19,20],"01":18,"0420":[],"0x00007f748bc47740":20,"0x00007fb5db746740":20,"0x03000000":20,"0x03030000":11,"1":[0,2,3,4,5,6,8,9,12,18,19,20],"10":[1,4,5,8,10,12],"100":12,"10000":2,"1014":20,"10_p3":16,"11":[2,5,10,12,20],"110":5,"117":20,"119":20,"12":[2,5,8,16,18],"127":20,"13":[5,18,20],"131":5,"135":18,"13_p3":16,"14":[8,20],"143":5,"14349":16,"148":5,"16":16,"17":8,"170":20,"18":8,"180":20,"187":20,"18_p9":16,"193":20,"1999":[0,2,4,5,6,8,14,19],"2":[0,2,3,4,5,8,9,10,11,12,13,14,16,17,19,20],"20":12,"20120407":[2,8],"2017":8,"2020":[0,2,4,5,6,8,13,14,19],"2022":[5,13,18],"208":0,"23":20,"234":20,"24":[2,8,18,20],"25":20,"26":8,"27":[2,8],"29":5,"292":5,"2934":20,"2_7":[4,5],"2_pkg_setup":2,"2d":14,"2to3":6,"3":[0,2,3,4,5,6,8,9,10,11,12,13,14,15,17,18,19,20],"30":5,"31":2,"34":20,"360":2,"38":5,"3_":4,"3_6":[5,14],"3_7":[5,14],"3_8":5,"3_p30":0,"4":[0,3,5,8,9,10,11,12,14,20],"40":12,"42":2,"420":3,"425":5,"48":5,"492":16,"4_p1":16,"5":[0,2,5,8,9,11,12,14,16,18,19,20],"517":[1,3,6,10,12,20],"524":20,"54":20,"577":18,"578":20,"583":18,"596":20,"5a":20,"6":[0,1,2,4,5,6,8,11,12,14,16,18,19,20],"621":1,"655482":0,"66":20,"671":20,"6e5e8a57628095d8d0c8bbb38187afb0f3a42112":2,"7":[0,1,2,3,4,5,6,8,9,10,11,12,14,15,16,18,19,20],"70":2,"717":5,"73":20,"74":20,"7m":16,"8":[0,1,2,3,4,5,6,8,9,10,11,12,19,20],"80":5,"85":20,"87":20,"9":[2,5,10,12,20],"90":[2,14],"975":20,"991":20,"9_p2":16,"abstract":[7,14],"boolean":5,"break":[15,16],"byte":[10,16],"case":[0,1,2,3,4,5,6,7,8,9,11,12,13,14,16,18,19,20],"catch":5,"class":[0,1,5,16,18],"default":[1,2,5,6,7,8,9,12,13,14,15,18,19,20],"do":[0,1,3,4,5,6,8,9,11,12,14,15,17,18,19,20],"export":[0,1,2,5,19],"final":[1,2,4,5,9,12,13,16,19,20],"float":16,"function":[0,1,4,6,7,8,10,11,13,14,16,19,20],"g\u00f3rny":10,"import":[0,1,3,4,5,6,7,11,12,13,14,16,18,20],"int":16,"long":[5,11,12],"micha\u0142":10,"new":[2,5,6,9,10,11,13,16,18],"null":20,"public":[0,2,4,5,6,8,14,19],"return":[0,2,8,16,20],"short":[13,18],"static":[5,8],"switch":[4,9,12,13,20],"throw":16,"true":[0,1,2,5,6,8,12,13,16,20],"try":[1,6,8,9,11,20],"var":20,"while":[0,2,3,4,5,6,7,8,11,12,14,16,17,18,19,20],A:[0,1,2,4,5,6,8,10,11,15,18],As:[1,3,5,6,7,8,11,13,15,16,18,19,20],At:[2,5,12,15,17],But:20,By:[5,6,11],For:[0,1,2,3,4,5,6,7,8,9,11,12,13,14,16,18,20],If:[1,2,3,4,5,6,7,8,9,11,12,13,14,15,16,18,19,20],In:[0,1,2,3,4,5,7,8,10,11,12,14,16,18,19,20],It:[0,1,3,4,5,6,7,9,11,12,13,14,16,18,19,20],Its:12,No:[3,5],Not:18,On:11,One:[16,20],That:[2,16,20],The:[0,2,3,4,6,7,8,9,10,11,12,13,14,15,16,18,19,20],Their:[5,6,9],Then:[5,12],There:[1,3,5,8,9,16,18,20],These:[1,6,7,12,13,18,20],To:[5,6,8,9,12,16,18,19],With:[6,20],_:[5,12,20],____________________:20,_____________________:18,______________________:18,__dict__:20,__import__:3,__init__:[1,3,5,9,18,20],__legacy__:5,__main__:20,__name__:3,__path__:3,_all:[5,8],_bootstrap:20,_distribut:5,_do_pars:5,_feedparser_sgmllib:9,_find_and_load:20,_find_and_load_unlock:20,_gcd_import:20,_get_vers:5,_hashtabl:5,_importtestmodul:20,_install_setup_requir:5,_lib:5,_load_unlock:20,_make_test_flaki:10,_multical:20,_overridesdir:14,_pytest:[18,20],_python_all_impl:12,_python_impl_match:12,_python_impl_support:[],_python_set_impl:12,_python_verify_pattern:12,_rc:2,_run_cod:20,_run_module_as_main:20,_rust:5,_tslib:5,abil:[5,6],abl:[3,15],abort:10,about:[3,6,13],abov:[0,1,6,8,12,13,15,19,20],absolut:[0,1,9,15,19,20],accept:[0,1,5,6,9,12,15,16,18],access:[0,5,10,11,18],accompani:11,accord:8,account:[2,5,8,20],acct:2,achiev:[0,8,11,16],across:5,act:3,action:[3,5],activ:[8,17],actual:[1,5,6,7,8,9,11,12,18,20],ad:[1,10,11,13,14,18],add:[1,2,5,6,8,12,15,19,20],addit:[1,2,4,6,8,9,10,11,12,13,18,20],addition:[5,11,14],addnod:3,addopt:5,address:[6,12,16],adishatz:4,adjust:[4,9,11,16],admin:[2,8],advanc:10,advantag:[4,5,18,20],affect:[9,14],aforement:[7,13,16],after:[3,5,6,9,12,13,16],afterward:[11,14,15],again:[1,2,20],against:[0,4,7,9,11,12,14,19,20],aggress:12,agnost:2,aim:[5,11,15,17],aiohttp:[5,18],alabast:[5,6],alias:[5,16],alik:[6,11,13],all:[0,1,2,3,4,5,6,7,8,9,11,12,13,14,15,16,18,19,20],allow:[7,20],allow_test:20,alon:11,along:[2,5,6,7,11,13,19,20],alongsid:[5,6],alpha:[0,2,4,5,6,8,12,14,19],alreadi:[5,9,12,14],also:[0,1,3,4,5,6,7,8,9,11,12,13,14,16,18,20],alter:[5,18],altern:[3,6,8,10,16,17,20],altogeth:20,alwai:[5,6,8,11,13,16,17],am:14,amd64:[0,2,4,5,6,8,12,14,19],among:17,amount:[11,12,20],an:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,19,20],analysi:[2,19],ani:[1,2,3,5,6,7,10,14,16,18,20],annot:16,announc:12,anoth:[0,8,9,14,16,18,20],anticip:15,anymor:[8,11],anyth:9,anywai:[5,16],anywher:5,apach:[0,2,4,5,8],apb:2,api:[0,2,7,9,10,11,13,14,16],app:[0,2,4,5,8,12,14,15],appeas:5,append:[5,14],appli:[1,4,5,6,7,12,15,18,19,20],applic:[2,9,12],approach:[1,5,8],appropri:[0,2,4,5,6,7,9,11,12,15,19],ar:[0,1,2,4,5,6,7,8,9,11,12,13,14,15,16,17,18,19,20],arab:19,arabey:19,arabic2tran:19,arbitrari:[2,13],arch:[2,8,12],archiv:[0,2,4,10,19,20],area:20,arg:16,argcomplet:5,argpars:5,argspec:16,argument:[4,6,10,13,16,20],argv:[],arm64:[0,2,4,5,6,8,14,19],arm:[0,2,4,5,6,8,19],around:[3,5,6,12,20],arrai:5,artifact:5,asgiref:18,asgitest:18,ask:[12,15],asn1:5,asn1_der:5,assert:10,assign:1,assum:[0,1,5,6,9,13,19],assumpt:5,async:[16,18],asyncio:[11,18,20],attempt:[5,16,20],attr:[5,12],attribut:[3,10,16],attributeerror:16,author:[0,2,4,5,6,8,9,10,12,14,19],autoload:10,autom:2,automak:16,automat:[3,4,5,6,10,12],autoreconf:16,autotool:[0,5,6,10,16,19],avail:[4,5,6,8,12,13,16,17],avoid:[5,6,8,10,15,16,17,20],awai:[6,7],await:16,b64_encodebyt:16,b64decod:16,b64encod:16,b:0,back:[3,6,16],backend:[4,10,12,13],backport:[4,6,10,12],backtrac:20,backward:[5,11,12,16],bad:[9,16],badurl:16,ban:13,bar:16,base:[1,5,8,10,12,14,15,19,20],baselin:12,basemap:19,basenam:1,bash:[0,5,7,8,9,19],basi:7,basic:[9,10,20],batch:12,bdepend:[0,1,2,5,6,8,12,14,18,19],becam:[4,11],becaus:[2,5,6,15,18,20],becom:[11,12,16],been:[5,6,8,11,12,13,14,16,18],befor:[1,4,8,9,10,12,14,16,20],beforehand:5,beginn:17,behav:[5,8],behavior:[8,11,16],being:[1,3,6,7,8,9,10,11,12,15,16,18,20],beings:8,belong:[1,20],below:8,besid:[2,6,7,11,14,18],best:[0,5,12,16,17,18],better:[3,6,11,12,13,14],between:[1,5,8,10,11,12,13,16],bewar:20,beyond:17,bidirect:11,big:8,bin:[1,2,7,8,9,12,19,20],binari:[5,9,12],bind:[0,2,5,8,14,19],bindir:8,binpkg:12,bison:8,bit:[1,12,17],bitprophet:6,black:4,bleach:5,block:[0,8,13,20],bmrblib:2,boltzmann:2,boost:[2,7],bootstrap:[5,6,10],both:[0,1,3,5,6,7,8,12,13,16,17,18,19,20],bottom:5,bound:[3,11,16],box:[11,13],branch:[0,16,20],breakag:[5,20],broken:[5,6,18,20],brython:11,bsd:[0,2,5,6,8,14,19],bu:0,bug:[0,5,6,12,20],buggi:14,build:[3,9,10,11,16,20],build_api:5,build_config:2,build_dir:[2,3,5,14,20],build_ext:[5,6,20],build_meta:5,build_pdb2pka:2,buildscript:2,buildtool:[2,19],built:[0,1,3,5,6,7,8,11,12,14,17,19,20],builtin:2,bump:[5,12,15],bundl:[2,12],bypass:1,byte_compil:9,bz2:[2,8,19],bzip2:8,c:[1,2,5,6,8,9,10,14],cach:14,cachedir:20,cairo:14,calcul:2,call:[0,1,2,3,6,7,8,9,10,11,13,14,16,18,19,20],callabl:16,caller:20,can:[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,16,18,19,20],cangjian:14,cannot:[2,4,5,9,11,20],cantera:2,canva:14,capabl:0,captur:[18,20],care:[1,2,5,7,9,15,20],cargo:10,cargo_crate_uri:5,cargo_opt:5,cargo_src_unpack:5,carri:15,cat:[2,5],categori:1,caus:[1,4,5,8,9,13,18,20],cc:[2,9],cc_flag:2,cd:[2,5,9,12,20],ceas:20,certifi:8,cf:[5,12],cffi:10,cfg:[1,3,5,6,18],cflag:[5,9,20],cgit:0,chain:0,chanc:18,chang:[5,6,8,9,10,11,13,14,15,20],chapter:[2,8,9],chardet:[5,8],cheap:1,check:[0,5,6,9,12,13,16,17,20],checklist:[7,10],checkout:[5,12,20],cheetah3:2,chemic:2,chemistri:2,cherri:12,chewi:2,choic:[2,6,13,20],choos:[10,11,14],chose:13,chosen:12,chrpath:[2,8],ci:[5,20],cinnamon:0,circular:12,classifi:[1,6],clean:[6,12,13],cleanli:[6,12],cleanup:13,clear:12,clearli:[5,20],cli:[4,5],click:4,client:[2,8,9,11,14],clone:12,close:5,closest:6,cmake:[0,6,19],cmake_src_configur:[9,19],cmake_src_instal:9,cmd2:5,cmd:5,co:[10,20],code:[0,1,3,5,6,7,8,9,11,12,13,14,16,18,19,20],collada:5,collect:[6,18,20],collid:[18,20],collis:[3,5,20],color:5,colorama:5,coloredlog:5,column:5,com:[0,2,4,5,6,8,12,14,16,20],combin:[0,2,5,10,11,12,13,17,18,19,20],come:[5,13,18],comma:18,command:[10,14,18],commit:[2,20],common:[0,3,5,6,7,10,11,12,13,16,17,18,19,20],commonli:[1,2,3,5,6,9,11],compar:16,compat:[0,1,2,4,5,6,7,9,11,12,13,16,19],compet:11,compil:[5,6,10,11,20],complet:[0,5,16,17],complex:[7,19],compon:[2,3,8,11,14,16],composit:19,compress:5,compris:5,conceiv:[],concept:[1,5,10],concern:3,condit:[6,10,12,18,20],condition:[0,1,2,5,7,11,12,14,15,18,19],conf:[5,6],config:[5,9,12],configfil:20,configur:[5,6,8,13,14,20],confirm:20,confus:18,connect:20,consid:[1,2,3,6,7,8,12,14,16],consist:[1,6,9,13,14,15],console_script:[5,6],construct:[2,4,8,19],consum:[5,6,20],contain:[1,3,4,5,6,7,12,13],content:3,context:[5,19],continu:[8,12,20],contrari:16,control:[2,4,5,18],conveni:[1,4,5,6,18,20],convers:[5,6],convert:[6,8,13],convinc:20,copi:[1,3,5,6,9,11,19],copyright:[0,2,4,5,6,8,14,19],core:[2,5,20],coreutil:8,correct:[1,5,6,9,10,18,19],correctli:[0,1,5,6,7,9,11,12,13,16,20],correspond:[5,12],cost:5,could:[0,2,3,5,6,8,9,16,19],cov:[5,18],cover:[1,5,6,13],coverag:[1,5,15,18],cp:20,cpp:2,cpython:[1,4,5,9,11,13],crate:5,creat:[1,3,4,5,6,7,12,13,16],creativ:10,cropgtk:9,cruft:13,cryptic:5,cryptographi:8,csound:19,current:[0,5,6,11,12,13,15,18,20],custom:[1,2,6,10,13,18],cxx:2,cxx_flag:2,cxxflag:2,cycl:10,cyclic:[],cygwin:[5,6],cython:[2,10,14,19],d:[0,2,3,5,8,9,14,18],daemon:[2,8],danger:16,dash:5,dask:[5,18],data:[0,2,5,6,9,16,19,20],databas:[2,4],date:[12,17,20],dateutil:4,dbpathprefix:2,dbu:[0,2],dbuild_python_interfac:19,dbuild_python_opcod:19,deal:[2,7,8,10,15],debug:2,decid:[12,18],declar:[0,1,2,5,6,8,9,12,14,18,19],declare_namespac:3,decode_usenet_chunk:20,decodebyt:16,decor:[16,20],dedic:[5,6,14],deep:17,def:[16,18,20],default_src_prepar:5,defin:[0,1,5,6,11,19],definit:6,delet:[2,3,14],demonstr:[0,19],dep:[0,5,13,15,18],depend:[3,6,7,9,10,11,12,13,15,17],dependneci:5,deprec:[1,3,10,11,13],deprecationwarn:18,deriv:[5,6,7],desc:12,describ:[0,6,8,9],descript:[0,2,4,5,6,8,14,19],deselect:[12,18,20],design:[1,19],desir:[13,16,20],destdir:[2,8,9],destin:20,detail:[2,7,9,11,13,16,20],detect:[3,5,9,20],detector:5,determin:[5,6,7,11,19,20],dev:[0,1,2,3,4,5,6,7,8,11,12,13,14,15,18,19,20],devel:8,develop:[0,1,7,11,12,15,17,18,20],devic:[2,8],devmanu:20,dict2db:19,dict:[5,19],dictionari:[6,19],did:[3,13,16,20],die:[2,3,5,8,9,14,18,20],diff:12,differ:[0,1,3,5,9,10,11,16,18,20],dir:[5,14],direct:[6,7,14],directli:[1,5,6,7,9,11,13,16,18,20],directori:[3,6,9,10,11,12,13,14,16,18,20],disabl:[2,5,8,10,12,14,19,20],disable_tiff:5,disable_webp:5,discontinu:12,discourag:[3,6],discov:20,discoveri:[5,18,20],discret:18,disjoint:10,disk:20,displai:5,dist:5,distfil:[5,16,19],distinguish:[3,5,13],distribut:[0,2,4,5,6,7,8,14,16,17,19,20],distutil:[1,3,4,10,13,14,18,19,20],distutils_all_subphase_impl:8,distutils_arg:[5,13],distutils_dep:5,distutils_enable_sphinx:[5,8],distutils_enable_test:[4,13,18,20],distutils_in_source_build:6,distutils_install_for_test:[6,13,18,20],distutils_opt:5,distutils_pep517_instal:20,distutils_single_impl:5,distutils_strict_entry_point:6,distutils_use_pep517:[5,13],distutils_use_setuptool:[5,13],django:[16,20],dndebug:20,doabl:3,dobin:[2,9],doc:[1,2,5,8,19],docinto:5,docker:12,docompress:5,document:[1,2,8,10,11,14,17,20],dodir:9,dodoc:[2,5],doe:[1,2,3,5,6,8,9,11,12,14,15,16,18,20],doin:9,dom:11,domain:20,doman:2,don:[5,13],done:[1,5,6,8,9,12,14,18,20],doubl:19,down:11,downgrad:8,download:[0,2,5,8,14],downstream:20,dpython3_include_dir:13,dpython3_librari:13,dpython_dest:9,dpython_execut:9,dpython_include_dir:9,dpython_librari:9,draw:14,driver:2,drop:[11,16],duali:19,due:[10,12,14,18],dump:20,duplic:[5,14,20],dure:[1,6,7,12,13,18],dynam:2,e:[1,2,3,5,6,7,8,9,11,12,13,14,15,16,18,19,20],each:[5,6,7,11,14],eapi:[0,2,4,5,6,8,10,14,19],eappli:2,eapply_us:2,earli:[5,7,8,12],earlier:[3,13],eas:[12,15],easi:[5,16,20],easier:7,easiest:[5,19],easili:[5,14,18,20],eautoreconf:[14,16],ebuild:[0,1,4,5,6,7,12,13,14,15,16,17,19,20],echo:8,eclass:[0,1,2,3,4,5,6,8,9,10,13,14,17,18,19,20],econf:[5,19],econf_sourc:14,ecosystem:[5,15,17],ed:[2,9,15],editor:5,effect:[8,11],effici:5,egg:[5,6,18],eigen3:2,eigen:2,einstalldoc:[5,8,14],either:[1,2,5,7,8,9,11,13,18,20],electrostat:2,elibc_freebsd:2,elibc_glibc:8,els:[2,8,11,16],emak:[5,8,9],emb:16,embed:[1,2,9,11],emerg:12,empti:[4,5],en:5,enabl:[0,4,6,7,8,10,11,12,14,15,18],enable_tiff:5,enable_webp:5,encod:[5,16],encodebyt:16,encourag:[5,15],end:[5,6,7,9,12,14,18,20],energi:19,enforc:[1,4,5,7,8,11,18],enough:[1,5],ensur:[0,1,5,6,9,14,19],entir:[3,5,9,10,12,13,14,20],entri:[1,5,18],entropi:9,entry_point:[6,18],env:[9,12],env_var:2,environ:[0,5,6,10,11,13,14,16,18,19],envvar:18,eof:[2,5],eol:15,ep:5,eprefix:[2,8,9],epydoc:8,epytest:[5,6,8,12,18,20],epytest_deselect:[12,18],epytest_ignor:18,epython:[1,2,5,8,9,12,13,18,20],equal:20,equival:[3,6,8,9,13],error:[0,2,5,9,13,16,18,20],escap:[4,13,19],escon:2,eselect:8,esetup:[5,8],especi:[5,18,20],establish:[1,5,13,20],etc:1,eunittest:20,eutil:2,evalu:13,even:[5,8,9,11,18,20],event:[3,18],event_loop:18,eventlet:18,eventu:12,everi:[4,5,6,8,12,14,16],everyth:[2,13],ex:12,exact:[3,5,11,19],exactli:[0,7],exampl:[0,4,5,6,7,8,9,11,12,16,17,18,19,20],except:[6,7,9,11,12,16],exclud:5,exec:[1,8,9,11,12,20],exec_modul:20,exec_prefix:16,execut:[5,6,7,9,11,12,13,14,20],exist:[5,7,10,11,12],exit:[16,20],expand:4,expans:4,expect:[6,18,20],experienc:18,experiment:5,expert:[5,10,14,20],explain:[0,1,6],explan:20,explicit:[3,4,5,6,19,20],explicitli:[1,5,7,8,10,13,20],exploit:16,expos:[5,6],express:[0,8,13,19],ext:5,extend:[5,11],extend_path:3,extens:[1,6,7,8,9,10,11,14,15,16],extern:[1,2,5,6,7,11,12],extra:[1,5,6,10],extra_inc_dir:2,extra_opt:19,extran:5,extras_requir:[1,5],extrem:6,ez_setup:5,f90_interfac:2,f:[2,9],face:[12,20],facil:6,facilit:[5,9],fact:[5,20],fail:[0,1,2,5,8,9,11,12,16,18,20],failur:[1,5,10,12,18],fairli:[2,15,19],fall:[6,16],fallback:6,fals:[0,2,5,8,12,16],far:[3,12,19],fastdl:2,faster:5,fatal:[18,20],fdl:[0,19],feasibl:15,featur:[0,4,5,6,8,11,12,13,19,20],februari:13,feel:[5,15],fetch:12,few:[2,4,6,12,18,20],fewest:12,fi:[0,2,5,8,12,14,19],file:[0,1,2,3,5,6,7,8,9,10,11,12,13,14,16,18,19],filenam:[4,5],filesdir:2,fill:17,filterwarn:18,finalize_opt:5,find:[0,2,3,4,6,14,18,20],find_packag:5,fine:[3,5,12,16],finish:18,fionet:14,first:[5,6,7,11,12,15,16,18,20],firstli:20,fish:5,fit:[6,20],fix:[5,6,10,11,12,16,18,20],fixm:5,fixtur:[10,12],flag:[0,1,5,7,8,9,10,11,12,14,15,19,20],flake8:[5,18],flaki:[18,20],flex:8,flexibl:[5,7],flit:[1,6,7,12,13],flit_cor:[5,12],flit_scm:5,fnmatch:4,focu:[1,12,14],focus:12,folder:5,follow:[0,1,3,4,5,6,7,8,9,12,13,16,17,18,19,20],foo:[7,16],footprint:5,forbidden:5,forc:[5,6,8,9,12,13,18,20],fordfrog:19,foreach:5,fork:[0,11,12,20],form:[1,4,12,17],format:[8,12,16],former:[1,5,8,13,16,20],fortran:2,fortran_need:2,fortran_standard:2,fortranflag:2,forward:12,found:[0,1,3,5,6,9,10,15,20],foundat:14,four:[9,13,19],fourth:13,fragment:16,framework:[2,3,5,11,17],free:[2,15,20],freedesktop:0,freezegun:[4,18,20],freezer:18,frequent:[5,18],freshli:3,frobnic:5,from:[0,2,3,4,6,7,8,10,11,12,14,15,16,18,19,20],frozen:20,fspath:20,ftp:[2,19],full:[1,2,4,5,7,13,20],fullargspec:16,fulli:[4,5,7],func:[2,8],funcsig:11,further:[1,18],furthermor:[0,2,5],futur:[5,15],g:[1,2,3,5,6,7,8,9,11,12,13,14,15,16,18,19,20],ga:14,gain:[2,18],gap:17,gaupol:8,gc:11,gemato:15,gener:[0,1,2,3,4,5,6,7,8,9,11,12,13,14,15,18,19,20],gentoo:[0,1,2,4,5,6,8,9,11,12,14,15,16,17,18,19,20],get:[0,5,6,12,13,18,20],get_event_loop:18,get_libdir:[2,8],get_nproc:[],get_path:16,get_python_inc:16,get_python_lib:16,get_udevdir:[2,8],getar:2,getcc:[2,9],getcxx:2,getfc:2,getfullargspec:16,getranlib:2,getter:[9,13,16],gettext:8,gfx:2,gh:[5,20],gi:14,git:[5,12,20],github:[0,2,4,5,6,8,12,14,17,19,20],gitlab:[2,8],give:19,given:13,glib:2,global:[0,1,5,8,13,14,18,19],gna:2,gnome2:[0,4,14],gnome2_src_configur:14,gnome2_src_instal:14,gnome2_src_prepar:14,gnome:[0,4,14],gnu:[0,2,4,5,6,8,14,19],go:[1,2,8,12,17,18],goal:[8,12,20],gobject:0,goe:[12,20],goocanva:14,good:[11,17,18,20],got:[10,13],gp:[2,8],gpl:[0,2,4,8,14,19],gpsd:[2,8],gpsd_group:[2,8],gpsd_user:[2,8],gpyutil:12,grab:[5,13],grace:2,gracefulli:[1,4,8],graph:12,greater:[5,7],greenlet:[10,18],grep:5,gross:13,group:[1,2,6,13,18],gtk2:19,gtk:14,guarante:[5,6],guess:20,gui_script:6,guid:[1,3,5,16,17],gz:[0,2,4,5,6,8,14,19,20],h:[8,9,19],ha:[2,3,5,6,7,11,12,13,14,15,16,18,20],hack:[5,6,7,13],had:2,hand:[11,13],handl:[1,4,5,6,8,13,14],handler:5,hang:8,happen:[2,3,4,6,7,8,11,12,19,20],hard:[5,8,12],hardcod:[1,12,18],harder:8,hardest:0,hardwar:11,harmless:[],has_vers:[0,12],hashtabl:5,hatchl:5,have:[0,2,3,4,5,6,7,8,9,11,12,14,15,16,18,19,20],header:[1,9],heavi:6,help:[0,5,17,20],helper:[4,5,10,14,19,20],henc:[2,5,14],hepforg:19,here:[6,8,14,19],hexvers:[11,20],high:[2,12,15,19],highlight:[0,16,19],hint:20,histor:[3,5,6,13,16],hit:16,hold:16,home:[6,12,13],homepag:[0,2,4,5,6,8,14,19],hook:5,horrend:20,host:0,hous:11,how:[5,20],howev:[1,3,5,6,7,8,9,11,12,13,15,16,18,19,20],hppa:[0,2,4,5,6,8,14,19],html:[0,5,8],http:[0,2,4,5,6,8,9,12,14,16,19,20],httpbin:[8,18],human:8,humanfriendli:5,hybrid:[5,10],hypothesi:[5,20],hz1jw:19,i18n:14,i:[3,5,6,7,11,12,14,16,18,20],ia64:[0,2,4,5,6,8,14,19],idea:20,ideal:[11,15,20],ident:5,identifi:1,idepend:0,idna:8,ignor:[3,4,5,8,18,20],imag:[5,9],imagin:8,immedi:[4,5,19],impact:16,impl:[1,5,10,13],implement:[0,1,3,4,5,6,7,10,14,17,18,19,20],impli:[2,9,11],implic:5,implicit:[14,20],implicitli:[0,3,5,8,12,19],import_modul:20,import_path:20,importerror:[5,6,10,11],importlib:[6,11,20],importlib_metadata:[4,5,6],importmod:20,importpathmismatcherror:10,improp:17,improv:[11,17],incdir:8,includ:[1,2,3,4,5,6,7,9,12,15,16,17,18,19,20],incompat:[6,11,16,18,20],inconsist:[12,20],incorrect:[5,6],increment:11,inde:13,independ:[2,5,6,7,14,19],index:[5,10],indic:[1,5,6,11,12,13,18,20],indirect:5,individu:[2,5,11,18],infer_vers:5,inflect:5,inflector:5,info:[0,6,18],inform:[1,3,5,6,10,13,16,20],inherit:[0,1,2,4,5,6,7,8,9,13,14,16,18,19],ini:[1,5,18,20],init:5,initi:20,inject:[3,5,19],inlin:[2,7,14],inplac:6,insert:16,insid:[0,1,3,5,6,9,12,14,18,19],insinto:9,inspect:5,instabl:18,instal:[0,1,3,4,7,8,10,11,12,13,15,16,18],install_requir:[1,3,5,6],instanc:[5,13],instead:[2,3,5,6,7,8,9,13,14,16,18,19,20],insuffici:18,intact:5,integr:[5,8,10,11],intend:[5,16,20],intent:18,interact:11,interest:[6,8,20],interfac:[3,6,11,16],intermedi:5,intern:10,internet:[5,10,18],interpret:[0,1,2,5,6,7,9,10,13,14,15,16,18,19],interrupt:18,interspers:6,interv:5,intro:8,introduc:[5,11],introspect:0,invalid:0,investig:8,invoc:[0,5,18],invok:[5,18,20],involv:[8,13],io:[2,4,5,8,14,19],ipaddress:11,ironpython:11,irrelev:[5,20],iso:8,isol:5,isort:20,issu:[5,6,13,16,18,20],item:20,its:[0,1,2,3,5,6,7,8,11,12,15,16,18,20],itself:[5,6,8,9,12,18],ius:[0,2,4,5,8,14,19],iwdevtool:5,j1:5,januari:13,jaraco:[3,5,12,18],java:11,javascript:11,jazzband:5,job:[2,18],jq:5,json:5,jupyt:5,jupyter_packag:5,just:[1,5,6,11,13,20],justifi:18,jython:11,k6:16,k7:16,k8:16,keep:[5,15,17],kei:[1,5,16,18,19],kept:12,kernel:14,kernel_linux:8,keyword:[0,2,4,5,6,8,10,14,16,19],kind:[1,3,5,7,9,11,20],kinet:2,kitti:9,know:[13,16,20],known:[6,16,20],kp3:16,kp4:16,kp5:16,kvm:14,kwarg:16,kwonlyarg:16,kwonlydefault:16,la:14,lack:[3,9,20],lambda:20,land:9,lang:[2,8,11,12,19],languag:[1,2,5,11,15],larg:[5,12,15,18],last:[3,5],later:11,latest:5,latter:[2,5,8,13,16,18,20],layer:[5,14],layout:[3,6,13],ldap:2,ldb:2,ldflag:[2,5],lead:20,leak:20,learn:3,least:[0,5,8,15,20],leav:6,leftov:6,legaci:[10,13,16],length:16,lenient:12,less:[3,20],let:[2,4,8,16,19],level:[3,5,9,11,20],levenshtein:8,lgpl:[0,2,5,14,19],lib64:9,lib:[2,3,5,7,9,16,18,20],libboost_python:7,libbsd:2,libcangji:14,libdir:[2,8,9],libdirnam:2,libfmt:2,libfoo:5,libimag:9,libpcap:2,libpcr:2,libpython:[7,16],librari:[0,1,2,3,4,5,8,9,11,14,19],libsecret:0,libtool:14,libudev:2,libusb:2,libx11:2,libxslt:2,licens:[0,2,4,5,6,8,10,14,19],life:10,light:1,lightweight:[4,5],like:[0,2,4,5,6,8,11,15,16,19,20],limit:[6,12,15,17],line:[0,3,5,13,15,16,19,20],link:[5,7,9,16],linker:[5,9],linkflag:2,linter:1,linux:[0,2,4,5,6,8,9,14,16,19,20],linux_distribut:11,linuxmint:0,list:[4,5,8,12,13,18],liter:[0,4,19],littl:[5,6,18],live:12,ll:[4,14],load:[3,7,9,18,20],local:[1,2,3,5,8,9,12,13,14,18,19,20],localize_pydatetim:5,locat:[3,5],lock:5,log:5,logic:[5,6,12],login:20,lollypop:4,longer:[4,5,6,13],look:[0,1,6,8,18,19,20],lookuperror:5,loop:[2,5,18],looponfail:18,lot:[11,15],lp:20,lpython3:16,lxml:8,lzma:11,m68k:[0,4,5,6,8,19],m:[5,18,20],machin:14,maco:[0,4,5,6,8,19],made:[13,14,16,19],mai:[1,3,5,6,8,12,13,15,16,18,20],main:[5,9],main_event_loop:18,maintain:[5,10,11,12,18],mainten:10,major:[4,5,6,7,11,12,20],make:[2,3,4,5,6,7,12,13,15,16,18,19,20],make_wrapp:[2,9],makefil:[5,14],makeopt:[],makeopts_job:[2,18],man:16,manag:[0,4,5,6,8,9,20],manbuild:[2,8],mani:[2,5,8,12,14,15,16,20],manipul:[5,20],manpag:5,manpow:15,manual:[2,5,6,10,12],map:[2,5,6,8,18],march:13,mark:[15,18,20],marker:[5,10],martinblech:5,mask:[12,15],master:[5,20],match:[0,2,4,5,6,8,9,11,12,15,19],matplotlib:[2,5,19],maturin:5,max_atom:2,maximum:[1,5],mayb:20,mayhem:20,md:2,me:16,mean:[0,1,2,5,7,8,11,15,16,18,19,20],meaning:6,meaningfulli:1,meant:[1,13],mechan:[5,7,11],media:[0,2,8],member:15,mere:[5,7],meson:[0,4,7,10],messag:[1,5,20],met:16,metadata:[1,5,6,14,19],method:[3,5,11,13,16,18,20],mgorni:12,microcontrol:11,micropython:11,might:18,migrat:[5,10],minfx:2,minim:[5,11,15],minimum:[0,15,19],minor:[11,20],mint:0,mip:[0,2,4,5,6,8,19],mirror:[2,4,5,6,8,14,19,20],misbehav:6,misc:[2,8],miscompil:5,miss:[3,5,6,9,10,11,12,13,17,18],mistak:5,mit:[5,6],mix:[],mkdir:12,mock:[0,4,8,11,12,18,20],mocker:18,mod:20,mode:[1,3,6,10,13],model:7,modern:[1,4,5,6,12,18,20],modif:5,modifi:[5,6,11,20],modul:[1,3,4,5,6,7,8,10,11,14,15,16,18,20],module_nam:20,modulenotfounderror:3,modulesdir:2,molecular:2,molmol:2,moment:[5,12,13,15],mongo:2,mongodb:[2,4],more:[0,1,3,4,7,9,11,12,13,16,18,19,20],most:[0,3,5,6,9,11,12,13,14,17,18,19,20],mostli:[16,17],move:[0,5,12],mozilla:5,mpi:5,mrzechonek:2,much:[2,5,7,20],multi:[1,5,10,13,19],multibuild:14,multipl:[1,3,4,5,7,10,14,17,18,20],multiprocess:18,music:4,must:[0,1,2,3,5,6,7,8,11,18,19,20],mutual:[],my_p:2,my_pn:9,mycmakearg:[9,13,19],myconf:[2,8],mydistutilsarg:13,myesconsarg:[2,8],myself:20,mysql:[4,14],n:[2,18],name:[1,2,3,4,5,6,7,8,9,10,11,14,16,20],namespac:[10,18],namespace_packag:3,nativ:11,natur:[2,5,8],nautilu:0,ncurs:[2,14],nd:2,nears:12,necessari:[0,2,5,6,8,9,11,12,13,14,15,18,19,20],need:[0,1,2,3,4,5,6,7,8,9,11,12,13,14,15,16,18,19,20],nemo:0,nest:18,net:[2,8,11,14,19],netloc:16,network:[5,6,18,20],never:[6,11,13],nevertheless:5,newer:[3,4,5,6,12,16],newli:15,newlin:16,next:[12,15,18],ninja:8,nmr:2,no_network:20,no_waf_libdir:2,nodej:5,non:[1,5,6,7,9,12,14,16,18,20],none:[2,5,6,16],nonfat:5,nonfunct:5,nongnu:[2,8],nor:[11,17],normal:[0,3,5,8,9,14,19],nose:[4,5,20],nosetest:20,nostrip:[2,8],notabl:[5,16],note:[0,1,5,6,7,8,9,10,11,13,14,15,16,18,19,20],now:[3,5,6,8,13,14,20],nowadai:[9,12,13],nox:[],noxfil:1,number:[5,7,12,18],numdifftool:2,numpi:[1,2],nurl:16,o0:20,o:[2,5],object:[2,11,16,19],obligatori:12,obsolet:[12,13],obviou:[1,20],ocassion:9,occur:[7,18],offici:5,offset:9,often:[1,5,12,20],old:[2,4,5,6,8,10,12,16,20],older:[1,11],omit:[5,15,16],ommit:1,onc:[0,5,8,11,12],one:[0,1,2,3,4,5,6,7,8,9,11,12,16,17,18,19,20],ones:12,onli:[0,1,2,3,4,5,6,7,8,9,11,12,14,16,18,19,20],opal:2,open:[2,16],openbabel:2,opendx:2,openldap:2,openvpn:9,oper:[5,17],opposit:[8,11,13],optfeatur:1,optimize_flag:2,option:[0,1,3,4,6,8,10,13,15,18,19,20],optional_packag:2,order:[0,1,2,4,5,7,9,12,13,14,15,19],org:[0,2,4,5,6,8,9,12,14,19],organ:3,orient:[2,16],origin:[5,9,11,12,16],other:[0,1,2,3,4,5,7,9,10,11,12,13,14,16,17,19,20],otherwis:[0,5,6,7,8,9],ought:16,our:[6,12,18,20],out:[8,9,10,11,12,13,14,15],outofboundstimedelta:5,output:[4,5,6,9,16,20],outsid:[14,19],over:[5,11,12,18,19,20],overrid:[5,9,14,20],own:[5,12,20],p1:16,p2:16,p:[0,2,4,5,6,8,14,18,19,20],pace:11,packag:[0,4,7,8,9,10,11,13,17,18],page:[10,16,17],panda:5,pandas_datetime_to_datetimestruct:5,parallel:10,param:[16,18],paramet:[5,8,16],parametr:18,paremet:5,parent:[3,9],pars:16,parsed_vers:5,parseresult:16,part:[2,3,4,5,7,8,9,12,13,14,15,18,20],parti:5,partial:[4,9,10,13],particular:[0,1,4,5,6,11,20],particularli:[0,6,11,13,18,20],pass:[0,6,8,9,10,12,13,16,18,20],password:4,patch:[2,5,6,8,11,12,20],path:[1,3,5,6,9,10,12,13,16,20],pathlib:[18,20],pattern:[4,12,13,19],pax:8,pbr:[5,6],pch:2,pcre:2,pdepend:[0,2,8,12],pdm:[5,13],peopl:17,pep517:[5,10],pep8:5,pep:[1,3,6,10,12,16,20],per:[3,5],perform:[0,2,5,6,11,12,14,19,20],period:13,permit:[3,4,5,6,11,15],pexpect:[0,5],pf:5,phase:[0,1,3,6,7,8,10,13,14,15,19,20],physic:[5,19],pick:12,pillow:5,pip:[5,12,20],pipelin:[2,20],pkg:9,pkg_config:2,pkg_config_path:16,pkg_postinst:[1,5],pkg_resourc:[3,6],pkg_setup:[0,1,2,8,19],pkgcheck:13,pkgconfig:[0,2,8,14],pkgutil:3,place:[1,6,11,12],placehold:13,plain:[2,5,6,13],plan:11,platform:[11,16,20],platinclud:16,platlib:16,platstdlib:16,player:[0,4],pleas:[5,6,8,9,12,15,16,18,19,20],plot:19,plu:[0,19],pluggi:20,plugin:[1,3,5,6,8,10,20],pm:6,pn:[0,2,4,5,6,8,9,14,19,20],pngcrush:2,poetri:[1,6,7,13],poetry_cor:5,point:[1,5,11,12,13,18,20],pointless:5,poisson:2,poissonboltzmann:2,polib:0,popd:20,popt:2,popul:[5,15],port:[5,8,10],portabl:3,portag:[3,5,8,12,14,15,18,20],posit:5,posixpath:18,possibl:[0,2,4,5,6,7,8,9,12,14,17,18,20],post:[5,6,13],postgr:4,potenti:[12,16,18],power:8,pp:[2,8],ppc64:[0,2,4,5,6,8,14,19],ppc:[0,2,4,5,6,8,14,19],pr:16,practic:[8,11,12],pre:5,preced:20,precis:[5,8,9],precompil:12,predict:19,prefac:10,prefer:[1,5,7,8,11,12,14,15,18,20],prefix:[2,8,9,16,20],pregener:5,prematur:15,prepar:[8,9,19],preprocessor:9,presenc:[8,18],present:[1,5,6],preserv:[6,11],presum:2,pretti:16,prevent:[4,10,11,19,20],previou:[1,5,12,13,16],previous:12,primari:[5,18],primarili:[7,11],print:[0,3,8,14,18,20],prior:[2,3,5,6,8,13,16,20],privat:13,proactiv:15,probabl:[1,6,8,13,19],problem:[1,3,4,5,6,8,10,12,16,17,18],problemat:[3,5,6,10,18],process:[3,5,12,16,19],produc:[5,12],profil:[6,15],program:[1,2,5,6,11,16,18],programm:[0,15],progress:12,proj:5,project:[0,1,5,7,8,9,10,14,17,18],prone:0,propag:19,proper:[2,8],properli:[5,6,13],properti:20,protocol:[0,2,19],prototyp:16,provid:[0,1,5,6,7,8,9,11,12,13,14,15,16,17,18,20],proxi:[3,14],psf:5,psql:14,psutil:2,pth:3,pub:2,pure:[0,5,6,7,8,10,11,15],purelib:16,purpos:[0,6,9,12,14,16,19,20],pursu:12,push:12,pushd:20,put:[1,8],pv:[0,2,4,5,8,14,19,20],pwd:12,pwman3:4,py2:[2,8,20],py3:18,py:[1,2,3,6,7,8,9,10,11,12,13,14,18,20],py_input_list:20,pyarg:20,pybytearray_check:20,pyc:[2,9],pycodestyl:5,pycountri:8,pydant:12,pydiff:8,pyduali:19,pyext:19,pygit2:20,pygobject:[0,14],pyinc:9,pylib:9,pylist_getitem:20,pymol:2,pymongo:2,pynslcd:9,pyo:[2,9],pyopenssl:8,pypa:6,pyperclip:5,pypi:[4,5,6,8,10,11,13],pyproject2setuppi:[5,6,13],pyproject2toml:6,pyproject:[1,5,7,12],pypy2:[9,11,12],pypy3:[1,4,5,6,8,11,12,13,15,18],pyroot:5,pyseri:5,pysock:8,pytabl:5,pytest:[0,4,8,10,12,20],pytest_cach:20,pytest_disable_plugin_autoload:18,pytest_fork:18,pytest_plugin:18,pytest_pyfunc_cal:20,python2:[2,8,9,13,19],python2_7:[2,5,6,8,13,14,19],python2_packag:2,python3:[1,3,5,9,11,13,16,18,20],python3_11:12,python3_5:8,python3_6:[0,2,4,8,14],python3_7:[4,8],python3_8:3,python3_:[0,1,2,4,5,6,8,12,19],python3_cmd:2,python3_packag:2,python:[3,6,17,18,20],python_:[5,8],python_cflag:16,python_check_dep:[0,2,8],python_compat:[0,2,4,5,6,8,10,12,14,15,19],python_compil:3,python_compile_al:[5,8],python_configur:2,python_configure_al:5,python_copy_sourc:[2,14],python_dep:[0,2,4,5,8,10,14,19],python_doex:9,python_dohead:9,python_domodul:[2,5,9,12,14,19],python_doscript:[9,14,19],python_export:13,python_fix_shebang:9,python_foreach_impl:[1,2,8,14],python_gen:13,python_gen_any_dep:[0,2,8],python_gen_cond_dep:[2,4,5,8,12,13,19],python_gen_impl_dep:4,python_gen_usedep:13,python_gen_useflag:8,python_get:13,python_get_cflag:9,python_get_includedir:[8,9,13],python_get_lib:9,python_get_library_path:[9,13],python_get_python_config:9,python_get_scriptdir:9,python_get_sitedir:[2,3,8,9],python_has_vers:[0,2,8],python_includedir:13,python_instal:[2,3,14],python_install_al:[3,5],python_is_python3:[8,13],python_lib:16,python_libpath:13,python_moduleinto:[2,5,9,14],python_multi_usedep:13,python_newex:9,python_newscript:9,python_optim:[2,8,9],python_pkg_dep:12,python_prepare_al:[5,18],python_req_us:[2,4,5,6,8,14,19],python_requir:1,python_required_us:[2,4,5,8,10,14,19],python_scriptinto:9,python_setup:[0,1,2,10,13,14,19],python_single_target:[7,11,12],python_single_usedep:[4,5,13,19],python_target:[5,7,8,11,12],python_test:[6,8,9,12,18,20],python_test_al:5,python_usedep:[0,2,4,5,8,10,12,14,18,19],python_wrapper_setup:13,pythonn:1,pythonpath:[6,20],pythonprop:19,pythonx_i:1,pyx:5,pyyaml:2,qa:[6,9,17],qa_flags_ignor:5,qemu:14,qemu_python_instal:14,qmp:14,qsl:19,qt:0,qualifi:7,queri:[10,16],question:[0,1,5,7,14,18,20],quick:20,quickli:5,quit:[2,4,6,11,12],quot:[4,19],r1:[1,3,4,9,10,12,20],r1_:5,r1_pkg_setup:[0,2,19],r1_python_compil:[3,5],r1_python_instal:[3,5],r1_python_install_al:[3,5],r1_python_prepare_al:[5,18],r1_src_compil:5,r1_src_configur:5,r1_src_instal:5,r1_src_prepar:[3,5,18],r1_src_test:5,r2:20,r:[0,2,5,9,20],race:10,rais:5,random:18,rang:[2,5,12],ranlib:2,rare:[9,18,20],rather:[1,6,8,16,17,18,20],rc:2,rdep:3,rdepend:[0,1,2,4,5,6,8,13,14,19],re:[5,8,15,20],reach:[12,15],read:[1,5],readabl:20,readi:[5,12,15],readlin:[2,5,8,14],readm:[2,12],readthedoc:5,real:[3,18,20],realli:[13,15,18,20],reason:[2,4,5,6,11,18,20],rebas:12,rebuild:[1,6],rebuild_swig:2,recent:[2,3,5,12,20],recip:10,recogn:[3,5,16],recommend:[2,5,7,12,13,14,16,18,19,20],recurs:[9,15,18],redefin:[5,18],reduc:5,reenabl:[12,18],refer:[0,1,5,9,11,13,14,17,19],refus:[1,11],regard:5,regener:[5,12],regress:5,regular:[7,20],reinstal:12,reject:[8,15,16],rel:[5,18,20],relat:[10,12,13,20],relax:[2,18],releas:[0,2,5,8,11,12,14,15,16],relev:[5,6,13,17,18,20],reli:[5,6,7,11,20],reliabl:[17,20],remain:[7,11,13],remaind:12,rememb:[4,12],remind:6,remot:[12,20],remov:[3,4,5,6,11,12,13,14,15,18,20],renam:[13,16],renamed_shared_librari:2,reorder:13,repeat:[7,14],repeatedli:12,replac:[0,5,6,11,12,13,16],replai:20,replic:14,repoman:13,report:[1,5,6,9,20],repositori:[0,5,6,12],repres:[3,5],reproduc:20,request:[5,8,10],requier:6,requir:[0,1,2,3,4,5,7,8,10,11,12,13,14,15,16,18,19],required_us:[0,1,2,4,5,8,13,14,19],rerun:10,rerunfailur:18,resembl:[8,18],reserv:5,resmok:2,resolv:[1,5,6,10,16,18],resourc:[6,11,12],resourcepath:5,respect:[1,3,5,12,14,18],respons:[1,5],restrict:[0,2,5,10,18,19,20],result:[0,5,6,8,9,12,16,17,18,20],retir:3,retroact:10,reus:9,revers:[5,7,12,15],revis:15,rewrit:20,rewritten:[5,19],rf:2,rich:5,right:6,riscv:[6,8,19],risk:15,riverbankcomput:8,rm:[2,3,5,9],root:[0,5,6,13,19,20],root_numpi:5,rootdir:20,rootpi:5,roughli:[2,9,12,13],round:12,routin:14,rpath:2,rpython:11,rst:5,rsync:8,ruamel:3,rule:[1,2,6,8,10,13,14,15],run:[1,2,4,6,7,8,9,10,11,12,13,14,17,20],run_in_build_dir:[2,8,14],runner:[1,5,10],runpi:20,runtim:[1,2,3,5,8,10,13,14],rust:10,s390:[0,2,4,5,6,8,19],s:[1,2,4,5,6,7,8,9,12,13,14,16,18,19,20],sabyenc3:20,sabyenc3_wrapp:20,sabyenc:20,safe:13,samba:[2,19],same:[0,2,3,4,5,6,7,8,9,11,12,13,14,16,17,18,20],sample_cod:5,sandbox:[8,20],sanit:[5,16],satisfi:[0,1,8,12],sbin:9,scan:13,schema:2,scheme:16,sci:[2,5,19],scipi:2,scm:5,scon:[7,8,10],scons_opt:2,scons_target:2,scons_var:2,sconstruct:[2,8],scop:0,scope:[1,5,8,13,18],scp:12,script:[1,2,5,6,7,8,10,11,12,14,16,19],sdist:[5,20],search:[3,10,20],second:[7,13],secondli:20,secret:0,section:[1,5,6,12,16,20],secur:12,sed:[3,5,8,14,18,20],see:[5,9,16,18,20],seem:20,select:[7,8,18,19],self:[5,16,18,20],semi:18,sens:2,separ:[2,5,6,7,8,11,14,18,20],seri:9,serial:[2,5,8],serv:13,server:[5,20],servic:[0,20],session:[3,20],set:[2,4,5,6,7,10,12,14,15,16,18,19,20],setup:[1,3,6,7,10,13,18,20],setup_requir:[1,5,18],setuptool:[1,3,4,5,7,8,12,13,15,18],setuptools_rust:5,setuptools_scm:[1,10],setuptools_scm_pretend_vers:5,sh:[0,2,4,5,6,8,12,19],share:[3,5],shebang:[1,10,11,20],shell:[0,5,8,14],shift:[6,11],ship:5,shlinkflag:2,shortli:1,should:[1,3,4,5,6,7,8,9,11,12,13,14,15,16,17,18,19,20],side:[8,11],sidebar:6,signal:[19,20],signatur:[11,16],signifi:18,signific:[12,18],silent:4,similar:[0,2,5,14,19,20],similarli:[0,1,5],simpl:[2,5,7,13,14,17],simplest:[0,2,5,14,18,20],simpli:[5,16,17,20],simultan:[5,11,17,20],sinc:[1,2,3,5,6,7,11,12,13,15,16,18,20],singl:[0,1,4,6,9,10,14,16,18,20],sip:8,sip_api_major_nr:8,siplib:8,site:[3,5,6,9,11,16,18,20],six:[4,5,8],skip:[5,8,10,12,16],skipif:20,sleep:16,slot:[0,2,4,5,6,8,11,14,19],slow:11,slowli:[12,15],smaller:5,snappi:2,snapshot:[10,20],snippet:[6,16],snowbal:2,so:[1,4,5,6,11,12,18,19,20],socks5:8,softwar:[0,1,4,8,12,14,15,16,20],solari:[0,5,6,19],sole:13,solut:[3,5,16,20],solv:[4,17],some:[0,1,2,3,4,5,6,7,8,11,12,13,14,16,18,19,20],someth:[8,9,20],sometim:[1,5,6,9,11,18,20],somewher:12,soon:15,sort:2,sound:19,sourc:[2,3,10,12,14,17,20],sourceforg:[14,19],space:20,sparc64:[0,6],sparc:[0,2,4,5,6,8,14,19],spawn:1,speak:[6,11],spec:16,special:[1,3,4,5,6,16,20],specif:[0,1,3,4,5,6,7,8,9,10,11,13,14,15,16,18,19,20],specifi:[0,1,2,5,6,7,8,14,18,19,20],speed:9,spew:20,sphinx:[1,3,6,8,10,12],sphinx_rtd_them:8,sphinxtrain:9,split:[0,5,13,16],spulec:4,spuriou:1,sqlite3:4,sqlite:[4,8],src:[2,5,9,20],src_:5,src_compil:[2,5,6,8,14],src_configur:[2,5,8,9,13,14,19],src_instal:[2,5,8,9,14,19],src_prepar:[2,3,5,8,9,14,16,18],src_test:[2,5,6,14],src_unpack:5,src_uri:[0,2,4,5,6,8,14,19,20],ssl:8,sspl:2,stabil:12,stabl:[12,15],stage:[5,12,20],stage_dir:2,stand:11,standalon:[5,12],standard:[3,4,6,7,9,10,11,14,16,20],start:[3,5,6,11,12,15,16,20],state:1,statement:5,statist:5,statsmodel:20,std:2,stdin:3,stdlib:[4,13,16],stemmer:2,step:[5,6,7,8,14],still:[1,5,6,8,11,12,13,16,20],stop:[13,16],str:16,stream:5,streamlin:13,strict:20,strictli:[3,5,6,15,20],string:[0,1,4,5,8,14,16,19],stringif:16,strip:[1,3,5,11,18,20],strongli:[5,6,15],structur:[12,20],stuff:13,style:[4,5,13,17,18,20],sub:[1,3,8,10,20],sub_instal:14,subclass:1,subdir:14,subdirectori:[6,9],submit:6,submodul:3,suboptim:17,subpackag:[3,5],subsequ:6,subset:[1,4,5,7,8,11,12,14,20],substitut:[0,4,19],subtitl:8,subtl:20,success:0,suffici:[2,5,6,7,11,14],suffix:5,suggest:[5,8,13,17,18,20],suit:[0,1,2,5,6,7,8,9,10,12,18],suitabl:[0,7,9,14,17],summar:[5,16],summari:18,sundial:2,sundri:13,superset:19,suppli:6,support:[0,1,2,3,4,5,6,7,8,10,12,13,14,16,17,18,19,20],suppos:16,supposedli:18,sure:[5,18,20],suspici:3,swig:[2,19],sy:[2,5,8,11,14,15,16,20],symbol:5,symlink:9,sync:18,syntax:[4,10,11],system:[0,3,8,9,10,13,14,15,17,19,20],system_eigen:2,system_fmt:2,system_sundi:2,systemd:20,t:[5,7,8,11,13,20],tab:5,tabl:[5,13,16,18],tag:[5,12,20],take:[0,1,2,4,5,6,7,8,9,15,18,20],taken:[5,20],talloc:[2,19],tar:[0,2,4,5,6,8,12,14,19,20],tarbal:[5,12,20],target:[2,5,8,9,11,12,15,19],task:[5,8,12],tauthon:11,tc:[2,9],tcsh:5,tdb:2,team:[12,15],technic:12,telepathi:0,tell:13,temp:20,templat:[0,2,4,5,19],temporari:[5,6],temporarili:[12,13],term:[0,2,4,5,6,8,14,19],termcolor:5,termin:[5,20],test:[0,1,2,3,4,8,10,12,13,17,19],test_arima:20,test_babel_with_language_:20,test_build_latex:20,test_client:18,test_close_to_now_:12,test_comparison:12,test_contextvar:18,test_crc_pickl:20,test_decod:20,test_empty_size_pickl:20,test_filenam:18,test_gener:18,test_leak:18,test_loc:18,test_login:20,test_network:20,test_null_byt:20,test_polyglossia_with_language_:20,test_pytest_plugin:5,test_start_params_bug:20,test_sync:18,test_sync_contextvar:18,test_test_util:5,test_testcase_no_app:5,test_transport:18,test_transport_work:18,test_wrapped_case_is_collect:18,testbitvector:5,testcas:18,tests_requir:[1,5],testsupport:20,tevent:2,text:[5,8],textual:5,tgz:14,than:[1,2,3,6,7,8,11,12,16,17,18,20],thei:[1,2,3,5,6,7,8,9,11,12,13,14,15,16,17,18,20],them:[0,1,2,3,5,6,7,8,9,12,16,18,19,20],theme:[5,6,8],themselv:[6,18,20],therefor:[1,2,5,6,7,8,11,12,15,18],thermodynam:2,thi:[0,1,2,3,4,5,6,7,8,9,11,12,13,14,15,16,17,18,19,20],thin:[5,6],thing:[12,13,17,18],think:16,third:[5,7,13],thirdli:20,those:[5,6,7,8,9,18,20],though:[8,12],thread:[2,8,18,19,20],three:[0,1,3,9,13,16],through:[3,4,5,6,8,11,16,18,20],throughout:6,thumb:[1,6,10,13,15],tiff:5,time:[1,3,4,5,6,9,10,11,12,13,16,17,18,20],timeout:20,tip:[10,20],tmp:[3,5,9,18,20],todai:16,todo:[2,9,12],toml:[1,5,7,12],tomli:12,too:[5,12,20],tool:[1,2,5,8,14,15,16,20],toolchain:[2,8],toolkit:8,top:[3,5,9,18],topic:[3,17],toward:[],tox:[1,5,20],traceback:[3,5,20],tradit:3,tradition:3,train:8,trans2arab:19,transit:[13,15],translat:8,transport:2,travel:4,travi:5,treat:[2,18],tree:[3,5,13,20],tri:5,trial:13,trigger:[6,18,20],trivial:[0,5,12,16,19],trolliu:11,tsa:20,tslib:5,tupl:16,tut:2,twice:18,two:[1,5,6,8,9,11,13,16,18,19],txt:[5,6,12,18],type:[2,3,6,13,16],typeerror:10,typic:[1,14],ubuntu:20,udev:0,udevdir:[2,8],ugli:13,unabl:[5,20],unblock:12,unbundl:12,unclear:20,uncommon:5,uncondit:[1,2,5,10,13,14],unconditioanlli:20,uncondition:[0,1,2,4,5,6,8,11,19,20],undefin:5,under:[0,1,2,3,4,5,6,8,14,19],underli:[5,6],underscor:[5,20],understand:0,understood:12,undesir:[1,18,20],unexpect:10,unexpectedli:20,unfortun:[13,18,20],unicod:16,uniqu:[5,14],unit:2,unittest:[5,11,20],univers:5,unless:[6,8,15],unlik:[3,5,6,11,15],unmask:12,unmatch:13,unnecessari:[14,19,20],unnecessarili:5,unpars:16,unpredict:5,unresolv:5,unset:6,unstabl:18,unsupport:[8,11],until:16,unusu:12,up:[6,9,12,13,14,17,18,20],updat:[4,6,9,11,12,16],upload:12,uppercas:13,upstream:[1,3,5,6,7,9,11,12,14,15,16,18,20],url:[5,16],urllib3:[8,12],urllib:16,urlpars:16,us:[1,9,10,11,12,13,15,16,20],usabl:[1,11],usag:10,usb:[2,8],use_en:19,use_pch:2,use_pep517:5,use_scon:[2,8],user:[2,3,5,6,7,8,11,12,15,18,19,20],userland:14,userland_gnu:8,userspac:2,usex:[2,5,19],usng:5,usr:[1,2,3,5,7,8,9,18,20],usual:[1,3,4,5,11,13,15,16,18,20],util:[1,2,4,5,8,9,10,12,15,18,19,20],utils_src_configur:[2,19],uucp:[2,8],v2:[0,2,4,5,6,8,14,19],v3:12,v:[2,4,5,14],valid:[1,5,8,16,20],valu:[1,5,6,9,13,18],vararg:16,variabl:[0,1,5,6,8,13,14,16,18,19],variant:[10,11,16,18],variat:10,variou:[1,5,6,9,13,16],varkw:16,vast:[5,12],vc:[5,20],ve:16,vendor:[12,13],venv:[5,6,13],verbatim:16,verbos:[0,20],veri:[3,5,6,9,11,12,17],verifi:[0,1,5,6,8,13,20],version:[1,2,3,5,6,7,8,10,12,13,15,16,17,18,20],version_info:16,via:[1,2,4,6,7,8,9,10,11,12,13,14,18,19,20],video:8,virtual:[0,2,8,14],virtualenv:[1,5,6,12,20],virtx:5,visual:2,vmd:2,vmxcap:14,voacap:19,vs:[10,13],vulnkei:9,vv:20,wa:[0,4,5,11,12,13,18,20],waf:[10,19],waf_binari:[2,19],wai:[0,5,6,9,12,13,18,20],wall:2,want:[5,6,8],warn:[2,3,5,10,16],wcwidth:5,we:[3,4,6,8,11,12,14,15,17],web:11,webencod:5,webp:5,welcom:17,well:[1,5,7,8,11,13,15],went:6,were:[0,2,3,5,8,11,12,13,16],what:16,wheel:[5,12,18],when:[0,1,2,3,4,5,6,7,8,9,11,12,13,14,15,18,19,20],whenev:[1,5,9,14,15,18,19],where:[0,3,5,6,9,12,14,19,20],whether:[0,1,5,6,7,15,18,19,20],which:[0,5,6,10,11,14,20],whitelist:5,who:[5,17],whole:[18,20],wholli:20,whom:20,whose:[1,5],why:[5,6,20],wide:[15,20],wider:2,widest:5,widget:14,wiki:[0,4,8,9,14,17],wildcard:4,window:11,wise:7,wish:[3,5,6],within:[3,5,6,12,17,20],without:[1,4,7,11,13,14,15,18],wno:2,won:8,word:5,work:[0,3,5,6,7,8,9,11,12,13,15,16,18,19,20],workaround:5,workdir:2,workflow:12,world:18,worm:16,worst:[16,20],worthwhil:[1,20],would:[0,2,11,12,14,15,16,19,20],wrap:[0,5,6,9,13],wrapper:[0,1,5,6,9,13,14,20],write:[5,6,7,12,17],written:[0,1,5,7,10,11,18],wrong:[6,13],wrongli:[5,16,20],www:[0,2,8,14,19],wx_gtk_ver:[2,19],wxpython:[2,19],x11:2,x64:[0,4,5,6,8,19],x86:[0,2,4,5,6,8,12,14,19],x86_64:5,x:[1,5,16,18,20],xbox:2,xboxdrv:2,xdg:4,xdist:[10,12,20],xfail:20,xml:[5,6],xmltodict:5,xolox:5,xvfb:5,xz:[0,4,12,14,19],y:[1,2,16],yaml:[2,3],ye:2,yet:[8,12,19],yield:16,yml:5,yoda:19,you:[1,2,3,4,5,6,7,8,9,11,12,13,14,15,16,17,18,20],your:[2,4,5,6,7,8,11,12,15,16,18,20],yourself:[2,4,20],zero:4,zip:[5,6],zlib:2,zoneinfo:4,zope:3,zsi:2,zstd:2},titles:["python-any-r1 \u2014 build-time dependency","Common basics","Integration with build systems written in Python","Advanced concepts","Advanced dependencies","distutils-r1 \u2014 standard Python build systems","distutils-r1 legacy concepts","Choosing between Python eclasses","Expert python-r1 usage","Common helper functions","Gentoo Python Guide","Python interpreters","Maintenance of Python implementations","Migration guides","python-r1 \u2014 multi-impl packages","Python package maintenance","Porting tips","Preface","pytest recipes","python-single-r1 \u2014 single-impl packages","Resolving test suite problems"],titleterms:{"1":16,"10":16,"11":16,"2":15,"3":16,"517":[5,13],"7":13,"8":[13,16],"9":16,"byte":9,"default":16,"function":[5,9],"new":[3,12,15],A:[7,19],In:6,No:16,The:[1,5],_make_test_flaki:18,abort:20,access:20,ad:[3,5,12,15],addit:[0,5,14],advanc:[3,4],altern:11,an:18,ani:[0,8],api:[5,8],ar:3,archiv:5,argument:[5,18],assert:20,asyncio:16,autodoc:5,autoload:18,automat:18,autotool:14,avoid:18,backend:5,backport:11,base64:16,base:[6,16,18],basic:[0,1,5,19],befor:[5,6],being:5,between:7,bootstrap:12,bpo43882:16,build:[0,1,2,5,6,7,8,12,13,14,19],buildapi:5,c:20,call:5,can:15,cargo:5,cffi:4,chang:[12,16],charact:16,checklist:20,choos:[7,20],co:15,combin:8,command:5,common:[1,9],compil:9,concept:[3,6],condit:[0,2,4,5,14,19],config:16,configur:16,content:10,coroutin:16,correct:20,cpython:12,cr:16,custom:5,cycl:12,cython:5,deal:20,decodestr:16,depend:[0,1,2,4,5,8,14,18,19,20],deprec:[5,16],determin:3,dev:[],differ:[6,8],directori:5,disabl:18,disjoint:8,distutil:[5,6,7,8,16],distutils_enable_test:5,distutils_use_setuptool:6,document:5,due:20,eapi:[13,15],eclass:[7,12],enabl:5,encodestr:16,entir:18,entri:6,environ:[1,20],exist:15,expert:[8,18],explicitli:18,extens:[5,20],extra:[2,20],failur:20,file:20,find:1,fix:9,fixtur:18,flag:4,flit:5,formatargspec:16,found:[16,18],from:[1,5,13],gener:16,gentoo:[3,10],getargspec:16,got:18,greenlet:4,guid:[10,13],handl:[],helper:9,hierarch:3,ht:16,hybrid:[2,19],impl:[2,7,14,19],implement:[8,9,11,12,15],importerror:20,importpathmismatcherror:18,indic:10,inform:9,initi:12,inspect:16,instal:[2,5,6,9,14,19,20],integr:2,internet:20,interpret:[4,8,11,12],keyword:18,legaci:[3,5,6],lf:16,librari:16,life:12,list:[1,16],longer:16,maintain:15,mainten:[12,15],manual:[14,19],marker:18,masonri:5,meson:2,migrat:13,miss:20,mode:[5,20],modul:9,more:5,most:1,multi:[2,7,14],multipl:[0,11,19],name:18,namespac:3,note:12,now:16,old:13,option:5,other:[6,18],out:6,packag:[1,2,3,5,6,12,14,15,16,19,20],parallel:[5,18],partial:8,pass:5,patchset:12,path:18,pep517:20,pep:[5,13],phase:5,pkg:16,pkgutil:[],plugin:18,poetri:5,point:6,port:[12,15,16],prefac:17,prevent:5,problem:20,problemat:20,profil:12,project:[6,15],pure:[2,14],py:5,pypi:[12,20],pyproject:6,pytest:[5,18],python:[0,1,2,4,5,7,8,9,10,11,12,13,14,15,16,19],python_compat:1,python_compil:5,python_configur:5,python_dep:1,python_instal:5,python_prepar:5,python_required_us:1,python_setup:8,python_test:5,python_usedep:13,queri:9,r1:[0,2,5,6,7,8,13,14,19],race:5,recip:18,regular:8,relat:7,remov:16,request:4,requir:20,rerun:18,resolv:20,restrict:8,retroact:16,rule:7,run:[5,18],runner:[18,20],runtim:[6,7,19],rust:5,scon:2,script:9,set:[0,8],setup:5,setuptool:6,setuptools_scm:5,shebang:9,singl:[2,5,7,13,19],skip:[18,20],snapshot:5,sourc:[5,6],specif:12,sphinx:5,standard:5,strip:16,structur:3,style:[],sub:5,suit:20,support:[11,15],syntax:13,sysconfig:16,system:[1,2,5,6,7,12],tabl:10,test:[5,6,15,18,20],thumb:7,time:[0,2,7,8,14,19],tip:16,toml:6,type:1,typeerror:18,uncondit:[0,19],undesir:5,unexpect:18,urlsplit:16,us:[0,2,3,4,5,6,7,8,14,18,19],usag:[5,8],util:7,variant:5,variat:6,version:[4,11],via:5,virtualx:5,vs:[6,7],waf:2,warn:18,whether:3,which:15,without:5,written:2,xdist:18}}) \ No newline at end of file +Search.setIndex({"docnames": ["any", "basic", "buildsys", "concept", "depend", "distutils", "distutils-legacy", "eclass", "expert-multi", "helper", "index", "interpreter", "interpreter-maintenance", "migration", "multi", "package-maintenance", "porting", "preface", "pytest", "single", "test"], "filenames": ["any.rst", "basic.rst", "buildsys.rst", "concept.rst", "depend.rst", "distutils.rst", "distutils-legacy.rst", "eclass.rst", "expert-multi.rst", "helper.rst", "index.rst", "interpreter.rst", "interpreter-maintenance.rst", "migration.rst", "multi.rst", "package-maintenance.rst", "porting.rst", "preface.rst", "pytest.rst", "single.rst", "test.rst"], "titles": ["python-any-r1 \u2014 build-time dependency", "Common basics", "Integration with build systems written in Python", "Advanced concepts", "Advanced dependencies", "distutils-r1 \u2014 standard Python build systems", "distutils-r1 legacy concepts", "Choosing between Python eclasses", "Expert python-r1 usage", "Common helper functions", "Gentoo Python Guide", "Python interpreters", "Maintenance of Python implementations", "Migration guides", "python-r1 \u2014 multi-impl packages", "Python package maintenance", "Porting tips", "Preface", "pytest recipes", "python-single-r1 \u2014 single-impl packages", "Resolving test suite problems"], "terms": {"The": [0, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 18, 19, 20], "eclass": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 13, 14, 17, 18, 19, 20], "enabl": [0, 4, 6, 7, 8, 10, 11, 12, 14, 15, 18], "support": [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 12, 13, 14, 16, 17, 18, 19, 20], "packag": [0, 4, 7, 8, 9, 10, 11, 13, 17, 18], "need": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 18, 19, 20], "pure": [0, 5, 6, 7, 8, 10, 11, 15], "refer": [0, 1, 5, 9, 11, 13, 14, 17, 19], "5": [0, 2, 5, 8, 9, 11, 12, 14, 16, 18, 19, 20], "defin": [0, 1, 5, 6, 11, 19], "featur": [0, 4, 5, 6, 8, 11, 12, 13, 19, 20], "thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20], "pkg_setup": [0, 1, 2, 8, 19], "phase": [0, 1, 3, 6, 7, 8, 10, 13, 14, 15, 19, 20], "It": [0, 1, 3, 4, 5, 6, 7, 9, 11, 12, 13, 14, 16, 18, 19, 20], "normal": [0, 3, 5, 8, 9, 14, 19], "call": [0, 1, 2, 3, 6, 7, 8, 9, 10, 11, 13, 14, 16, 18, 19, 20], "python_setup": [0, 1, 2, 10, 13, 14, 19], "function": [0, 1, 4, 6, 7, 8, 10, 11, 13, 14, 16, 19, 20], "order": [0, 1, 2, 4, 5, 7, 9, 12, 13, 14, 15, 19], "find": [0, 2, 3, 4, 6, 14, 18, 20], "suitabl": [0, 7, 9, 14, 17], "interpret": [0, 1, 2, 5, 6, 7, 9, 10, 13, 14, 15, 16, 18, 19], "global": [0, 1, 5, 8, 13, 14, 18, 19], "environ": [0, 5, 6, 10, 11, 13, 14, 16, 18, 19], "appropri": [0, 2, 4, 5, 6, 7, 9, 11, 12, 15, 19], "mean": [0, 1, 2, 5, 7, 8, 11, 15, 16, 18, 19, 20], "most": [0, 3, 5, 6, 9, 11, 12, 13, 14, 17, 18, 19, 20], "trivial": [0, 5, 12, 16, 19], "an": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19, 20], "autotool": [0, 5, 6, 10, 16, 19], "compat": [0, 1, 2, 4, 5, 6, 7, 9, 11, 12, 13, 16, 19], "system": [0, 3, 8, 9, 10, 13, 14, 15, 17, 19, 20], "could": [0, 2, 3, 5, 6, 8, 9, 16, 19], "look": [0, 1, 6, 8, 18, 19, 20], "like": [0, 2, 4, 5, 6, 8, 11, 15, 16, 19, 20], "follow": [0, 1, 3, 4, 5, 6, 7, 8, 9, 12, 13, 16, 17, 18, 19, 20], "copyright": [0, 2, 4, 5, 6, 8, 14, 19], "1999": [0, 2, 4, 5, 6, 8, 14, 19], "2020": [0, 2, 4, 5, 6, 8, 13, 14, 19], "gentoo": [0, 1, 2, 4, 5, 6, 8, 9, 11, 12, 14, 15, 16, 17, 18, 19, 20], "author": [0, 2, 4, 5, 6, 8, 9, 10, 12, 14, 19], "distribut": [0, 2, 4, 5, 6, 7, 8, 14, 16, 17, 19, 20], "under": [0, 1, 2, 3, 4, 5, 6, 8, 14, 19], "term": [0, 2, 4, 5, 6, 8, 14, 19], "gnu": [0, 2, 4, 5, 6, 8, 14, 19], "gener": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 18, 19, 20], "public": [0, 2, 4, 5, 6, 8, 14, 19], "licens": [0, 2, 4, 5, 6, 8, 10, 14, 19], "v2": [0, 2, 4, 5, 6, 8, 14, 19], "eapi": [0, 2, 4, 5, 6, 8, 10, 14, 19], "7": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 14, 15, 16, 18, 19, 20], "python_compat": [0, 2, 4, 5, 6, 8, 10, 12, 14, 15, 19], "python3_": [0, 1, 2, 4, 5, 6, 8, 12, 19], "6": [0, 1, 2, 4, 5, 6, 8, 11, 12, 14, 16, 18, 19, 20], "8": [0, 1, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 19, 20], "inherit": [0, 1, 2, 4, 5, 6, 7, 8, 9, 13, 14, 16, 18, 19], "descript": [0, 2, 4, 5, 6, 8, 14, 19], "A": [0, 1, 2, 4, 5, 6, 8, 10, 11, 15, 18], "repositori": [0, 5, 6, 12], "data": [0, 2, 5, 6, 9, 16, 19, 20], "file": [0, 1, 2, 3, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 16, 18, 19], "describ": [0, 6, 8, 9], "media": [0, 2, 8], "player": [0, 4], "capabl": 0, "homepag": [0, 2, 4, 5, 6, 8, 14, 19], "http": [0, 2, 4, 5, 6, 8, 9, 12, 14, 16, 19, 20], "cgit": 0, "freedesktop": 0, "org": [0, 2, 4, 5, 6, 8, 9, 12, 14, 19], "info": [0, 6, 18], "src_uri": [0, 2, 4, 5, 6, 8, 14, 19, 20], "www": [0, 2, 8, 14, 19], "softwar": [0, 1, 4, 8, 12, 14, 15, 16, 20], "pn": [0, 2, 4, 5, 6, 8, 9, 14, 19, 20], "p": [0, 2, 4, 5, 6, 8, 14, 18, 19, 20], "tar": [0, 2, 4, 5, 6, 8, 12, 14, 19, 20], "gz": [0, 2, 4, 5, 6, 8, 14, 19, 20], "bsd": [0, 2, 5, 6, 8, 14, 19], "slot": [0, 2, 4, 5, 6, 8, 11, 14, 19], "0": [0, 2, 4, 5, 6, 8, 10, 12, 14, 16, 18, 19, 20], "keyword": [0, 2, 4, 5, 6, 8, 10, 14, 16, 19], "alpha": [0, 2, 4, 5, 6, 8, 12, 14, 19], "amd64": [0, 2, 4, 5, 6, 8, 12, 14, 19], "arm": [0, 2, 4, 5, 6, 8, 19], "arm64": [0, 2, 4, 5, 6, 8, 14, 19], "hppa": [0, 2, 4, 5, 6, 8, 14, 19], "ia64": [0, 2, 4, 5, 6, 8, 14, 19], "mip": [0, 2, 4, 5, 6, 8, 19], "ppc": [0, 2, 4, 5, 6, 8, 14, 19], "ppc64": [0, 2, 4, 5, 6, 8, 14, 19], "sh": [0, 2, 4, 5, 6, 8, 12, 19], "sparc": [0, 2, 4, 5, 6, 8, 14, 19], "x86": [0, 2, 4, 5, 6, 8, 12, 14, 19], "ius": [0, 2, 4, 5, 8, 14, 19], "rdepend": [0, 1, 2, 4, 5, 6, 8, 13, 14, 19], "virtual": [0, 2, 8, 14], "udev": 0, "208": 0, "bdepend": [0, 1, 2, 5, 6, 8, 12, 14, 18, 19], "python_dep": [0, 2, 4, 5, 8, 10, 14, 19], "pkgconfig": [0, 2, 8, 14], "ebuild": [0, 1, 4, 5, 6, 7, 12, 13, 14, 15, 16, 17, 19, 20], "demonstr": [0, 19], "absolut": [0, 1, 9, 15, 19, 20], "minimum": [0, 15, 19], "work": [0, 3, 5, 6, 7, 8, 9, 11, 12, 13, 15, 16, 18, 19, 20], "code": [0, 1, 3, 5, 6, 7, 8, 9, 11, 12, 13, 14, 16, 18, 19, 20], "onli": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 14, 16, 18, 19, 20], "three": [0, 1, 3, 9, 13, 16], "highlight": [0, 16, 19], "line": [0, 3, 5, 13, 15, 16, 19, 20], "ar": [0, 1, 2, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20], "specif": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 18, 19, 20], "plu": [0, 19], "implicitli": [0, 3, 5, 8, 12, 19], "export": [0, 1, 2, 5, 19], "when": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 18, 19, 20], "other": [0, 1, 2, 3, 4, 5, 7, 9, 10, 11, 12, 13, 14, 16, 17, 19, 20], "declar": [0, 1, 2, 5, 6, 8, 9, 12, 14, 18, 19], "ensur": [0, 1, 5, 6, 9, 14, 19], "would": [0, 2, 11, 12, 14, 15, 16, 19, 20], "built": [0, 1, 3, 5, 6, 7, 8, 11, 12, 14, 17, 19, 20], "against": [0, 4, 7, 9, 11, 12, 14, 19, 20], "implement": [0, 1, 3, 4, 5, 6, 7, 10, 14, 17, 18, 19, 20], "specifi": [0, 1, 2, 5, 6, 7, 8, 14, 18, 19, 20], "get": [0, 5, 6, 12, 13, 18, 20], "replac": [0, 5, 6, 11, 12, 13, 16], "python_gen_any_dep": [0, 2, 8], "match": [0, 2, 4, 5, 6, 8, 9, 11, 12, 15, 19], "python_check_dep": [0, 2, 8], "accept": [0, 1, 5, 6, 9, 12, 15, 16, 18], "templat": [0, 2, 4, 5, 19], "where": [0, 3, 5, 6, 9, 12, 14, 19, 20], "liter": [0, 4, 19], "python_usedep": [0, 2, 4, 5, 8, 10, 12, 14, 18, 19], "substitut": [0, 4, 19], "requir": [0, 1, 2, 3, 4, 5, 7, 8, 10, 11, 12, 13, 14, 15, 16, 18, 19], "all": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 18, 19, 20], "same": [0, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 16, 17, 18, 20], "least": [0, 5, 8, 15, 20], "one": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 16, 17, 18, 19, 20], "test": [0, 1, 2, 3, 4, 8, 10, 12, 13, 17, 19], "whether": [0, 1, 5, 6, 7, 15, 18, 19, 20], "question": [0, 1, 5, 7, 14, 18, 20], "In": [0, 1, 2, 3, 4, 5, 7, 8, 10, 11, 12, 14, 16, 18, 19, 20], "particular": [0, 1, 4, 5, 6, 11, 20], "verifi": [0, 1, 5, 6, 8, 13, 20], "branch": [0, 16, 20], "wa": [0, 4, 5, 11, 12, 13, 18, 20], "satisfi": [0, 1, 8, 12], "were": [0, 2, 3, 5, 8, 11, 12, 13, 16], "instal": [0, 1, 3, 4, 7, 8, 10, 11, 12, 13, 15, 16, 18], "current": [0, 5, 6, 11, 12, 13, 15, 18, 20], "For": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 16, 18, 20], "purpos": [0, 6, 9, 12, 14, 16, 19, 20], "variabl": [0, 1, 5, 6, 8, 13, 14, 16, 18, 19], "string": [0, 1, 4, 5, 8, 14, 16, 19], "best": [0, 5, 12, 16, 17, 18], "explain": [0, 1, 6], "exampl": [0, 4, 5, 6, 7, 8, 9, 11, 12, 16, 17, 18, 19, 20], "meson": [0, 4, 7, 10], "manag": [0, 4, 5, 6, 8, 9, 20], "cinnamon": 0, "fork": [0, 11, 12, 20], "from": [0, 2, 3, 4, 6, 7, 8, 10, 11, 12, 14, 15, 16, 18, 19, 20], "nautilu": 0, "develop": [0, 1, 7, 11, 12, 15, 17, 18, 20], "linuxmint": 0, "com": [0, 2, 4, 5, 6, 8, 12, 14, 16, 20], "project": [0, 1, 5, 7, 8, 9, 10, 14, 17, 18], "html": [0, 5, 8], "github": [0, 2, 4, 5, 6, 8, 12, 14, 17, 19, 20], "nemo": 0, "archiv": [0, 2, 4, 10, 19, 20], "pv": [0, 2, 4, 5, 8, 14, 19, 20], "gpl": [0, 2, 4, 8, 14, 19], "2": [0, 2, 3, 4, 5, 8, 9, 10, 11, 12, 13, 14, 16, 17, 19, 20], "lgpl": [0, 2, 5, 14, 19], "fdl": [0, 19], "1": [0, 2, 3, 4, 5, 6, 8, 9, 12, 18, 19, 20], "dev": [0, 1, 2, 3, 4, 5, 6, 7, 8, 11, 12, 13, 14, 15, 18, 19, 20], "polib": 0, "pygobject": [0, 14], "3": [0, 2, 3, 4, 5, 6, 8, 9, 10, 11, 12, 13, 14, 15, 17, 18, 19, 20], "python_has_vers": [0, 2, 8], "provid": [0, 1, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 20], "its": [0, 1, 2, 3, 5, 6, 7, 8, 11, 12, 15, 16, 18, 20], "both": [0, 1, 3, 5, 6, 7, 8, 12, 13, 16, 17, 18, 19, 20], "have": [0, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 14, 15, 16, 18, 19, 20], "dep": [0, 5, 13, 15, 18], "true": [0, 1, 2, 5, 6, 8, 12, 13, 16, 20], "them": [0, 1, 2, 3, 5, 6, 7, 8, 9, 12, 16, 18, 19, 20], "while": [0, 2, 3, 4, 5, 6, 7, 8, 11, 12, 14, 16, 17, 18, 19, 20], "which": [0, 5, 6, 10, 11, 14, 20], "wrapper": [0, 1, 5, 6, 9, 13, 14, 20], "help": [0, 5, 17, 20], "take": [0, 1, 2, 4, 5, 6, 7, 8, 9, 15, 18, 20], "singl": [0, 1, 4, 6, 9, 10, 14, 16, 18, 20], "option": [0, 1, 3, 4, 6, 8, 10, 13, 15, 18, 19, 20], "class": [0, 1, 5, 16, 18], "flag": [0, 1, 5, 7, 8, 9, 10, 11, 12, 14, 15, 19, 20], "more": [0, 1, 3, 4, 7, 9, 11, 12, 13, 16, 18, 19, 20], "similarli": [0, 1, 5], "has_vers": [0, 12], "root": [0, 5, 6, 13, 19, 20], "can": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 16, 18, 19, 20], "b": 0, "d": [0, 2, 3, 5, 8, 9, 14, 18], "r": [0, 2, 5, 9, 20], "idepend": 0, "pdepend": [0, 2, 8, 12], "pass": [0, 6, 8, 9, 10, 12, 13, 16, 18, 20], "assum": [0, 1, 5, 6, 9, 13, 19], "verbos": [0, 20], "print": [0, 3, 8, 14, 18, 20], "check": [0, 5, 6, 9, 12, 13, 16, 17, 20], "perform": [0, 2, 5, 6, 11, 12, 14, 19, 20], "result": [0, 5, 6, 8, 9, 12, 16, 17, 18, 20], "return": [0, 2, 8, 16, 20], "success": 0, "found": [0, 1, 3, 5, 6, 9, 10, 15, 20], "fals": [0, 2, 5, 8, 12, 16], "otherwis": [0, 5, 6, 7, 8, 9], "note": [0, 1, 5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 18, 19, 20], "invoc": [0, 5, 18], "chain": 0, "abov": [0, 1, 6, 8, 12, 13, 15, 19, 20], "also": [0, 1, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 16, 18, 20], "written": [0, 1, 5, 7, 10, 11, 18], "import": [0, 1, 3, 4, 5, 6, 7, 11, 12, 13, 14, 16, 18, 20], "understand": 0, "correctli": [0, 1, 5, 6, 7, 9, 11, 12, 13, 16, 20], "exactli": [0, 7], "furthermor": [0, 2, 5], "combin": [0, 2, 5, 10, 11, 12, 13, 17, 18, 19, 20], "must": [0, 1, 2, 3, 5, 6, 7, 8, 11, 18, 19, 20], "onc": [0, 5, 8, 11, 12], "invalid": 0, "split": [0, 5, 13, 16], "some": [0, 1, 2, 3, 4, 5, 6, 7, 8, 11, 12, 13, 14, 16, 18, 19, 20], "necessari": [0, 2, 5, 6, 8, 9, 11, 12, 13, 14, 15, 18, 19, 20], "particularli": [0, 6, 11, 13, 18, 20], "common": [0, 3, 5, 6, 7, 10, 11, 12, 13, 16, 17, 18, 19, 20], "suit": [0, 1, 2, 5, 6, 7, 8, 9, 10, 12, 18], "case": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 16, 18, 19, 20], "wrap": [0, 5, 6, 9, 13], "programm": [0, 15], "complet": [0, 5, 16, 17], "bash": [0, 5, 7, 8, 9, 19], "scop": 0, "releas": [0, 2, 5, 8, 11, 12, 14, 15, 16], "download": [0, 2, 5, 8, 14], "xz": [0, 4, 12, 14, 19], "s390": [0, 2, 4, 5, 6, 8, 19], "linux": [0, 2, 4, 5, 6, 8, 9, 14, 16, 19, 20], "maco": [0, 4, 5, 6, 8, 19], "x64": [0, 4, 5, 6, 8, 19], "m68k": [0, 4, 5, 6, 8, 19], "mint": 0, "solari": [0, 5, 6, 19], "sparc64": [0, 6], "restrict": [0, 2, 5, 10, 18, 19, 20], "app": [0, 2, 4, 5, 8, 12, 14, 15], "shell": [0, 5, 8, 14], "4": [0, 3, 5, 8, 9, 10, 11, 12, 14, 20], "3_p30": 0, "pexpect": [0, 5], "pytest": [0, 4, 8, 10, 12, 20], "r1_pkg_setup": [0, 2, 19], "anoth": [0, 8, 9, 14, 16, 18, 20], "possibl": [0, 2, 4, 5, 6, 7, 8, 9, 12, 14, 17, 18, 20], "uncondition": [0, 1, 2, 4, 5, 6, 8, 11, 19, 20], "condition": [0, 1, 2, 5, 7, 11, 12, 14, 15, 18, 19], "simplest": [0, 2, 5, 14, 18, 20], "wai": [0, 5, 6, 9, 12, 13, 18, 20], "achiev": [0, 8, 11, 16], "block": [0, 8, 13, 20], "express": [0, 8, 13, 19], "similar": [0, 2, 5, 14, 19, 20], "cmake": [0, 6, 19], "qt": 0, "bind": [0, 2, 5, 8, 14, 19], "telepathi": 0, "bu": 0, "protocol": [0, 2, 19], "dbu": [0, 2], "hardest": 0, "differ": [0, 1, 3, 5, 9, 10, 11, 16, 18, 20], "do": [0, 1, 3, 4, 5, 6, 8, 9, 11, 12, 14, 15, 17, 18, 19, 20], "error": [0, 2, 5, 9, 13, 16, 18, 20], "prone": 0, "move": [0, 5, 12], "insid": [0, 1, 3, 5, 6, 9, 12, 14, 18, 19], "python3_6": [0, 2, 4, 8, 14], "gnome2": [0, 4, 14], "gobject": 0, "librari": [0, 1, 2, 3, 4, 5, 8, 9, 11, 14, 19], "access": [0, 5, 10, 11, 18], "secret": 0, "servic": [0, 20], "api": [0, 2, 7, 9, 10, 11, 13, 14, 16], "wiki": [0, 4, 8, 9, 14, 17], "gnome": [0, 4, 14], "libsecret": 0, "apach": [0, 2, 4, 5, 8], "introspect": 0, "fail": [0, 1, 2, 5, 8, 9, 11, 12, 16, 18, 20], "bug": [0, 5, 6, 12, 20], "655482": 0, "required_us": [0, 1, 2, 4, 5, 8, 13, 14, 19], "mock": [0, 4, 8, 11, 12, 18, 20], "fi": [0, 2, 5, 8, 12, 14, 19], "host": 0, "variou": [1, 5, 6, 9, 13, 16], "r1": [1, 3, 4, 9, 10, 12, 20], "try": [1, 6, 8, 9, 11, 20], "design": [1, 19], "you": [1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 20], "probabl": [1, 6, 8, 13, 19], "us": [1, 9, 10, 11, 12, 13, 15, 16, 20], "than": [1, 2, 3, 6, 7, 8, 11, 12, 16, 17, 18, 20], "so": [1, 4, 5, 6, 11, 12, 18, 19, 20], "worthwhil": [1, 20], "shortli": 1, "bit": [1, 12, 17], "well": [1, 5, 7, 8, 11, 13, 15], "non": [1, 5, 6, 7, 9, 12, 14, 16, 18, 20], "obviou": [1, 20], "between": [1, 5, 8, 10, 11, 12, 13, 16], "befor": [1, 4, 8, 9, 10, 12, 14, 16, 20], "thei": [1, 2, 3, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 20], "valid": [1, 5, 8, 16, 20], "valu": [1, 5, 6, 9, 13, 18], "pythonx_i": 1, "cpython": [1, 4, 5, 9, 11, 13], "x": [1, 5, 16, 18, 20], "y": [1, 2, 16], "pypy3": [1, 4, 5, 6, 8, 11, 12, 13, 15, 18], "typic": [1, 14], "ani": [1, 2, 3, 5, 6, 7, 10, 14, 16, 18, 20], "respons": [1, 5], "explicitli": [1, 5, 7, 8, 10, 13, 20], "put": [1, 8], "correct": [1, 5, 6, 9, 10, 18, 19], "meant": [1, 13], "consist": [1, 6, 9, 13, 14, 15], "cover": [1, 5, 6, 13], "time": [1, 3, 4, 5, 6, 9, 10, 11, 12, 13, 16, 17, 18, 20], "runtim": [1, 2, 3, 5, 8, 10, 13, 14], "form": [1, 4, 12, 17], "doe": [1, 2, 3, 5, 6, 8, 9, 11, 12, 14, 15, 16, 18, 20], "appli": [1, 4, 5, 6, 7, 12, 15, 18, 19, 20], "distutil": [1, 3, 4, 10, 13, 14, 18, 19, 20], "assign": 1, "default": [1, 2, 5, 6, 7, 8, 9, 12, 13, 14, 15, 18, 19, 20], "commonli": [1, 2, 3, 5, 6, 9, 11], "concept": [1, 5, 10], "state": 1, "enforc": [1, 4, 5, 7, 8, 11, 18], "whenev": [1, 5, 9, 14, 15, 18, 19], "run": [1, 2, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 17, 20], "two": [1, 5, 6, 8, 9, 11, 13, 16, 18, 19], "being": [1, 3, 6, 7, 8, 9, 10, 11, 12, 15, 16, 18, 20], "epython": [1, 2, 5, 8, 9, 12, 13, 18, 20], "contain": [1, 3, 4, 5, 6, 7, 12, 13], "s": [1, 2, 4, 5, 6, 7, 8, 9, 12, 13, 14, 16, 18, 19, 20], "basenam": 1, "identifi": 1, "e": [1, 2, 3, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 18, 19, 20], "g": [1, 2, 3, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 18, 19, 20], "python3": [1, 3, 5, 9, 11, 13, 16, 18, 20], "10": [1, 4, 5, 8, 10, 12], "final": [1, 2, 4, 5, 9, 12, 13, 16, 19, 20], "path": [1, 3, 5, 6, 9, 10, 12, 13, 16, 20], "usr": [1, 2, 3, 5, 7, 8, 9, 18, 20], "bin": [1, 2, 7, 8, 9, 12, 19, 20], "full": [1, 2, 4, 5, 7, 13, 20], "should": [1, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20], "embed": [1, 2, 9, 11], "program": [1, 2, 5, 6, 11, 16, 18], "shebang": [1, 10, 11, 20], "spawn": 1, "dure": [1, 6, 7, 12, 13, 18], "prefer": [1, 5, 7, 8, 11, 12, 14, 15, 18, 20], "rather": [1, 6, 8, 16, 17, 18, 20], "bypass": 1, "virtualenv": [1, 5, 6, 12, 20], "creat": [1, 3, 4, 5, 6, 7, 12, 13, 16], "pep": [1, 3, 6, 10, 12, 16, 20], "517": [1, 3, 6, 10, 12, 20], "mode": [1, 3, 6, 10, 13], "mai": [1, 3, 5, 6, 8, 12, 13, 15, 16, 18, 20], "caus": [1, 4, 5, 8, 9, 13, 18, 20], "failur": [1, 5, 10, 12, 18], "modul": [1, 3, 4, 5, 6, 7, 8, 10, 11, 14, 15, 16, 18, 20], "previou": [1, 5, 12, 13, 16], "version": [1, 2, 3, 5, 6, 7, 8, 10, 12, 13, 15, 16, 17, 18, 20], "just": [1, 5, 6, 11, 13, 20], "resolv": [1, 5, 6, 10, 16, 18], "problem": [1, 3, 4, 5, 6, 8, 10, 12, 16, 17, 18], "pythonn": 1, "tool": [1, 2, 5, 8, 14, 15, 16, 20], "etc": 1, "via": [1, 2, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 18, 19, 20], "exec": [1, 8, 9, 11, 12, 20], "hardcod": [1, 12, 18], "either": [1, 2, 5, 7, 8, 9, 11, 13, 18, 20], "establish": [1, 5, 13, 20], "local": [1, 2, 3, 5, 8, 9, 12, 13, 14, 18, 19, 20], "scope": [1, 5, 8, 13, 18], "multi": [1, 5, 10, 13, 19], "impl": [1, 5, 10, 13], "python_foreach_impl": [1, 2, 8, 14], "sub": [1, 3, 8, 10, 20], "setup": [1, 3, 6, 7, 10, 13, 18, 20], "done": [1, 5, 6, 8, 9, 12, 14, 18, 20], "directli": [1, 5, 6, 7, 9, 11, 13, 16, 18, 20], "section": [1, 5, 6, 12, 16, 20], "focu": [1, 12, 14], "often": [1, 5, 12, 20], "extern": [1, 2, 5, 6, 7, 11, 12], "languag": [1, 2, 5, 11, 15], "usual": [1, 3, 4, 5, 11, 13, 15, 16, 18, 20], "rule": [1, 2, 6, 8, 10, 13, 14, 15], "classifi": [1, 6], "categori": 1, "present": [1, 5, 6], "script": [1, 2, 5, 6, 7, 8, 10, 11, 12, 14, 16, 19], "usabl": [1, 11], "whose": [1, 5], "therefor": [1, 2, 5, 6, 7, 8, 11, 12, 15, 18], "howev": [1, 3, 5, 6, 7, 8, 9, 11, 12, 13, 15, 16, 18, 19, 20], "modern": [1, 4, 5, 6, 12, 18, 20], "base": [1, 5, 8, 10, 12, 14, 15, 19, 20], "entri": [1, 5, 18], "point": [1, 5, 11, 12, 13, 18, 20], "refus": [1, 11], "place": [1, 6, 11, 12], "special": [1, 3, 4, 5, 6, 16, 20], "subclass": 1, "extra": [1, 5, 6, 10], "still": [1, 5, 6, 8, 11, 12, 13, 16, 20], "meaningfulli": 1, "handl": [1, 4, 5, 6, 8, 13, 14], "gracefulli": [1, 4, 8], "subset": [1, 4, 5, 7, 8, 11, 12, 14, 20], "without": [1, 4, 7, 11, 13, 14, 15, 18], "There": [1, 3, 5, 8, 9, 16, 18, 20], "multipl": [1, 3, 4, 5, 7, 10, 14, 17, 18, 20], "approach": [1, 5, 8], "ad": [1, 10, 11, 13, 14, 18], "consid": [1, 2, 3, 6, 7, 8, 12, 14, 16], "light": 1, "enough": [1, 5], "inform": [1, 3, 5, 6, 10, 13, 16, 20], "messag": [1, 5, 20], "pkg_postinst": [1, 5], "util": [1, 2, 4, 5, 8, 9, 10, 12, 15, 18, 19, 20], "optfeatur": 1, "cheap": 1, "rebuild": [1, 6], "includ": [1, 2, 3, 4, 5, 6, 7, 9, 12, 15, 16, 17, 18, 19, 20], "__init__": [1, 3, 5, 9, 18, 20], "py": [1, 2, 3, 6, 7, 8, 9, 10, 11, 12, 13, 14, 18, 20], "As": [1, 3, 5, 6, 7, 8, 11, 13, 15, 16, 18, 19, 20], "thumb": [1, 6, 10, 13, 15], "belong": [1, 20], "care": [1, 2, 5, 7, 9, 15, 20], "addit": [1, 2, 4, 6, 8, 9, 10, 11, 12, 13, 18, 20], "plugin": [1, 3, 5, 6, 8, 10, 20], "setuptools_scm": [1, 10], "document": [1, 2, 8, 10, 11, 14, 17, 20], "former": [1, 5, 8, 13, 16, 20], "runner": [1, 5, 10], "sinc": [1, 2, 3, 5, 6, 7, 11, 12, 13, 15, 16, 18, 20], "sometim": [1, 5, 6, 9, 11, 18, 20], "These": [1, 6, 7, 12, 13, 18, 20], "go": [1, 2, 8, 12, 17, 18], "doc": [1, 2, 5, 8, 19], "respect": [1, 3, 5, 12, 14, 18], "maximum": [1, 5], "coverag": [1, 5, 15, 18], "further": [1, 18], "guid": [1, 3, 5, 16, 17], "linter": 1, "report": [1, 5, 6, 9, 20], "actual": [1, 5, 6, 7, 8, 9, 11, 12, 18, 20], "undesir": [1, 18, 20], "again": [1, 2, 20], "conveni": [1, 4, 5, 6, 18, 20], "add": [1, 2, 5, 6, 8, 12, 15, 19, 20], "sphinx": [1, 3, 6, 8, 10, 12], "copi": [1, 3, 5, 6, 9, 11, 19], "c": [1, 2, 5, 6, 8, 9, 10, 14], "extens": [1, 6, 7, 8, 9, 10, 11, 14, 15, 16], "header": [1, 9], "numpi": [1, 2], "If": [1, 2, 3, 4, 5, 6, 7, 8, 9, 11, 12, 13, 14, 15, 16, 18, 19, 20], "metadata": [1, 5, 6, 14, 19], "pyproject": [1, 5, 7, 12], "toml": [1, 5, 7, 12], "setuptool": [1, 3, 4, 5, 7, 8, 12, 13, 15, 18], "cfg": [1, 3, 5, 6, 18], "custom": [1, 2, 6, 10, 13, 18], "read": [1, 5], "name": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 14, 16, 20], "uncondit": [1, 2, 5, 10, 13, 14], "upstream": [1, 3, 5, 6, 7, 9, 11, 12, 14, 15, 16, 18, 20], "spuriou": 1, "strip": [1, 3, 5, 11, 18, 20], "ommit": 1, "kei": [1, 5, 16, 18, 19], "kind": [1, 3, 5, 7, 9, 11, 20], "621": 1, "older": [1, 11], "flit": [1, 6, 7, 12, 13], "poetri": [1, 6, 7, 13], "indic": [1, 5, 6, 11, 12, 13, 18, 20], "install_requir": [1, 3, 5, 6], "group": [1, 2, 6, 13, 18], "extras_requir": [1, 5], "setup_requir": [1, 5, 18], "deprec": [1, 3, 10, 11, 13], "tests_requir": [1, 5], "tox": [1, 5, 20], "ini": [1, 5, 18, 20], "noxfil": 1, "python_requir": 1, "besid": [2, 6, 7, 11, 14, 18], "few": [2, 4, 6, 12, 18, 20], "make": [2, 3, 4, 5, 6, 7, 12, 13, 15, 16, 18, 19, 20], "proper": [2, 8], "fairli": [2, 15, 19], "recent": [2, 3, 5, 12, 20], "agnost": 2, "henc": [2, 5, 14], "treat": [2, 18], "arbitrari": [2, 13], "ha": [2, 3, 5, 6, 7, 11, 12, 13, 14, 15, 16, 18, 20], "gain": [2, 18], "quit": [2, 4, 6, 11, 12], "At": [2, 5, 12, 15, 17], "mani": [2, 5, 8, 12, 14, 15, 16, 20], "old": [2, 4, 5, 6, 8, 10, 12, 16, 20], "reason": [2, 4, 5, 6, 11, 18, 20], "suffici": [2, 5, 6, 7, 11, 14], "prior": [2, 3, 5, 6, 8, 13, 16, 20], "happen": [2, 3, 4, 6, 7, 8, 11, 12, 19, 20], "natur": [2, 5, 8], "sort": 2, "latter": [2, 5, 8, 13, 16, 18, 20], "set": [2, 4, 5, 6, 7, 10, 12, 14, 15, 16, 18, 19, 20], "much": [2, 5, 7, 20], "compon": [2, 3, 8, 11, 14, 16], "account": [2, 5, 8, 20], "detail": [2, 7, 9, 11, 13, 16, 20], "choic": [2, 6, 13, 20], "chapter": [2, 8, 9], "along": [2, 5, 6, 7, 11, 13, 19, 20], "toolchain": [2, 8], "func": [2, 8], "commit": [2, 20], "6e5e8a57628095d8d0c8bbb38187afb0f3a42112": 2, "userspac": 2, "xbox": 2, "360": 2, "control": [2, 4, 5, 18], "driver": 2, "xboxdrv": 2, "gitlab": [2, 8], "io": [2, 4, 5, 8, 14, 19], "chewi": 2, "workdir": 2, "lib": [2, 3, 5, 7, 9, 16, 18, 20], "boost": [2, 7], "glib": 2, "sy": [2, 5, 8, 11, 14, 15, 16, 20], "libudev": 2, "libusb": 2, "x11": 2, "libx11": 2, "src_compil": [2, 5, 6, 8, 14], "escon": 2, "cxx": 2, "tc": [2, 9], "getcxx": 2, "getar": 2, "ranlib": 2, "getranlib": 2, "cxxflag": 2, "wall": 2, "linkflag": 2, "ldflag": [2, 5], "src_instal": [2, 5, 8, 9, 14, 19], "dobin": [2, 9], "doman": 2, "dodoc": [2, 5], "new": [2, 5, 6, 9, 10, 11, 13, 16, 18], "readm": [2, 12], "md": 2, "todo": [2, 9, 12], "yourself": [2, 4, 20], "becaus": [2, 5, 6, 15, 18, 20], "cannot": [2, 4, 5, 9, 11, 20], "my_p": 2, "src": [2, 5, 9, 20], "_rc": 2, "rc": 2, "high": [2, 12, 15, 19], "open": [2, 16], "sourc": [2, 3, 10, 12, 14, 17, 20], "schema": 2, "free": [2, 15, 20], "orient": [2, 16], "databas": [2, 4], "mongodb": [2, 4], "fastdl": 2, "sspl": 2, "acct": 2, "user": [2, 3, 5, 6, 7, 8, 11, 12, 15, 18, 19, 20], "arch": [2, 8, 12], "snappi": 2, "cpp": 2, "yaml": [2, 3], "70": 2, "thread": [2, 8, 18, 19, 20], "libpcr": 2, "42": 2, "zstd": 2, "snowbal": 2, "stemmer": 2, "net": [2, 8, 11, 14, 19], "libpcap": 2, "zlib": 2, "11": [2, 5, 10, 12, 20], "pymongo": 2, "cheetah3": 2, "psutil": 2, "pyyaml": 2, "type": [2, 3, 6, 13, 16], "ncurs": [2, 14], "readlin": [2, 5, 8, 14], "admin": [2, 8], "mongo": 2, "src_configur": [2, 5, 8, 9, 13, 14, 19], "scons_opt": 2, "cc": [2, 9], "getcc": [2, 9], "disabl": [2, 5, 8, 10, 12, 14, 19, 20], "warn": [2, 3, 5, 10, 16], "pcre": 2, "core": [2, 5, 20], "src_test": [2, 5, 6, 14], "buildscript": 2, "resmok": 2, "dbpathprefix": 2, "job": [2, 18], "makeopts_job": [2, 18], "die": [2, 3, 5, 8, 9, 14, 18, 20], "nostrip": [2, 8], "prefix": [2, 8, 9, 16, 20], "ed": [2, 9, 15], "everyth": [2, 13], "your": [2, 4, 5, 6, 7, 8, 11, 12, 15, 16, 18, 20], "python2_7": [2, 5, 6, 8, 13, 14, 19], "eutil": 2, "molecular": 2, "dynam": 2, "nmr": 2, "analysi": [2, 19], "relax": [2, 18], "gna": 2, "bz2": [2, 8, 19], "python_required_us": [2, 4, 5, 8, 10, 14, 19], "python_gen_cond_dep": [2, 4, 5, 8, 12, 13, 19], "numdifftool": 2, "matplotlib": [2, 5, 19], "python2": [2, 8, 9, 13, 19], "wxpython": [2, 19], "wx_gtk_ver": [2, 19], "sci": [2, 5, 19], "chemistri": 2, "pymol": 2, "bmrblib": 2, "minfx": 2, "scipi": 2, "molmol": 2, "vmd": 2, "visual": 2, "grace": 2, "opendx": 2, "gfx": 2, "pngcrush": 2, "python_moduleinto": [2, 5, 9, 14], "python_domodul": [2, 5, 9, 12, 14, 19], "make_wrapp": [2, 9], "python_get_sitedir": [2, 3, 8, 9], "part": [2, 3, 4, 5, 7, 8, 9, 12, 13, 14, 15, 18, 20], "That": [2, 16, 20], "fortran_need": 2, "fortran": 2, "fortran_standard": 2, "90": [2, 14], "object": [2, 11, 16, 19], "chemic": 2, "kinet": 2, "thermodynam": 2, "transport": 2, "cantera": 2, "v": [2, 4, 5, 14], "pch": 2, "sundial": 2, "eigen": 2, "libfmt": 2, "cython": [2, 10, 14, 19], "2_pkg_setup": 2, "scons_var": 2, "cc_flag": 2, "cxx_flag": 2, "std": 2, "debug": 2, "getfc": 2, "fortranflag": 2, "optimize_flag": 2, "wno": 2, "inlin": [2, 7, 14], "renamed_shared_librari": 2, "use_pch": 2, "usex": [2, 5, 19], "system_fmt": 2, "system_sundi": 2, "system_eigen": 2, "env_var": 2, "extra_inc_dir": 2, "eigen3": 2, "scons_target": 2, "f90_interfac": 2, "n": [2, 18], "python2_packag": 2, "none": [2, 5, 6, 16], "python3_packag": 2, "python3_cmd": 2, "els": [2, 8, 11, 16], "stage_dir": 2, "libdirnam": 2, "get_libdir": [2, 8], "python_optim": [2, 8, 9], "deal": [2, 7, 8, 10, 15], "sens": 2, "plain": [2, 5, 6, 13], "loop": [2, 5, 18], "autom": 2, "pipelin": [2, 20], "poisson": 2, "boltzmann": 2, "electrostat": 2, "calcul": 2, "poissonboltzmann": 2, "apb": 2, "opal": 2, "openbabel": 2, "zsi": 2, "lang": [2, 8, 11, 12, 19], "swig": [2, 19], "src_prepar": [2, 3, 5, 8, 9, 14, 16, 18], "f": [2, 9], "pyc": [2, 9], "o": [2, 5], "pyo": [2, 9], "delet": [2, 3, 14], "eappli": 2, "patch": [2, 5, 6, 8, 11, 12, 20], "eapply_us": 2, "rm": [2, 3, 5, 9], "rf": 2, "python_copy_sourc": [2, 14], "python_configur": 2, "cat": [2, 5], "build_dir": [2, 3, 5, 14, 20], "build_config": 2, "eof": [2, 5], "eprefix": [2, 8, 9], "max_atom": 2, "10000": 2, "build_pdb2pka": 2, "rebuild_swig": 2, "run_in_build_dir": [2, 8, 14], "python_instal": [2, 3, 14], "cd": [2, 5, 9, 12, 20], "let": [2, 4, 8, 16, 19], "independ": [2, 5, 6, 7, 14, 19], "separ": [2, 5, 6, 7, 8, 11, 14, 18, 20], "presum": 2, "manual": [2, 5, 6, 10, 12], "wider": 2, "target": [2, 5, 8, 9, 11, 12, 15, 19], "rang": [2, 5, 12], "recommend": [2, 5, 7, 12, 13, 14, 16, 18, 19, 20], "gp": [2, 8], "daemon": [2, 8], "usb": [2, 8], "serial": [2, 5, 8], "devic": [2, 8], "map": [2, 5, 6, 8, 18], "client": [2, 8, 9, 11, 14], "gpsd": [2, 8], "mirror": [2, 4, 5, 6, 8, 14, 19, 20], "nongnu": [2, 8], "24": [2, 8, 18, 20], "misc": [2, 8], "pp": [2, 8], "20120407": [2, 8], "myesconsarg": [2, 8], "libdir": [2, 8, 9], "udevdir": [2, 8], "get_udevdir": [2, 8], "chrpath": [2, 8], "gpsd_user": [2, 8], "gpsd_group": [2, 8], "uucp": [2, 8], "manbuild": [2, 8], "use_scon": [2, 8], "sconstruct": [2, 8], "py2": [2, 8, 20], "construct": [2, 4, 8, 19], "pkg_config": 2, "shlinkflag": 2, "destdir": [2, 8, 9], "bundl": [2, 12], "simpl": [2, 5, 7, 13, 14, 17], "impli": [2, 9, 11], "python_req_us": [2, 4, 5, 6, 8, 14, 19], "individu": [2, 5, 11, 18], "applic": [2, 9, 12], "had": 2, "instead": [2, 3, 5, 6, 7, 8, 9, 13, 14, 16, 18, 19, 20], "no_waf_libdir": 2, "ye": 2, "unit": 2, "framework": [2, 3, 5, 11, 17], "mrzechonek": 2, "tut": 2, "roughli": [2, 9, 12, 13], "ldap": 2, "ldb": 2, "samba": [2, 19], "ftp": [2, 19], "pub": 2, "elibc_freebsd": 2, "libbsd": 2, "popt": 2, "talloc": [2, 19], "tevent": 2, "9": [2, 5, 10, 12, 20], "31": 2, "tdb": 2, "12": [2, 5, 8, 16, 18], "nd": 2, "openldap": 2, "libxslt": 2, "waf_binari": [2, 19], "buildtool": [2, 19], "filesdir": 2, "27": [2, 8], "optional_packag": 2, "myconf": [2, 8], "rpath": 2, "modulesdir": 2, "builtin": 2, "utils_src_configur": [2, 19], "tradition": 3, "python": [3, 6, 17, 18, 20], "organ": 3, "subpackag": [3, 5], "locat": [3, 5], "parent": [3, 9], "directori": [3, 6, 9, 10, 11, 12, 13, 14, 16, 18, 20], "submodul": 3, "repres": [3, 5], "attribut": [3, 10, 16], "session": [3, 20], "addnod": 3, "site": [3, 5, 6, 9, 11, 16, 18, 20], "fine": [3, 5, 12, 16], "start": [3, 5, 6, 11, 12, 15, 16, 20], "problemat": [3, 5, 6, 10, 18], "top": [3, 5, 9, 18], "level": [3, 5, 9, 11, 20], "layout": [3, 6, 13], "wish": [3, 5, 6], "zope": 3, "share": [3, 5], "interfac": [3, 6, 11, 16], "event": [3, 18], "depend": [3, 6, 7, 9, 10, 11, 12, 13, 15, 17], "far": [3, 12, 19], "concern": 3, "entir": [3, 5, 9, 10, 12, 13, 14, 20], "doabl": 3, "real": [3, 18, 20], "we": [3, 4, 6, 8, 11, 12, 14, 15, 17], "freshli": 3, "build": [3, 9, 10, 11, 16, 20], "abl": [3, 15], "tmp": [3, 5, 9, 18, 20], "portag": [3, 5, 8, 12, 14, 15, 18, 20], "python3_8": 3, "traceback": [3, 5, 20], "last": [3, 5], "stdin": 3, "modulenotfounderror": 3, "No": [3, 5], "now": [3, 5, 6, 8, 13, 14, 20], "around": [3, 5, 6, 12, 20], "back": [3, 6, 16], "better": [3, 6, 11, 12, 13, 14], "solut": [3, 5, 16, 20], "unlik": [3, 5, 6, 11, 15], "tradit": 3, "act": 3, "proxi": [3, 14], "strictli": [3, 5, 6, 15, 20], "bound": [3, 11, 16], "permit": [3, 4, 5, 6, 11, 15], "load": [3, 7, 9, 18, 20], "search": [3, 10, 20], "method": [3, 5, 11, 13, 16, 18, 20], "420": 3, "newer": [3, 4, 5, 6, 12, 16], "pkgutil": 3, "standard": [3, 4, 6, 7, 9, 10, 11, 14, 16, 20], "discourag": [3, 6], "earlier": [3, 13], "ignor": [3, 4, 5, 8, 18, 20], "did": [3, 13, 16, 20], "within": [3, 5, 6, 12, 17, 20], "content": 3, "__path__": 3, "__import__": 3, "extend_path": 3, "__name__": 3, "pkg_resourc": [3, 6], "declare_namespac": 3, "altern": [3, 6, 8, 10, 16, 17, 20], "pth": 3, "automat": [3, 4, 5, 6, 10, 12], "inject": [3, 5, 19], "portabl": 3, "topic": [3, 17], "exact": [3, 5, 11, 19], "detect": [3, 5, 9, 20], "recogn": [3, 5, 16], "lack": [3, 9, 20], "action": [3, 5], "distinguish": [3, 5, 13], "veri": [3, 5, 6, 9, 11, 12, 17], "through": [3, 4, 5, 6, 8, 11, 16, 18, 20], "suspici": 3, "less": [3, 20], "ruamel": 3, "miss": [3, 5, 6, 9, 10, 11, 12, 13, 17, 18], "learn": 3, "about": [3, 6, 13], "collis": [3, 5, 20], "namespace_packag": 3, "per": [3, 5], "remov": [3, 4, 5, 6, 11, 12, 13, 14, 15, 18, 20], "tree": [3, 5, 13, 20], "after": [3, 5, 6, 9, 12, 13, 16], "python_compil": 3, "r1_python_compil": [3, 5], "jaraco": [3, 5, 12, 18], "equival": [3, 6, 8, 9, 13], "r1_python_instal": [3, 5], "python_install_al": [3, 5], "r1_python_install_al": [3, 5], "explicit": [3, 4, 5, 6, 19, 20], "rdep": 3, "sed": [3, 5, 8, 14, 18, 20], "i": [3, 5, 6, 7, 11, 12, 14, 16, 18, 20], "r1_src_prepar": [3, 5, 18], "histor": [3, 5, 6, 13, 16], "process": [3, 5, 12, 16, 19], "retir": 3, "major": [4, 5, 6, 7, 11, 12, 20], "avail": [4, 5, 6, 8, 12, 13, 16, 17], "sqlite3": 4, "sqlite": [4, 8], "xdg": 4, "music": 4, "lollypop": 4, "adishatz": 4, "syntax": [4, 10, 11], "lightweight": [4, 5], "password": 4, "backend": [4, 10, 12, 13], "pwman3": 4, "mysql": [4, 14], "postgr": 4, "fulli": [4, 5, 7], "solv": [4, 17], "python_gen_impl_dep": 4, "helper": [4, 5, 10, 14, 19, 20], "2_7": [4, 5], "3_": 4, "travel": 4, "spulec": 4, "freezegun": [4, 18, 20], "pypi": [4, 5, 6, 8, 10, 11, 13], "dateutil": 4, "six": [4, 5, 8], "nose": [4, 5, 20], "distutils_enable_test": [4, 13, 18, 20], "ll": [4, 14], "backport": [4, 6, 10, 12], "zero": 4, "argument": [4, 6, 10, 13, 16, 20], "output": [4, 5, 6, 9, 16, 20], "everi": [4, 5, 6, 8, 12, 14, 16], "escap": [4, 13, 19], "quot": [4, 19], "partial": [4, 9, 10, 13], "python_single_usedep": [4, 5, 13, 19], "cli": [4, 5], "black": 4, "click": 4, "fnmatch": 4, "style": [4, 5, 13, 17, 18, 20], "wildcard": 4, "stdlib": [4, 13, 16], "rememb": [4, 12], "pattern": [4, 12, 13, 19], "prevent": [4, 10, 11, 19, 20], "filenam": [4, 5], "expans": 4, "expand": 4, "zoneinfo": 4, "advantag": [4, 5, 18, 20], "adjust": [4, 9, 11, 16], "switch": [4, 9, 12, 13, 20], "list": [4, 5, 8, 12, 13, 18], "longer": [4, 5, 6, 13], "silent": 4, "updat": [4, 6, 9, 11, 12, 16], "immedi": [4, 5, 19], "becam": [4, 11], "empti": [4, 5], "importlib_metadata": [4, 5, 6], "python3_7": [4, 8], "facilit": [5, 9], "deriv": [5, 6, 7], "notabl": [5, 16], "effici": 5, "experiment": 5, "guarante": [5, 6], "pleas": [5, 6, 8, 9, 12, 15, 16, 18, 19, 20], "hook": 5, "iwdevtool": 5, "regress": 5, "migrat": [5, 10], "exist": [5, 7, 10, 11, 12], "oper": [5, 17], "backward": [5, 11, 12, 16], "readi": [5, 12, 15], "greater": [5, 7], "number": [5, 7, 12, 18], "cost": 5, "flexibl": [5, 7], "wheel": [5, 12, 18], "zip": [5, 6], "stage": [5, 12, 20], "compil": [5, 6, 10, 11, 20], "mere": [5, 7], "imag": [5, 9], "invok": [5, 18, 20], "popul": [5, 15], "addition": [5, 11, 14], "pyproject2setuppi": [5, 6, 13], "hack": [5, 6, 7, 13], "reli": [5, 6, 7, 11, 20], "distutils_use_pep517": [5, 13], "By": [5, 6, 11], "2022": [5, 13, 18], "xml": [5, 6], "feel": [5, 15], "json": 5, "martinblech": 5, "xmltodict": 5, "mit": [5, 6], "vast": [5, 12], "index": [5, 10], "sdist": [5, 20], "binari": [5, 9, 12], "vc": [5, 20], "mechan": [5, 7, 11], "over": [5, 11, 12, 18, 19, 20], "offici": 5, "instanc": [5, 13], "nonfunct": 5, "append": [5, 14], "uniqu": [5, 14], "suffix": 5, "gh": [5, 20], "request": [5, 8, 10], "distfil": [5, 16, 19], "clearli": [5, 20], "tarbal": [5, 12, 20], "textual": 5, "rich": 5, "implic": 5, "cf": [5, 12], "regener": [5, 12], "anywai": [5, 16], "nevertheless": 5, "even": [5, 8, 9, 11, 18, 20], "pregener": 5, "internet": [5, 10, 18], "nodej": 5, "underli": [5, 6], "txt": [5, 6, 12, 18], "ci": [5, 20], "travi": 5, "yml": 5, "grep": 5, "statement": 5, "indirect": 5, "relev": [5, 6, 13, 17, 18, 20], "unnecessarili": 5, "logic": [5, 6, 12], "long": [5, 11, 12], "quickli": 5, "widest": 5, "avoid": [5, 6, 8, 10, 15, 16, 17, 20], "unpredict": 5, "who": [5, 17], "especi": [5, 18, 20], "distutils_single_impl": 5, "aim": [5, 11, 15, 17], "rewritten": [5, 19], "layer": [5, 14], "pyroot": 5, "rootpi": 5, "physic": [5, 19], "root_numpi": 5, "pytabl": 5, "termcolor": 5, "determin": [5, 6, 7, 11, 19, 20], "flit_cor": [5, 12], "maintain": [5, 10, 11, 12, 18], "suggest": [5, 8, 13, 17, 18, 20], "tabl": [5, 13, 16, 18], "summar": [5, 16], "use_pep517": 5, "flit_scm": 5, "hatchl": 5, "jupyt": 5, "jupyter_packag": 5, "build_api": 5, "maturin": 5, "pbr": [5, 6], "pdm": [5, 13], "pep517": [5, 10], "build_meta": 5, "__legacy__": 5, "standalon": [5, 12], "reserv": 5, "bootstrap": [5, 6, 10], "itself": [5, 6, 8, 9, 12, 18], "own": [5, 12, 20], "Their": [5, 6, 9], "fix": [5, 6, 10, 11, 12, 16, 18, 20], "produc": [5, 12], "ident": 5, "artifact": 5, "reduc": 5, "footprint": 5, "isol": 5, "faster": 5, "poetry_cor": 5, "smaller": 5, "checkout": [5, 12, 20], "abil": [5, 6], "tag": [5, 12, 20], "execut": [5, 6, 7, 9, 11, 12, 13, 14, 20], "143": 5, "_install_setup_requir": 5, "attr": [5, 12], "131": 5, "dist": 5, "dict": [5, 19], "425": 5, "_distribut": 5, "self": [5, 16, 18, 20], "292": 5, "finalize_opt": 5, "717": 5, "ep": 5, "integr": [5, 8, 10, 11], "48": 5, "infer_vers": 5, "_get_vers": 5, "config": [5, 9, 12], "148": 5, "parsed_vers": 5, "_do_pars": 5, "110": 5, "rais": 5, "lookuperror": 5, "scm": 5, "unabl": [5, 20], "sure": [5, 18, 20], "re": [5, 8, 15, 20], "intact": 5, "git": [5, 12, 20], "folder": 5, "don": [5, 13], "t": [5, 7, 8, 11, 13, 20], "pip": [5, 12, 20], "proj": 5, "master": [5, 20], "egg": [5, 6, 18], "setuptools_scm_pretend_vers": 5, "static": [5, 8], "write": [5, 6, 7, 12, 17], "hybrid": [5, 10], "expos": [5, 6], "alwai": [5, 6, 8, 11, 13, 16, 17], "taken": [5, 20], "ship": 5, "issu": [5, 6, 13, 16, 18, 20], "forc": [5, 6, 8, 9, 12, 13, 18, 20], "frobnic": 5, "makefil": [5, 14], "jq": 5, "pyx": 5, "unresolv": 5, "regard": 5, "simultan": [5, 11, 17, 20], "link": [5, 7, 9, 16], "editor": 5, "broken": [5, 6, 18, 20], "cryptic": 5, "revers": [5, 7, 12, 15], "miscompil": 5, "panda": 5, "breakag": [5, 20], "dask": [5, 18], "29": 5, "_lib": 5, "hashtabl": 5, "_hashtabl": 5, "tslib": 5, "_tslib": 5, "13": [5, 18, 20], "interv": 5, "init": 5, "30": 5, "convers": [5, 6], "outofboundstimedelta": 5, "localize_pydatetim": 5, "importerror": [5, 6, 10, 11], "38": 5, "x86_64": 5, "undefin": 5, "symbol": 5, "pandas_datetime_to_datetimestruct": 5, "easiest": [5, 19], "workaround": 5, "j1": 5, "origin": [5, 9, 11, 12, 16], "overrid": [5, 9, 14, 20], "extend": [5, 11], "introduc": [5, 11], "src_": 5, "python_": [5, 8], "_all": [5, 8], "compris": 5, "behav": [5, 8], "r1_": 5, "correspond": [5, 12], "python_prepare_al": [5, 18], "each": [5, 6, 7, 11, 14], "foreach": 5, "python_configure_al": 5, "python_compile_al": [5, 8], "python_test_al": 5, "dedic": [5, 6, 14], "chang": [5, 6, 8, 9, 10, 11, 13, 14, 15, 20], "task": [5, 8, 12], "default_src_prepar": 5, "ez_setup": 5, "end": [5, 6, 7, 9, 12, 14, 18, 20], "dir": [5, 14], "extran": 5, "fixm": 5, "test_pytest_plugin": 5, "test_testcase_no_app": 5, "_": [5, 12, 20], "test_test_util": 5, "pointless": 5, "cov": [5, 18], "addopt": 5, "aiohttp": [5, 18], "r1_python_prepare_al": [5, 18], "duplic": [5, 14, 20], "moment": [5, 12, 13, 15], "modif": 5, "keep": [5, 15, 17], "why": [5, 6, 20], "console_script": [5, 6], "configur": [5, 6, 8, 13, 14, 20], "step": [5, 6, 7, 8, 14], "esetup": [5, 8], "mpi": 5, "distutils_arg": [5, 13], "resourcepath": 5, "compress": 5, "manpag": 5, "see": [5, 9, 16, 18, 20], "distutils_enable_sphinx": [5, 8], "emak": [5, 8, 9], "strongli": [5, 6, 15], "encourag": [5, 15], "testbitvector": 5, "redefin": [5, 18], "too": [5, 12, 20], "collada": 5, "einstalldoc": [5, 8, 14], "docinto": 5, "sample_cod": 5, "docompress": 5, "pf": 5, "main": [5, 9], "manipul": [5, 20], "arrai": 5, "futur": [5, 15], "pillow": 5, "build_ext": [5, 6, 20], "tiff": 5, "webp": 5, "dash": 5, "underscor": [5, 20], "boolean": 5, "disable_tiff": 5, "enable_tiff": 5, "disable_webp": 5, "enable_webp": 5, "modifi": [5, 6, 11, 20], "beforehand": 5, "econf": [5, 19], "paremet": 5, "find_packag": 5, "wrongli": [5, 16, 20], "grab": [5, 13], "intend": [5, 16, 20], "attempt": [5, 16, 20], "mistak": 5, "forbidden": 5, "exclud": 5, "paramet": [5, 8, 16], "properli": [5, 6, 13], "intermedi": 5, "minim": [5, 11, 15], "precis": [5, 8, 9], "catch": 5, "earli": [5, 7, 8, 12], "anywher": 5, "first": [5, 6, 7, 11, 12, 15, 16, 18, 20], "easi": [5, 16, 20], "whitelist": 5, "sanit": [5, 16], "mozilla": 5, "bleach": 5, "webencod": 5, "unittest": [5, 11, 20], "discoveri": [5, 18, 20], "univers": 5, "encod": [5, 16], "detector": 5, "chardet": [5, 8], "cygwin": [5, 6], "hypothesi": [5, 20], "bottom": 5, "venv": [5, 6, 13], "temporari": [5, 6], "frequent": [5, 18], "littl": [5, 6, 18], "skip": [5, 8, 10, 12, 16], "those": [5, 6, 7, 8, 9, 18, 20], "how": [5, 20], "statist": 5, "want": [5, 6, 8], "across": 5, "irrelev": [5, 20], "pep8": 5, "pycodestyl": 5, "flake8": [5, 18], "thin": [5, 6], "alreadi": [5, 9, 12, 14], "close": 5, "pre": 5, "post": [5, 6, 13], "easili": [5, 14, 18, 20], "r1_src_test": 5, "cmd": 5, "cmd2": 5, "colorama": 5, "pyperclip": 5, "wcwidth": 5, "text": [5, 8], "column": 5, "80": 5, "fact": [5, 20], "simpli": [5, 16, 17, 20], "3_6": [5, 14], "3_7": [5, 14], "3_8": 5, "tab": 5, "argpars": 5, "argcomplet": 5, "fish": 5, "tcsh": 5, "rel": [5, 18, 20], "epytest": [5, 6, 8, 12, 18, 20], "network": [5, 6, 18, 20], "marker": [5, 10], "m": [5, 18, 20], "displai": 5, "appeas": 5, "usng": 5, "xvfb": 5, "server": [5, 20], "virtx": 5, "nonfat": 5, "termin": [5, 20], "context": [5, 19], "come": [5, 13, 18], "theme": [5, 6, 8], "larg": [5, 12, 15, 18], "hard": [5, 8, 12], "To": [5, 6, 8, 9, 12, 16, 18, 19], "conf": [5, 6], "ext": 5, "distutils_use_setuptool": [5, 13], "color": 5, "stream": 5, "handler": 5, "log": 5, "coloredlog": 5, "xolox": 5, "readthedoc": 5, "en": 5, "latest": 5, "humanfriendli": 5, "expert": [5, 10, 14, 20], "uncommon": 5, "third": [5, 7, 13], "parti": 5, "inflect": 5, "word": 5, "jazzband": 5, "rst": 5, "linker": [5, 9], "alabast": [5, 6], "python_target": [5, 7, 8, 11, 12], "inspect": 5, "omit": [5, 15, 16], "port": [5, 8, 10], "pyseri": 5, "psf": 5, "tri": 5, "incorrect": [5, 6], "been": [5, 6, 8, 11, 12, 13, 14, 16, 18], "assumpt": 5, "consum": [5, 6, 20], "distutils_opt": 5, "alter": [5, 18], "distutils_dep": 5, "dependneci": 5, "r1_src_compil": 5, "r1_src_instal": 5, "primari": [5, 18], "alongsid": [5, 6], "libfoo": 5, "r1_src_configur": 5, "setuptools_rust": 5, "ecosystem": [5, 15, 17], "bump": [5, 12, 15], "lock": 5, "Then": [5, 12], "crate": 5, "cargo_opt": 5, "url": [5, 16], "cargo_crate_uri": 5, "qa_flags_ignor": 5, "posit": 5, "cflag": [5, 9, 20], "cargo_src_unpack": 5, "inflector": 5, "alias": [5, 16], "asn1": 5, "asn1_der": 5, "_rust": 5, "src_unpack": 5, "here": [6, 8, 14, 19], "direct": [6, 7, 14], "convert": [6, 8, 13], "facil": 6, "right": 6, "fit": [6, 20], "profil": [6, 15], "pyproject2toml": 6, "misbehav": 6, "subsequ": 6, "qa": [6, 9, 17], "unset": 6, "expect": [6, 18, 20], "sidebar": 6, "bitprophet": 6, "snippet": [6, 16], "except": [6, 7, 9, 11, 12, 16], "up": [6, 9, 12, 13, 14, 17, 18, 20], "pm": 6, "cleanli": [6, 12], "condit": [6, 10, 12, 18, 20], "leav": 6, "fallback": 6, "never": [6, 11, 13], "clean": [6, 12, 13], "requier": 6, "With": [6, 20], "themselv": [6, 18, 20], "entry_point": [6, 18], "dictionari": [6, 19], "our": [6, 12, 18, 20], "interest": [6, 8, 20], "gui_script": 6, "meaning": 6, "importlib": [6, 11, 20], "fall": [6, 16], "remind": 6, "distutils_strict_entry_point": 6, "trigger": [6, 18, 20], "wrong": [6, 13], "leftov": 6, "resourc": [6, 11, 12], "submit": 6, "suppli": 6, "heavi": 6, "speak": [6, 11], "known": [6, 16, 20], "limit": [6, 12, 15, 17], "address": [6, 12, 16], "definit": 6, "subdirectori": [6, 9], "interspers": 6, "closest": 6, "inplac": 6, "shift": [6, 11], "throughout": 6, "incompat": [6, 11, 16, 18, 20], "2to3": 6, "distutils_in_source_build": 6, "collect": [6, 18, 20], "pypa": 6, "riscv": [6, 8, 19], "pythonpath": [6, 20], "unless": [6, 8, 15], "distutils_install_for_test": [6, 13, 18, 20], "alik": [6, 11, 13], "preserv": [6, 11], "extrem": 6, "home": [6, 12, 13], "went": 6, "awai": [6, 7], "python_test": [6, 8, 9, 12, 18, 20], "basi": 7, "occur": [7, 18], "libpython": [7, 16], "aforement": [7, 13, 16], "foo": [7, 16], "wise": 7, "abstract": [7, 14], "regular": [7, 20], "scon": [7, 8, 10], "second": [7, 13], "easier": 7, "select": [7, 8, 18, 19], "allow": [7, 20], "complex": [7, 19], "repeat": [7, 14], "model": 7, "libboost_python": 7, "python_single_target": [7, 11, 12], "checklist": [7, 10], "primarili": [7, 11], "qualifi": 7, "remain": [7, 11, 13], "power": 8, "harder": 8, "ninja": 8, "train": 8, "yet": [8, 12, 19], "opposit": [8, 11, 13], "investig": 8, "involv": [8, 13], "human": 8, "beings": 8, "socks5": 8, "ssl": 8, "certifi": 8, "2017": 8, "17": 8, "idna": 8, "urllib3": [8, 12], "26": 8, "pysock": 8, "cryptographi": 8, "pyopenssl": 8, "14": [8, 20], "httpbin": [8, 18], "hang": 8, "continu": [8, 12, 20], "python_gen_useflag": 8, "out": [8, 9, 10, 11, 12, 13, 14, 15], "toolkit": 8, "translat": 8, "format": [8, 12, 16], "subtitl": 8, "pydiff": 8, "iso": 8, "lxml": 8, "pycountri": 8, "18": 8, "levenshtein": 8, "devel": 8, "gettext": 8, "video": 8, "gaupol": 8, "riverbankcomput": 8, "sip": 8, "intro": 8, "sip_api_major_nr": 8, "siplib": 8, "h": [8, 9, 19], "bison": 8, "flex": 8, "prepar": [8, 9, 19], "bindir": 8, "incdir": 8, "python_get_includedir": [8, 9, 13], "echo": 8, "distutils_all_subphase_impl": 8, "python3_5": 8, "bzip2": 8, "epydoc": 8, "eselect": 8, "elibc_glibc": 8, "sandbox": [8, 20], "kernel_linux": 8, "pax": 8, "rsync": 8, "userland_gnu": 8, "coreutil": 8, "below": 8, "sphinx_rtd_them": 8, "practic": [8, 11, 12], "big": 8, "imagin": 8, "anymor": [8, 11], "downgrad": 8, "though": [8, 12], "resembl": [8, 18], "presenc": [8, 18], "activ": [8, 17], "behavior": [8, 11, 16], "goal": [8, 12, 20], "side": [8, 11], "effect": [8, 11], "someth": [8, 9, 20], "accord": 8, "won": 8, "reject": [8, 15, 16], "unsupport": [8, 11], "python_is_python3": [8, 13], "basic": [9, 10, 20], "reus": 9, "four": [9, 13, 19], "python_doex": 9, "python_newex": 9, "python_doscript": [9, 14, 19], "python_newscript": 9, "recurs": [9, 15, 18], "python_dohead": 9, "python_scriptinto": 9, "affect": [9, 14], "symlink": 9, "cropgtk": 9, "sbin": 9, "pynslcd": 9, "anyth": 9, "land": 9, "my_pn": 9, "dodir": 9, "rare": [9, 18, 20], "libimag": 9, "env": [9, 12], "python_fix_shebang": 9, "sphinxtrain": 9, "openvpn": 9, "vulnkei": 9, "insinto": 9, "doin": 9, "kitti": 9, "speed": 9, "nowadai": [9, 12, 13], "pypy2": [9, 11, 12], "_feedparser_sgmllib": 9, "lib64": 9, "byte_compil": 9, "cmake_src_instal": 9, "entropi": 9, "ocassion": 9, "bad": [9, 16], "seri": 9, "getter": [9, 13, 16], "python_get_scriptdir": 9, "python_get_library_path": [9, 13], "python_get_cflag": 9, "preprocessor": 9, "pkg": 9, "python_get_lib": 9, "python_get_python_config": 9, "offset": 9, "mycmakearg": [9, 13, 19], "dpython_dest": 9, "dpython_execut": 9, "dpython_include_dir": 9, "dpython_librari": 9, "cmake_src_configur": [9, 19], "pyinc": 9, "pylib": 9, "micha\u0142": 10, "g\u00f3rny": 10, "creativ": 10, "intern": 10, "prefac": 10, "choos": [10, 11, 14], "vs": [10, 13], "relat": [10, 12, 13, 20], "legaci": [10, 13, 16], "variant": [10, 11, 16, 18], "snapshot": [10, 20], "parallel": 10, "race": 10, "command": [10, 14, 18], "usag": 10, "rust": 10, "cargo": 10, "variat": 10, "byte": [10, 16], "queri": [10, 16], "advanc": 10, "cffi": 10, "greenlet": [10, 18], "abort": 10, "due": [10, 12, 14, 18], "assert": 10, "recip": 10, "xdist": [10, 12, 20], "autoload": 10, "typeerror": 10, "_make_test_flaki": 10, "got": [10, 13], "unexpect": 10, "rerun": 10, "importpathmismatcherror": 10, "fixtur": [10, 12], "namespac": [10, 18], "disjoint": 10, "waf": [10, 19], "tip": [10, 20], "retroact": 10, "mainten": 10, "co": [10, 20], "life": 10, "cycl": 10, "page": [10, 16, 17], "increment": 11, "minor": [11, 20], "plan": 11, "On": 11, "hand": [11, 13], "platform": [11, 16, 20], "linux_distribut": 11, "window": 11, "hous": 11, "rpython": 11, "lot": [11, 15], "good": [11, 17, 18, 20], "gc": 11, "jython": 11, "java": 11, "stand": 11, "alon": 11, "bidirect": 11, "interact": 11, "slow": 11, "pace": 11, "ironpython": 11, "brython": 11, "web": 11, "javascript": 11, "dom": 11, "micropython": 11, "microcontrol": 11, "down": 11, "hardwar": 11, "tauthon": 11, "accompani": 11, "nor": [11, 17], "improv": [11, 17], "ideal": [11, 15, 20], "funcsig": 11, "signatur": [11, 16], "afterward": [11, 14, 15], "becom": [11, 12, 16], "later": 11, "lzma": 11, "compet": 11, "amount": [11, 12, 20], "ipaddress": 11, "drop": [11, 16], "box": [11, 13], "hexvers": [11, 20], "0x03030000": 11, "trolliu": 11, "asyncio": [11, 18, 20], "nativ": 11, "understood": 12, "potenti": [12, 16, 18], "stabl": [12, 15], "mask": [12, 15], "stabil": 12, "inconsist": [12, 20], "graph": 12, "repeatedli": 12, "ask": [12, 15], "push": 12, "forward": 12, "eventu": 12, "slowli": [12, 15], "discontinu": 12, "next": [12, 15, 18], "nears": 12, "obsolet": [12, 13], "live": 12, "team": [12, 15], "unmask": 12, "announc": 12, "date": [12, 17, 20], "thing": [12, 13, 17, 18], "progress": 12, "decid": [12, 18], "somewher": 12, "aggress": 12, "reach": [12, 15], "clear": 12, "pursu": 12, "kept": 12, "secur": 12, "workflow": 12, "clone": 12, "remot": [12, 20], "fetch": 12, "rebas": 12, "v3": 12, "cherri": 12, "pick": 12, "upload": 12, "mkdir": 12, "scp": 12, "precompil": 12, "unusu": 12, "structur": [12, 20], "ex": 12, "technic": 12, "docker": 12, "binpkg": 12, "diff": 12, "mgorni": 12, "desc": 12, "_python_all_impl": 12, "_python_verify_pattern": 12, "_python_set_impl": 12, "_python_impl_match": 12, "python_pkg_dep": 12, "gpyutil": 12, "circular": 12, "eas": [12, 15], "temporarili": [12, 13], "python3_11": 12, "20": 12, "pwd": 12, "round": 12, "signific": [12, 18], "remaind": 12, "pydant": 12, "epytest_deselect": [12, 18], "test_comparison": 12, "test_close_to_now_": 12, "lenient": 12, "deselect": [12, 18, 20], "unblock": 12, "100": 12, "40": 12, "emerg": 12, "previous": 12, "reinstal": 12, "batch": 12, "focus": 12, "reenabl": [12, 18], "face": [12, 20], "goe": [12, 20], "unbundl": 12, "tomli": 12, "obligatori": 12, "baselin": 12, "ones": 12, "chosen": 12, "fewest": 12, "Its": 12, "vendor": [12, 13], "februari": 13, "gross": 13, "serv": 13, "placehold": 13, "transit": [13, 15], "period": 13, "ban": 13, "python_multi_usedep": 13, "know": [13, 16, 20], "given": 13, "repoman": 13, "pkgcheck": 13, "tell": 13, "chose": 13, "reorder": 13, "desir": [13, 16, 20], "scan": 13, "unmatch": 13, "trial": 13, "stuff": 13, "privat": 13, "python_export": 13, "python_wrapper_setup": 13, "python_gen_usedep": 13, "mydistutilsarg": 13, "renam": [13, 16], "cleanup": 13, "python_gen": 13, "march": 13, "python_get": 13, "python_includedir": 13, "python_libpath": 13, "dpython3_include_dir": 13, "dpython3_librari": 13, "sundri": 13, "stop": [13, 16], "realli": [13, 15, 18, 20], "ugli": 13, "sole": 13, "uppercas": 13, "fourth": 13, "cruft": 13, "short": [13, 18], "made": [13, 14, 16, 19], "evalu": 13, "januari": 13, "safe": 13, "streamlin": 13, "unfortun": [13, 18, 20], "inde": 13, "foundat": 14, "fionet": 14, "psql": 14, "cach": 14, "sourceforg": [14, 19], "replic": 14, "tgz": 14, "libcangji": 14, "cangjian": 14, "i18n": 14, "eautoreconf": [14, 16], "econf_sourc": 14, "la": 14, "multibuild": 14, "unnecessari": [14, 19, 20], "implicit": [14, 20], "libtool": 14, "buggi": 14, "canva": 14, "widget": 14, "gtk": 14, "cairo": 14, "2d": 14, "draw": 14, "goocanva": 14, "subdir": 14, "am": 14, "gnome2_src_prepar": 14, "gnome2_src_configur": 14, "gnome2_src_instal": 14, "sub_instal": 14, "gi": 14, "_overridesdir": 14, "outsid": [14, 19], "routin": 14, "qemu": 14, "kernel": 14, "machin": 14, "userland": 14, "kvm": 14, "qemu_python_instal": 14, "vmxcap": 14, "qmp": 14, "ga": 14, "eol": 15, "proactiv": 15, "anticip": 15, "soon": 15, "mark": [15, 18, 20], "wide": [15, 20], "revis": 15, "newli": 15, "risk": 15, "break": [15, 16], "feasibl": 15, "manpow": 15, "member": 15, "prematur": 15, "gemato": 15, "carri": 15, "compar": 16, "think": 16, "ve": 16, "hit": 16, "me": 16, "18_p9": 16, "13_p3": 16, "10_p3": 16, "9_p2": 16, "4_p1": 16, "urllib": 16, "pars": 16, "exploit": 16, "verbatim": 16, "worm": 16, "danger": 16, "worst": [16, 20], "unpars": 16, "django": [16, 20], "pr": 16, "14349": 16, "impact": 16, "urlpars": 16, "nurl": 16, "parseresult": 16, "scheme": 16, "netloc": 16, "param": [16, 18], "fragment": 16, "badurl": 16, "what": 16, "attributeerror": 16, "492": 16, "decor": [16, 20], "async": [16, 18], "def": [16, 18, 20], "yield": 16, "await": 16, "sleep": 16, "callabl": 16, "mostli": [16, 17], "getfullargspec": 16, "p1": 16, "p2": 16, "kp3": 16, "kp4": 16, "kp5": 16, "arg": 16, "kwarg": 16, "argspec": 16, "vararg": 16, "fullargspec": 16, "varkw": 16, "kwonlyarg": 16, "kwonlydefault": 16, "annot": 16, "tupl": 16, "hold": 16, "int": 16, "str": 16, "float": 16, "k6": 16, "k7": 16, "k8": 16, "One": [16, 20], "prototyp": 16, "bar": 16, "pretti": 16, "spec": 16, "stringif": 16, "automak": 16, "16": 16, "exec_prefix": 16, "met": 16, "pkg_config_path": 16, "python_cflag": 16, "python_lib": 16, "man": 16, "exit": [16, 20], "autoreconf": 16, "throw": 16, "get_python_inc": 16, "get_path": 16, "platinclud": 16, "get_python_lib": 16, "purelib": 16, "platlib": 16, "platstdlib": 16, "todai": 16, "encodebyt": 16, "decodebyt": 16, "contrari": 16, "ought": 16, "unicod": 16, "version_info": 16, "b64_encodebyt": 16, "b64encod": 16, "b64decod": 16, "insert": 16, "newlin": 16, "length": 16, "until": 16, "suppos": 16, "emb": 16, "lpython3": 16, "7m": 16, "among": 17, "beyond": 17, "reliabl": [17, 20], "deep": 17, "beginn": 17, "peopl": 17, "suboptim": 17, "improp": 17, "fill": 17, "gap": 17, "welcom": 17, "whole": [18, 20], "parametr": 18, "epytest_ignor": 18, "test_client": 18, "test_gener": 18, "test_filenam": 18, "test_transport": 18, "test_transport_work": 18, "eventlet": 18, "py3": 18, "test_contextvar": 18, "test_leak": 18, "might": 18, "intent": 18, "Not": 18, "collid": [18, 20], "instabl": 18, "unstabl": 18, "discret": 18, "justifi": 18, "semi": 18, "random": 18, "multiprocess": 18, "finish": 18, "01": 18, "chanc": 18, "experienc": 18, "insuffici": 18, "nest": 18, "envvar": 18, "pytest_disable_plugin_autoload": 18, "pytest_plugin": 18, "comma": 18, "looponfail": 18, "pytest_fork": 18, "flaki": [18, 20], "rerunfailur": 18, "supposedli": 18, "twice": 18, "_pytest": [18, 20], "pathlib": [18, 20], "posixpath": 18, "confus": 18, "signifi": 18, "event_loop": 18, "freezer": 18, "mocker": 18, "captur": [18, 20], "summari": 18, "asgiref": 18, "sync": 18, "135": 18, "test_loc": 18, "test_sync": 18, "test_sync_contextvar": 18, "deprecationwarn": 18, "main_event_loop": 18, "get_event_loop": 18, "filterwarn": 18, "fatal": [18, 20], "_____________________": 18, "______________________": 18, "577": 18, "asgitest": 18, "testcas": 18, "583": 18, "test_wrapped_case_is_collect": 18, "interrupt": 18, "world": 18, "plot": 19, "voacap": 19, "propag": 19, "predict": 19, "qsl": 19, "hz1jw": 19, "pythonprop": 19, "basemap": 19, "gtk2": 19, "doubl": 19, "energi": 19, "yoda": 19, "hepforg": 19, "use_en": 19, "pyext": 19, "extra_opt": 19, "give": 19, "sound": 19, "signal": [19, 20], "composit": 19, "csound": 19, "fordfrog": 19, "dbuild_python_interfac": 19, "dbuild_python_opcod": 19, "superset": 19, "arab": 19, "arabey": 19, "duali": 19, "pyduali": 19, "dict2db": 19, "trans2arab": 19, "arabic2tran": 19, "domain": 20, "firstli": 20, "idea": 20, "nosetest": 20, "secondli": 20, "strict": 20, "thirdli": 20, "readabl": 20, "wholli": 20, "spew": 20, "seem": 20, "equal": 20, "ceas": 20, "downstream": 20, "convinc": 20, "preced": 20, "area": 20, "____________________": 20, "systemd": 20, "test_login": 20, "234": 20, "hint": 20, "578": 20, "_importtestmodul": 20, "mod": 20, "import_path": 20, "fspath": 20, "importmod": 20, "524": 20, "import_modul": 20, "module_nam": 20, "127": 20, "_bootstrap": 20, "_gcd_import": 20, "frozen": 20, "1014": 20, "991": 20, "_find_and_load": 20, "975": 20, "_find_and_load_unlock": 20, "671": 20, "_load_unlock": 20, "rewrit": 20, "170": 20, "exec_modul": 20, "__dict__": 20, "login": 20, "r2": 20, "discov": 20, "pyarg": 20, "guess": 20, "quick": 20, "mayb": 20, "eunittest": 20, "confirm": 20, "whom": 20, "myself": 20, "subtl": 20, "lead": 20, "But": 20, "bewar": 20, "unexpectedli": 20, "test_start_params_bug": 20, "xfail": 20, "statsmodel": 20, "tsa": 20, "test_arima": 20, "horrend": 20, "disk": 20, "space": 20, "mayhem": 20, "5a": 20, "test_null_byt": 20, "skipif": 20, "0x03000000": 20, "unconditioanlli": 20, "test_babel_with_language_": 20, "test_build_latex": 20, "test_polyglossia_with_language_": 20, "altogeth": 20, "replai": 20, "devmanu": 20, "explan": 20, "connect": 20, "pygit2": 20, "no_network": 20, "properti": 20, "test_network": 20, "allow_test": 20, "unclear": 20, "backtrac": 20, "pluggi": 20, "cachedir": 20, "pytest_cach": 20, "rootdir": 20, "var": 20, "sabyenc": 20, "configfil": 20, "item": 20, "test_decod": 20, "test_crc_pickl": 20, "54": 20, "test_empty_size_pickl": 20, "0x00007f748bc47740": 20, "testsupport": 20, "74": 20, "sabyenc3_wrapp": 20, "119": 20, "180": 20, "pytest_pyfunc_cal": 20, "caller": 20, "187": 20, "_multical": 20, "temp": 20, "2934": 20, "66": 20, "dump": 20, "vv": 20, "34": 20, "23": 20, "timeout": 20, "25": 20, "sabyenc3": 20, "596": 20, "decode_usenet_chunk": 20, "pybytearray_check": 20, "pylist_getitem": 20, "py_input_list": 20, "lp": 20, "0x00007fb5db746740": 20, "73": 20, "117": 20, "87": 20, "lambda": 20, "__main__": 20, "runpi": 20, "85": 20, "_run_cod": 20, "193": 20, "_run_module_as_main": 20, "initi": 20, "reproduc": 20, "ubuntu": 20, "dndebug": 20, "leak": 20, "o0": 20, "isort": 20, "distutils_pep517_instal": 20, "destin": 20, "cp": 20, "pushd": 20, "null": 20, "popd": 20}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"python": [0, 1, 2, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 19], "ani": [0, 8], "r1": [0, 2, 5, 6, 7, 8, 13, 14, 19], "build": [0, 1, 2, 5, 6, 7, 8, 12, 13, 14, 19], "time": [0, 2, 7, 8, 14, 19], "depend": [0, 1, 2, 4, 5, 8, 14, 18, 19, 20], "basic": [0, 1, 5, 19], "us": [0, 2, 3, 4, 5, 6, 7, 8, 14, 18, 19], "uncondit": [0, 19], "condit": [0, 2, 4, 5, 14, 19], "addit": [0, 5, 14], "multipl": [0, 11, 19], "set": [0, 8], "common": [1, 9], "python_compat": 1, "python_dep": 1, "python_required_us": 1, "environ": [1, 20], "packag": [1, 2, 3, 5, 6, 12, 14, 15, 16, 19, 20], "The": [1, 5], "most": 1, "type": 1, "find": 1, "list": [1, 16], "from": [1, 5, 13], "system": [1, 2, 5, 6, 7, 12], "integr": 2, "written": 2, "meson": 2, "scon": 2, "extra": [2, 20], "singl": [2, 5, 7, 13, 19], "impl": [2, 7, 14, 19], "instal": [2, 5, 6, 9, 14, 19, 20], "pure": [2, 14], "multi": [2, 7, 14], "hybrid": [2, 19], "waf": 2, "advanc": [3, 4], "concept": [3, 6], "namespac": 3, "hierarch": 3, "structur": 3, "determin": 3, "whether": 3, "ar": 3, "ad": [3, 5, 12, 15], "new": [3, 12, 15], "gentoo": [3, 10], "legaci": [3, 5, 6], "request": 4, "flag": 4, "interpret": [4, 8, 11, 12], "version": [4, 11], "cffi": 4, "greenlet": 4, "distutil": [5, 6, 7, 8, 16], "standard": 5, "pep": [5, 13], "517": [5, 13], "mode": [5, 20], "sourc": [5, 6], "archiv": 5, "variant": 5, "deprec": [5, 16], "backend": 5, "flit": 5, "buildapi": 5, "poetri": 5, "masonri": 5, "api": [5, 8], "setuptools_scm": 5, "snapshot": 5, "cython": 5, "parallel": [5, 18], "race": 5, "sub": 5, "phase": 5, "function": [5, 9], "python_prepar": 5, "python_configur": 5, "python_compil": 5, "python_test": 5, "python_instal": 5, "pass": 5, "argument": [5, 18], "setup": 5, "py": 5, "call": 5, "custom": 5, "command": 5, "prevent": 5, "test": [5, 6, 15, 18, 20], "directori": 5, "being": 5, "enabl": 5, "distutils_enable_test": 5, "more": 5, "befor": [5, 6], "run": [5, 18], "undesir": 5, "pytest": [5, 18], "virtualx": 5, "document": 5, "via": 5, "sphinx": 5, "autodoc": 5, "extens": [5, 20], "without": 5, "option": 5, "usag": [5, 8], "rust": 5, "cargo": 5, "differ": [6, 8], "variat": 6, "distutils_use_setuptool": 6, "setuptool": 6, "entri": 6, "point": 6, "other": [6, 18], "runtim": [6, 7, 19], "pyproject": 6, "toml": 6, "base": [6, 16, 18], "project": [6, 15], "In": 6, "vs": [6, 7], "out": 6, "choos": [7, 20], "between": 7, "eclass": [7, 12], "relat": 7, "A": [7, 19], "rule": 7, "thumb": 7, "util": 7, "expert": [8, 18], "partial": 8, "restrict": 8, "implement": [8, 9, 11, 12, 15], "python_setup": 8, "disjoint": 8, "regular": 8, "combin": 8, "helper": 9, "fix": 9, "shebang": 9, "script": 9, "byte": 9, "compil": 9, "modul": 9, "queri": 9, "inform": 9, "guid": [10, 13], "content": 10, "indic": 10, "tabl": 10, "altern": 11, "support": [11, 15], "backport": 11, "mainten": [12, 15], "life": 12, "cycl": 12, "note": 12, "specif": 12, "cpython": 12, "patchset": 12, "pypi": [12, 20], "profil": 12, "chang": [12, 16], "port": [12, 15, 16], "initi": 12, "bootstrap": 12, "migrat": 13, "old": 13, "python_usedep": 13, "syntax": 13, "eapi": [13, 15], "7": 13, "8": [13, 16], "manual": [14, 19], "autotool": 14, "2": 15, "which": 15, "exist": 15, "can": 15, "co": 15, "maintain": 15, "tip": 16, "retroact": 16, "bpo43882": 16, "urlsplit": 16, "now": 16, "strip": 16, "lf": 16, "cr": 16, "ht": 16, "charact": 16, "3": 16, "11": 16, "gener": 16, "coroutin": 16, "remov": 16, "asyncio": 16, "inspect": 16, "getargspec": 16, "formatargspec": 16, "10": 16, "configur": 16, "No": 16, "1": 16, "found": [16, 18], "sysconfig": 16, "9": 16, "base64": 16, "encodestr": 16, "decodestr": 16, "config": 16, "pkg": 16, "longer": 16, "librari": 16, "default": 16, "prefac": 17, "recip": 18, "skip": [18, 20], "marker": 18, "path": 18, "name": 18, "avoid": 18, "runner": [18, 20], "xdist": 18, "plugin": 18, "explicitli": 18, "disabl": 18, "automat": 18, "autoload": 18, "entir": 18, "typeerror": 18, "_make_test_flaki": 18, "got": 18, "an": 18, "unexpect": 18, "keyword": 18, "rerun": 18, "importpathmismatcherror": 18, "fixtur": 18, "warn": 18, "resolv": 20, "suit": 20, "problem": 20, "correct": 20, "miss": 20, "file": 20, "importerror": 20, "c": 20, "checklist": 20, "deal": 20, "failur": 20, "problemat": 20, "requir": 20, "internet": 20, "access": 20, "abort": 20, "due": 20, "assert": 20, "pep517": 20}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 56}}) \ No newline at end of file diff --git a/guide/single.html b/guide/single.html index b5782a5..ab369b3 100644 --- a/guide/single.html +++ b/guide/single.html @@ -1,10 +1,10 @@ - + - + python-single-r1 — single-impl packages — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,7 +35,7 @@
    -

    python-single-r1 — single-impl packages

    +

    python-single-r1 — single-impl packages

    The python-single-r1 eclass is used to install single-impl packages. It is probably the easiest eclass to use, and it is recommended over python-r1 whenever multi-impl support would add unnecessary @@ -42,7 +43,7 @@ complexity. However, for packages using distutils or a similar Python build system, distutils-r1 eclass should be used instead.

    Eclass reference: python-single-r1.eclass(5)

    -

    Basic use for unconditional Python

    +

    Basic use for unconditional Python

    The defining feature of this eclass is that it defines a pkg_setup phase. It normally calls python_setup function in order to determine the interpreter selected by user, and set the global @@ -80,7 +81,7 @@ the four highlighted lines are specific to Python eclasses, plus the implicitly exported pkg_setup phase.

    -

    Dependencies

    +

    Dependencies

    When depending on other Python packages, USE dependencies need to be declared in order to ensure that the dependencies would be built against the Python implementation used for the package. The exact dependency @@ -126,7 +127,7 @@ inside and outside inside it.

    -

    Conditional Python use

    +

    Conditional Python use

    The examples so far assumed that Python is used unconditionally. If Python support is conditional to a USE flag, appropriate USE conditionals need to be used in metadata variables, and pkg_setup @@ -172,7 +173,7 @@ needs to be rewritten to call the default implementation conditionally:

    -

    A hybrid: build-time + conditional runtime

    +

    A hybrid: build-time + conditional runtime

    A fairly common pattern is for Python to be required unconditionally at build time but only conditionally at runtime. This happens e.g. when the package is calling some helper scripts at build time, and optionally @@ -219,7 +220,7 @@ USE-conditional:

    Note that eclass-exported pkg_setup is used unconditionally here.

    -

    Multiple USE conditions

    +

    Multiple USE conditions

    Finally, let’s give an example of a package where Python is needed for two independent conditions. To make it more complex, one of them applies to build time (tests) while the other to runtime (bindings).

    @@ -273,7 +274,7 @@ the one in REQUIRED used in dependencies.

    -

    Manual install

    +

    Manual install

    Some packages do not include Python files in their build systems, or do not install all of them. In this case, the necessary files can be installed via one of the installation helpers.

    @@ -374,7 +375,7 @@ can be installed via one of the installation helpers.

    - + @@ -391,7 +392,7 @@ can be installed via one of the installation helpers.

    ©2020, Michał Górny, license: CC BY 4.0. | - Powered by Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | diff --git a/guide/test.html b/guide/test.html index 6b443e6..47995a1 100644 --- a/guide/test.html +++ b/guide/test.html @@ -1,10 +1,10 @@ - + - + Resolving test suite problems — Gentoo Python Guide documentation @@ -12,6 +12,7 @@ + @@ -34,9 +35,9 @@
    -

    Resolving test suite problems

    +

    Resolving test suite problems

    -

    Choosing the correct test runner

    +

    Choosing the correct test runner

    There are a few modules used to run tests in Python packages. The most common include the built-in unittest module, pytest and nose. There are also some rarely used test tools and domain-specific solutions, @@ -73,7 +74,7 @@ If you have some free time, convincing upstream to switch from nose to pytest is a worthwhile goal.

    -

    Missing test files in PyPI packages

    +

    Missing test files in PyPI packages

    One of the more common test-related problems is that PyPI packages (generated via setup.py sdist) often miss some or all test files. The latter results in no tests being run, the former in test failures @@ -87,7 +88,7 @@ tarball:

    -

    ImportErrors for C extensions

    +

    ImportErrors for C extensions

    Tests are often invoked in such a way that the Python packages and modules from the current directory take precedence over these found in the staging area or build directory. In fact, this is often @@ -142,7 +143,7 @@ instead:

    -

    Checklist for dealing with test failures

    +

    Checklist for dealing with test failures

    If you see some test failures but do not have a guess as to why they would be happening, try the following for a start:

      @@ -194,7 +195,7 @@ be skipped.

    -

    Skipping problematic tests

    +

    Skipping problematic tests

    While generally it is preferable to fix tests, sometimes you will face failures that cannot be easily resolved. This especially applies to tests that are broken themselves rather than indicating real problems @@ -245,7 +246,7 @@ simply remove that file. If all tests belonging to the package are broken, you can use RESTRICT=test to disable testing altogether.

    -

    Tests requiring Internet access

    +

    Tests requiring Internet access

    One of more common causes of test failures are attempts to use Internet. With Portage blocking network access by default, packages performing tests against remote servers often fail.

    @@ -285,7 +286,7 @@ distutils_enable_tests pytest
    -

    Tests aborting (due to assertions)

    +

    Tests aborting (due to assertions)

    There are cases of package’s tests terminating with an unclear error message and backtrace similar to the following:

    ============================= test session starts ==============================
@@ -348,7 +349,7 @@ $ pytest -s
    -

    Installing extra dependencies in test environment (PEP517 mode)

    +

    Installing extra dependencies in test environment (PEP517 mode)

    Rarely, the test suite expects some package being installed that does not fit being packaged and installed system-wide. For example, isort’s tests use a few example plugins that are not useful to end @@ -453,7 +454,7 @@ into it for the purpose of testing. Note that @@ -470,7 +471,7 @@ into it for the purpose of testing. Note that Sphinx 4.5.0 + Powered by Sphinx 5.0.1 & Alabaster 0.7.12 | -- cgit v1.2.3-65-gdbad