Search.setIndex({"docnames": ["build-dependencies", "copyright", "embedded-python", "index", "interpreter", "locally-installed-python", "packaged-modules", "packaging-tools", "python-programs", "python3", "this-document", "upgrade-procedure"], "filenames": ["build-dependencies.rst", "copyright.rst", "embedded-python.rst", "index.rst", "interpreter.rst", "locally-installed-python.rst", "packaged-modules.rst", "packaging-tools.rst", "python-programs.rst", "python3.rst", "this-document.rst", "upgrade-procedure.rst"], "titles": ["<span class=\"section-number\">1. </span>Build Dependencies", "<span class=\"section-number\">1. </span>Copyright", "<span class=\"section-number\">6. </span>Programs Embedding Python", "Abstract", "<span class=\"section-number\">3. </span>Python Packaging", "<span class=\"section-number\">7. </span>Interaction with Locally Installed Python Versions", "<span class=\"section-number\">4. </span>Packaged Modules", "<span class=\"section-number\">2. </span>Packaging Tools", "<span class=\"section-number\">5. </span>Python Programs", "<span class=\"section-number\">2. </span>Completing the move to Python 3", "<span class=\"section-number\">4. </span>This document", "<span class=\"section-number\">3. </span>Upgrade Procedure"], "terms": {"1999": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11], "2021": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11], "softwar": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11], "public": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11], "interest": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11], "python": [0, 3, 10, 11], "packag": [0, 2, 3, 8, 11], "must": [0, 2, 4, 6, 8, 9], "declar": [0, 2, 4, 6, 8], "everi": [0, 4, 6], "version": [0, 1, 2, 3, 7, 9, 11], "i": [0, 1, 2, 4, 6, 7, 8, 9, 10, 11], "built": [0, 2, 4, 6], "The": [0, 2, 4, 6, 7, 8, 9, 11], "python3": [0, 4, 6, 8, 9, 10, 11], "all": [0, 4, 5, 6, 9, 11], "dev": [0, 2, 4, 9, 11], "should": [0, 2, 4, 6, 7, 8, 9], "us": [0, 1, 3, 4, 5, 6, 7, 9], "when": [0, 4, 6, 7, 9, 11], "extens": [0, 6, 7, 8], "ani": [0, 1, 2, 4, 6, 8, 9, 11], "3": [0, 3, 4, 6, 8, 11], "2": [0, 1, 4, 6, 7, 8, 9], "To": 0, "specif": [0, 3, 6, 7, 8], "x": [0, 2, 4, 6, 7, 8], "y": [0, 2, 4, 6, 7, 8, 11], "some": [0, 4, 6, 7, 9, 11], "applic": [0, 4, 9, 11], "pure": [0, 6], "modul": [0, 3, 5, 7, 11], "mai": [0, 4, 6, 7, 8, 9, 11], "abl": 0, "avoid": [0, 4], "runtim": [0, 3, 6], "environ": [0, 4, 6], "onli": [0, 4, 6, 7, 8, 9, 11], "python2": [0, 4, 6, 8, 9], "A": [0, 1, 4, 6, 8], "doe": [0, 2, 4, 6, 9], "requir": [0, 3, 4, 6, 8, 11], "them": [0, 4, 6, 7], "least": 0, "7": [0, 4, 9], "6": [0, 4, 7, 8], "1": [0, 4], "9": 0, "5": [0, 4, 6, 8], "author": 1, "neil": 1, "schemenau": 1, "na": 1, "debian": [1, 3, 4, 5, 6, 7, 9, 10, 11], "org": 1, "matthia": 1, "klose": 1, "doko": 1, "gregor": 1, "hoffleit": 1, "flight": 1, "josselin": 1, "mouett": 1, "joss": 1, "joe": 1, "wreschnig": 1, "piman": 1, "lo\u00efc": 1, "minier": 1, "lool": 1, "scott": 1, "kitterman": 1, "com": 1, "barri": 1, "warsaw": 1, "ben": 1, "finnei": 1, "benfinnei": 1, "id": [1, 6], "au": 1, "william": 1, "codehelp": 1, "stefano": 1, "rivera": 1, "stefanor": 1, "thi": [1, 2, 3, 4, 6, 7, 8, 9, 11], "manual": [1, 11], "free": 1, "you": [1, 5, 7], "can": [1, 4, 6, 8, 9, 11], "redistribut": 1, "modifi": [1, 4, 7], "under": 1, "term": [1, 6], "gnu": [1, 3], "gener": [1, 6, 8, 11], "licens": [1, 4], "publish": 1, "foundat": 1, "either": [1, 4, 6, 8], "your": [1, 5], "option": [1, 4, 6], "later": [1, 4, 6, 7], "distribut": [1, 3, 4, 6], "hope": 1, "without": 1, "warranti": 1, "even": [1, 4], "impli": 1, "merchant": 1, "fit": 1, "FOR": 1, "particular": [1, 3, 4, 6], "purpos": [1, 4, 6], "see": [1, 4, 6, 7, 8, 9], "more": [1, 6, 9, 11], "detail": [1, 4, 6, 7], "copi": 1, "avail": [1, 4, 6, 9], "usr": [1, 4, 6, 7, 8, 9], "share": [1, 2, 4, 6, 8], "common": [1, 4], "licenc": 1, "gpl": [1, 4], "linux": [1, 3], "system": [1, 4, 6, 7], "world": 1, "wide": 1, "web": 1, "also": [1, 4, 6, 8], "obtain": 1, "write": 1, "inc": 1, "51": 1, "franklin": 1, "st": 1, "fifth": 1, "floor": 1, "boston": 1, "ma": 1, "02110": 1, "1301": 1, "usa": 1, "instal": [2, 3, 6, 7, 8, 9], "which": [2, 4, 6, 7, 8], "emb": 2, "interpret": [2, 3, 6, 9], "where": [2, 4, 11], "against": [2, 6], "It": [2, 4, 6, 7], "current": [2, 4, 6, 8], "default": [2, 3, 4, 6, 7, 9, 10, 11], "unless": [2, 6], "work": [2, 4, 6, 11], "correctli": 2, "link": [2, 6], "librari": [2, 4, 6, 9], "automat": [2, 6, 7], "creat": 2, "dpkg": 2, "shlibdep": 2, "libpython": [2, 6], "so": [2, 6, 9, 11], "z": [2, 4], "provid": [2, 3, 4, 7, 9], "document": [3, 6, 7, 9], "describ": [3, 6, 7, 11], "within": [3, 4], "polici": [3, 4, 6, 7, 10, 11], "program": [3, 6, 7], "copyright": 3, "complet": [3, 4], "move": [3, 4], "remov": [3, 4, 6, 8, 11], "unvers": [3, 4], "command": [3, 7], "main": 3, "virtual": [3, 6], "depend": [3, 7, 8, 9, 11], "minim": [3, 9], "name": [3, 8], "locat": [3, 6, 8], "path": [3, 5, 6], "hook": 3, "updat": [3, 6, 11], "type": [3, 4], "wheel": [3, 4], "specifi": [3, 4, 8], "support": [3, 4, 8, 9, 11], "byte": [3, 4, 7, 8], "compil": [3, 4, 7, 8], "direct": 3, "shebang": 3, "ship": [3, 6], "privat": [3, 4, 6], "embed": 3, "build": [3, 4, 6, 7, 9, 11], "interact": 3, "local": [3, 4, 7, 9], "tool": [3, 4, 6], "distutil": [3, 4], "setuptool": [3, 6], "dh": [3, 4], "pybuild": 3, "cdb": 3, "central": 3, "upgrad": [3, 4, 6, 9], "procedur": 3, "index": 3, "search": [3, 4], "page": 3, "At": 4, "given": 4, "time": [4, 6], "binari": [4, 6, 8, 9], "repres": [4, 6], "long": [4, 5, 11], "exist": [4, 9], "As": [4, 5, 6, 8], "far": 4, "reason": [4, 6], "treat": 4, "separ": [4, 6], "interdepend": 4, "In": 4, "case": [4, 6], "explicitli": [4, 6], "refer": 4, "helper": 4, "For": [4, 6, 9, 11], "stretch": [4, 7], "earlier": 4, "have": [4, 5, 6, 8, 11], "been": [4, 6, 7], "from": [4, 6, 7, 9, 11], "design": [4, 7], "goal": [4, 6, 9], "fulli": [4, 7], "interfac": 4, "function": 4, "enshrin": 4, "implement": [4, 6], "except": [4, 6], "note": [4, 8, 9], "same": [4, 6, 7, 8], "differ": [4, 5], "major": [4, 6, 9], "number": [4, 6], "need": [4, 5, 6, 8, 9, 11], "distinguish": 4, "each": 4, "alwai": 4, "latest": [4, 9], "stabl": 4, "upstream": [4, 6, 7, 9], "integr": 4, "There": [4, 6], "newer": 4, "unsupport": 4, "includ": [4, 6], "thei": [4, 6, 7, 8, 11], "ar": [4, 6, 7, 8, 9, 11], "releas": [4, 6, 7, 9, 11], "apart": 4, "legaci": 4, "beta": 4, "futur": [4, 6, 7], "well": [4, 9], "other": [4, 5, 6, 9, 11], "seem": 4, "scope": 4, "synonym": 4, "micro": [4, 5], "minor": [4, 8, 9], "e": [4, 6, 8], "g": [4, 6, 8], "0": 4, "4": [4, 6], "inde": 4, "call": [4, 6], "set": [4, 6], "found": 4, "debian_default": 4, "inform": [4, 6], "through": [4, 6], "bin": [4, 6, 8, 9], "py3vers": 4, "pyvers": 4, "These": [4, 6, 8, 9], "file": [4, 6, 7], "configpars": 4, "format": [4, 6], "defin": [4, 6], "section": [4, 7, 11], "follow": [4, 6], "old": [4, 11], "might": 4, "still": [4, 9], "superset": 4, "appear": 4, "befor": [4, 9], "being": 4, "shall": [4, 6], "deploy": [4, 6], "script": [4, 6, 7, 8, 9], "ensur": 4, "exclud": 4, "cannot": [4, 6], "track": 4, "exampl": [4, 6], "gdbm": 4, "tk": 4, "xorg": 4, "venv": 4, "bootstrap": 4, "pip": [4, 6], "would": 4, "interfer": 4, "manag": [4, 6, 7], "ensurepip": 4, "outsid": 4, "print": 4, "messag": 4, "explain": [4, 8], "problem": 4, "recommend": [4, 6, 7, 9], "altern": 4, "profil": 4, "develop": [4, 7, 9], "split": [4, 6], "off": 4, "lib2to3": 4, "symlink": 4, "execut": [4, 8], "full": [4, 7], "entir": 4, "standard": [4, 7], "conveni": [4, 6], "greater": 4, "than": [4, 6], "equal": 4, "lower": [4, 6], "dbg": [4, 9], "bullsey": [4, 9], "If": [4, 5, 6, 7, 8, 9], "remain": [4, 6], "pep": [4, 6, 9], "394": 4, "min": 4, "max": 4, "allow": [4, 6], "form": [4, 6, 8, 11], "foo": [4, 6, 8], "upon": 4, "themselv": [4, 8], "do": 4, "stop": 4, "stack": [4, 6, 9], "addit": [4, 11], "met": 4, "prefer": [4, 6], "fail": 4, "maintain": [4, 6, 7, 11], "overrid": [4, 7], "env": [4, 8], "advis": 4, "bypass": 4, "": [4, 5, 6, 8], "check": 4, "make": [4, 6, 7, 11], "vulner": 4, "incomplet": 4, "By": 4, "directori": [4, 6, 7, 8], "list": [4, 6, 9, 10], "pythonpath": 4, "variabl": [4, 6], "sy": [4, 6], "lib": [4, 6, 7, 8], "zip": [4, 6], "entri": 4, "absent": 4, "dist": [4, 6, 7], "special": 4, "dedic": 4, "administr": 4, "reserv": 4, "site": [4, 7], "append": 4, "offici": 4, "multipl": [4, 6, 7, 8, 11], "instanc": 4, "py": [4, 6, 7], "point": [4, 7, 9], "architectur": [4, 8, 11], "independ": [4, 6], "histor": 4, "wa": 4, "pyshar": 4, "sinc": [4, 6], "last": [4, 9], "wheezi": [4, 6], "suffici": [4, 6], "ha": [4, 6, 7, 9], "act": 4, "mechan": 4, "handl": [4, 6, 8], "chang": [4, 6, 7, 10, 11], "enabl": [4, 6], "three": [4, 11], "come": 4, "invok": [4, 7], "occur": 4, "d": 4, "rtinstal": 4, "becom": 4, "first": [4, 8], "argument": 4, "second": 4, "affect": [4, 5], "third": 4, "fourth": 4, "new": [4, 5, 7, 9, 11], "alreadi": 4, "rtremov": 4, "rtupdat": [4, 6], "pre": [4, 6, 8, 11], "post": [4, 6, 8], "immedi": 4, "afterward": 4, "out": 4, "doc": [4, 6, 9, 11], "todo": 4, "parti": 4, "don": 5, "t": 5, "won": 5, "got": 5, "care": [5, 11], "too": 5, "reduc": [6, 9], "necessari": [6, 8, 11], "transit": [6, 11], "intern": 6, "veri": 6, "howev": 6, "we": 6, "want": 6, "autom": 6, "recompil": [6, 11], "possibl": [6, 11], "dure": 6, "itself": [6, 8], "re": 6, "bytecod": 6, "pyc": 6, "pyo": 6, "shortli": 6, "thereaft": 6, "rebuild": [6, 11], "c": 6, "encourag": [6, 7], "loos": 6, "bound": 6, "whenev": 6, "two": [6, 9], "kind": 6, "sourc": [6, 10, 11], "code": 6, "across": 6, "mani": [6, 11], "one": [6, 9, 11], "done": [6, 11], "oper": 6, "symbol": 6, "resolv": 6, "wai": [6, 7], "structur": 6, "namespac": 6, "dot": 6, "glossari": 6, "how": 6, "sens": 6, "unrel": 6, "compon": 6, "import": 6, "order": [6, 7, 11], "confus": 6, "access": 6, "suit": 6, "427": 6, "archiv": [6, 9], "contain": 6, "info": 6, "metadata": 6, "singl": [6, 8], "whl": 6, "suffix": 6, "put": 6, "directli": 6, "statement": 6, "yet": [6, 9], "below": 6, "redund": 6, "establish": 6, "user": [6, 9], "take": 6, "advantag": 6, "distro": 6, "base": [6, 7], "less": 6, "ad": [6, 11], "easili": 6, "grep": 6, "trace": 6, "difficult": 6, "debug": 6, "limit": 6, "narrow": 6, "virtualenv": 6, "pyvenv": 6, "compliant": 6, "own": [6, 8], "dirtbik": 6, "rewheel": 6, "turn": 6, "back": 6, "univers": 6, "compat": 6, "longer": 6, "place": 6, "insid": 6, "root": 6, "instead": 6, "preserv": 6, "run": [6, 8], "between": 6, "prefix": 6, "choos": 6, "best": 6, "necessarili": 6, "pkg": 6, "egg": 6, "pyxdg": 6, "via": 6, "xdg": 6, "its": [6, 8], "underscor": 6, "capit": 6, "letter": 6, "replac": [6, 7], "hyphen": 6, "minu": 6, "distro_info": 6, "xlib": 6, "respect": 6, "subpackag": 6, "bar": 6, "Such": 6, "sever": [6, 11], "help": [6, 7], "appli": [6, 8], "intend": 6, "django": 6, "varieti": 6, "django_": 6, "clear": 6, "consist": 6, "approach": 6, "larg": [6, 7], "enough": 6, "desir": 6, "control": 6, "paragraph": 6, "field": 6, "similarli": 6, "were": 6, "obsolet": 6, "appropri": [6, 8], "line": [6, 7, 8], "b": 6, "keyword": 6, "clearer": 6, "encod": 6, "ignor": 6, "comma": 6, "individu": 6, "continu": [6, 9], "deprec": [6, 8], "xb": 6, "normal": 6, "cours": 6, "never": 6, "achiev": 6, "adequ": 6, "accomplish": 6, "examin": 6, "correspond": 6, "correct": 6, "maximum": 6, "constraint": 6, "strictli": 6, "higher": 6, "provis": 6, "valu": 6, "substitut": 6, "guarante": 6, "optim": 6, "prerm": 6, "sure": 6, "both": [6, 11], "belong": 6, "etc": [6, 7], "debian_config": 6, "configur": 6, "forcefulli": 6, "again": [6, 11], "nmu": 6, "subject": 6, "variou": 7, "although": [7, 9], "none": 7, "mandatori": 7, "strongli": 7, "abov": 7, "mind": 7, "vice": 7, "versa": 7, "appendix": 7, "just": 7, "an": [7, 8, 9], "overview": 7, "read": 7, "add": 7, "flag": 7, "layout": 7, "seen": 7, "deb": 7, "setup": 7, "relat": [7, 11], "along": 7, "focu": 7, "improv": 7, "shift": 7, "awai": 7, "offer": 7, "similar": 7, "api": 7, "debhelp": 7, "easier": 7, "calcul": 7, "Their": 7, "man": 7, "dh_python3": 7, "request": 7, "mk": 7, "class": 7, "anoth": 7, "jessi": 7, "written": 8, "interpreter_loc": 8, "interpreter_nam": 8, "rule": 8, "those": [8, 9], "tight": 8, "previous": 9, "drop": [9, 11], "404": 9, "state": 9, "plan": 9, "extend": 9, "466": 9, "initi": 9, "upload": [9, 11], "select": [9, 11], "until": 9, "pleas": 9, "discuss": [9, 11], "mail": [9, 10], "block": 9, "revers": 9, "introduc": 9, "start": 9, "11": 9, "No": 9, "suggest": 9, "config": 9, "pydoc": 9, "10": 9, "buster": 9, "after": [9, 11], "part": 9, "12": 9, "bookworm": 9, "port": 9, "like": 9, "break": 9, "git": 10, "repositori": 10, "propos": 10, "review": 10, "unstabl": 11, "candid": 11, "experiment": 11, "test": 11, "prepar": 11, "heat": 11, "readi": 11, "associ": 11, "onc": 11, "consensu": 11, "announc": 11, "core": 11, "meta": 11, "team": 11, "schedul": 11, "get": 11, "typic": 11, "phase": 11, "keep": 11, "smooth": 11, "rebuilt": 11, "binnmu": 11, "now": 11, "older": 11, "assist": 11, "tracker": 11, "caus": 11, "entangl": 11, "transient": 11, "uninstal": 11, "unavoid": 11, "coordin": 11, "multi": 11, "true": 11}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"build": [0, 2], "depend": [0, 2, 4, 6], "copyright": 1, "program": [2, 8], "embed": 2, "python": [2, 4, 5, 6, 7, 8, 9], "abstract": 3, "content": 3, "appendix": 3, "indic": 3, "tabl": 3, "packag": [4, 6, 7, 9], "version": [4, 5, 6, 8], "main": 4, "virtual": 4, "specif": 4, "minim": 4, "interpret": [4, 8], "name": [4, 6], "locat": 4, "modul": [4, 6, 8], "path": 4, "hook": 4, "updat": 4, "instal": [4, 5], "runtim": 4, "document": [4, 10], "interact": 5, "local": 5, "type": 6, "wheel": 6, "specifi": 6, "support": [6, 7], "provid": 6, "byte": 6, "compil": 6, "tool": 7, "distutil": 7, "setuptool": 7, "dh": 7, "pybuild": 7, "cdb": 7, "remov": [7, 9], "central": 7, "direct": 8, "shebang": 8, "us": 8, "default": 8, "ship": 8, "privat": 8, "particular": 8, "complet": 9, "move": 9, "3": 9, "unvers": 9, "command": 9, "thi": 10, "upgrad": 11, "procedur": 11}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "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": 57}, "alltitles": {"Build Dependencies": [[0, "build-dependencies"]], "Copyright": [[1, "copyright"]], "Programs Embedding Python": [[2, "programs-embedding-python"]], "Building Embedded Programs": [[2, "building-embedded-programs"]], "Embedded Python Dependencies": [[2, "embedded-python-dependencies"]], "Abstract": [[3, "abstract"]], "Contents": [[3, "contents"]], "Appendix": [[3, null]], "Indices and tables": [[3, "indices-and-tables"]], "Python Packaging": [[4, "python-packaging"]], "Versions": [[4, "versions"]], "Main packages": [[4, "main-packages"]], "Virtual packages for Python-version specific dependencies": [[4, "virtual-packages-for-python-version-specific-dependencies"]], "Minimal packages": [[4, "minimal-packages"]], "Python Interpreter": [[4, "python-interpreter"]], "Interpreter Name": [[4, "interpreter-name"]], "Interpreter Location": [[4, "interpreter-location"]], "Module Path": [[4, "module-path"]], "Hooks for updates to installed runtimes": [[4, "hooks-for-updates-to-installed-runtimes"]], "Documentation": [[4, "documentation"]], "Interaction with Locally Installed Python Versions": [[5, "interaction-with-locally-installed-python-versions"]], "Packaged Modules": [[6, "packaged-modules"]], "Types of Python Modules": [[6, "types-of-python-modules"]], "Wheels": [[6, "wheels"]], "Module Package Names": [[6, "module-package-names"]], "Specifying Supported Versions": [[6, "specifying-supported-versions"]], "Dependencies": [[6, "dependencies"]], "Provides": [[6, "provides"]], "Modules Byte-Compilation": [[6, "modules-byte-compilation"]], "Packaging Tools": [[7, "packaging-tools"]], "distutils": [[7, "distutils"]], "setuptools": [[7, "setuptools"]], "dh-python": [[7, "dh-python"]], "pybuild": [[7, "pybuild"]], "CDBS": [[7, "cdbs"]], "python-support (removed)": [[7, "python-support-removed"]], "python-central (removed)": [[7, "python-central-removed"]], "Python Programs": [[8, "python-programs"]], "Interpreter directive (\u201cShebang\u201d)": [[8, "interpreter-directive-shebang"]], "Programs using the default Python": [[8, "programs-using-the-default-python"]], "Programs Shipping Private Modules": [[8, "programs-shipping-private-modules"]], "Programs Using a Particular Python Version": [[8, "programs-using-a-particular-python-version"]], "Completing the move to Python 3": [[9, "completing-the-move-to-python-3"]], "Removal of the unversioned packages": [[9, "removal-of-the-unversioned-packages"]], "Unversioned python commands": [[9, "unversioned-python-commands"]], "This document": [[10, "this-document"]], "Upgrade Procedure": [[11, "upgrade-procedure"]]}, "indexentries": {"pep 394": [[4, "index-0"]], "pythonpath": [[4, "index-1"]], "python enhancement proposals": [[4, "index-0"], [6, "index-0"], [9, "index-0"], [9, "index-1"]], "environment variable": [[4, "index-1"]], "pep 427": [[6, "index-0"]], "pep 404": [[9, "index-0"]], "pep 466": [[9, "index-1"]]}})