pypa-hatch/latest/plugins/environment/reference/index.html

1224 lines
325 KiB
HTML

<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="Modern, extensible Python project management"><meta name=author content="Ofek Lev"><link href=https://hatch.pypa.io/1.13/plugins/environment/reference/ rel=canonical><link href=../../metadata-hook/custom/ rel=prev><link href=../virtual/ rel=next><link rel=icon href=../../../assets/images/logo.svg><meta name=generator content="mkdocs-1.6.1, mkdocs-material-9.5.24+insiders-4.53.10"><title>Environment plugins - Hatch</title><link rel=stylesheet href=../../../assets/stylesheets/main.c0d16a3a.min.css><link rel=stylesheet href=../../../assets/stylesheets/palette.ab4e12ef.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=../../../assets/_mkdocstrings.css><link rel=stylesheet href=../../../assets/css/custom.css><link rel=stylesheet href=https://cdn.jsdelivr.net/npm/firacode@6.2.0/distr/fira_code.css><script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script><meta property=og:type content=website><meta property=og:title content="Environment plugins - Hatch"><meta property=og:description content="Modern, extensible Python project management"><meta property=og:image content=https://hatch.pypa.io/1.13/assets/images/social/plugins/environment/reference.png><meta property=og:image:type content=image/png><meta property=og:image:width content=1200><meta property=og:image:height content=630><meta content=https://hatch.pypa.io/1.13/plugins/environment/reference/ property=og:url><meta property=twitter:card content=summary_large_image><meta property=twitter:title content="Environment plugins - Hatch"><meta property=twitter:description content="Modern, extensible Python project management"><meta property=twitter:image content=https://hatch.pypa.io/1.13/assets/images/social/plugins/environment/reference.png><link href=../../../assets/stylesheets/glightbox.min.css rel=stylesheet><style>
html.glightbox-open { overflow: initial; height: 100%; }
.gslide-title { margin-top: 0px; user-select: text; }
.gslide-desc { color: #666; user-select: text; }
.gslide-image img { background: white; }
.gscrollbar-fixer { padding-right: 15px; }
.gdesc-inner { font-size: 0.75rem; }
body[data-md-color-scheme="slate"] .gdesc-inner { background: var(--md-default-bg-color);}
body[data-md-color-scheme="slate"] .gslide-title { color: var(--md-default-fg-color);}
body[data-md-color-scheme="slate"] .gslide-desc { color: var(--md-default-fg-color);}</style><script src=../../../assets/javascripts/glightbox.min.js></script></head> <body dir=ltr data-md-color-scheme=slate data-md-color-primary=indigo data-md-color-accent=indigo> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#environment-plugins class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <div data-md-color-scheme=default data-md-component=outdated hidden> </div> <header class="md-header md-header--shadow md-header--lifted" data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=../../.. title=Hatch class="md-header__button md-logo" aria-label=Hatch data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19.5 14.5A7.5 7.5 0 0 1 12 22a7.5 7.5 0 0 1-7.5-7.5C4.5 10.36 7.86 2 12 2c4.14 0 7.5 8.36 7.5 12.5Z"/></svg> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> Hatch </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> Environment plugins </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme=slate data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_0> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to dark mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_0 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5c-.84 0-1.65.15-2.39.42L12 2M3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29L3.34 7m.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14L3.36 17M20.65 7l-1.77 3.79a7.023 7.023 0 0 0-2.38-4.15l4.15.36m-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29L20.64 17M12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44L12 22Z"/></svg> </label> </form> <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg> </label> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query aria-label=Search placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=search-query required> <label class="md-search__icon md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </label> <nav class=md-search__options aria-label=Search> <button type=reset class="md-search__icon md-icon" title=Clear aria-label=Clear tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg> </button> </nav> </form> <div class=md-search__output> <div class=md-search__scrollwrap data-md-scrollfix> <div class=md-search-result data-md-component=search-result> <div class=md-search-result__meta> Initializing search </div> <ol class=md-search-result__list role=presentation></ol> </div> </div> </div> </div> </div> <div class=md-header__source> <a href=https://github.com/pypa/hatch title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 480 512"><!-- Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg> </div> <div class=md-source__repository> pypa/hatch </div> </a> </div> </nav> <nav class=md-tabs aria-label=Tabs data-md-component=tabs> <div class=md-grid> <ul class=md-tabs__list> <li class=md-tabs__item> <a href=../../.. class=md-tabs__link> Home </a> </li> <li class=md-tabs__item> <a href=../../../config/metadata/ class=md-tabs__link> Configuration </a> </li> <li class=md-tabs__item> <a href=../../../cli/about/ class=md-tabs__link> CLI </a> </li> <li class="md-tabs__item md-tabs__item--active"> <a href=../../about/ class=md-tabs__link> Plugins </a> </li> <li class=md-tabs__item> <a href=../../../how-to/meta/report-issues/ class=md-tabs__link> How-to </a> </li> <li class=md-tabs__item> <a href=../../../tutorials/python/manage/ class=md-tabs__link> Tutorials </a> </li> <li class=md-tabs__item> <a href=../../../meta/faq/ class=md-tabs__link> Meta </a> </li> <li class=md-tabs__item> <a href=../../../blog/ class=md-tabs__link> Blog </a> </li> </ul> </div> </nav> </header> <div class=md-container data-md-component=container> <main class=md-main data-md-component=main> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component=sidebar data-md-type=navigation> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--primary md-nav--lifted" aria-label=Navigation data-md-level=0> <label class=md-nav__title for=__drawer> <a href=../../.. title=Hatch class="md-nav__button md-logo" aria-label=Hatch data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19.5 14.5A7.5 7.5 0 0 1 12 22a7.5 7.5 0 0 1-7.5-7.5C4.5 10.36 7.86 2 12 2c4.14 0 7.5 8.36 7.5 12.5Z"/></svg> </a> Hatch </label> <div class=md-nav__source> <a href=https://github.com/pypa/hatch title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 480 512"><!-- Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg> </div> <div class=md-source__repository> pypa/hatch </div> </a> </div> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_1> <label class=md-nav__link for=__nav_1 id=__nav_1_label tabindex=0> <span class=md-ellipsis> Home </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_1_label aria-expanded=false> <label class=md-nav__title for=__nav_1> <span class="md-nav__icon md-icon"></span> Home </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../.. class=md-nav__link> <span class=md-ellipsis> About </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_1_2> <label class=md-nav__link for=__nav_1_2 id=__nav_1_2_label tabindex=0> <span class=md-ellipsis> Walkthrough </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_1_2_label aria-expanded=false> <label class=md-nav__title for=__nav_1_2> <span class="md-nav__icon md-icon"></span> Walkthrough </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../install/ class=md-nav__link> <span class=md-ellipsis> Installation </span> </a> </li> <li class=md-nav__item> <a href=../../../intro/ class=md-nav__link> <span class=md-ellipsis> Introduction </span> </a> </li> <li class=md-nav__item> <a href=../../../environment/ class=md-nav__link> <span class=md-ellipsis> Environments </span> </a> </li> <li class=md-nav__item> <a href=../../../version/ class=md-nav__link> <span class=md-ellipsis> Versioning </span> </a> </li> <li class=md-nav__item> <a href=../../../build/ class=md-nav__link> <span class=md-ellipsis> Builds </span> </a> </li> <li class=md-nav__item> <a href=../../../publish/ class=md-nav__link> <span class=md-ellipsis> Publishing </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_1_3> <label class=md-nav__link for=__nav_1_3 id=__nav_1_3_label tabindex=0> <span class=md-ellipsis> Learn </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_1_3_label aria-expanded=false> <label class=md-nav__title for=__nav_1_3> <span class="md-nav__icon md-icon"></span> Learn </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../next-steps/ class=md-nav__link> <span class=md-ellipsis> Next steps </span> </a> </li> <li class=md-nav__item> <a href=../../../why/ class=md-nav__link> <span class=md-ellipsis> Why Hatch? </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_1_4> <label class=md-nav__link for=__nav_1_4 id=__nav_1_4_label tabindex=0> <span class=md-ellipsis> History </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_1_4_label aria-expanded=false> <label class=md-nav__title for=__nav_1_4> <span class="md-nav__icon md-icon"></span> History </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../history/hatch/ class=md-nav__link> <span class=md-ellipsis> Hatch </span> </a> </li> <li class=md-nav__item> <a href=../../../history/hatchling/ class=md-nav__link> <span class=md-ellipsis> Hatchling </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_1_5> <label class=md-nav__link for=__nav_1_5 id=__nav_1_5_label tabindex=0> <span class=md-ellipsis> Community </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_1_5_label aria-expanded=false> <label class=md-nav__title for=__nav_1_5> <span class="md-nav__icon md-icon"></span> Community </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../community/users/ class=md-nav__link> <span class=md-ellipsis> Users </span> </a> </li> <li class=md-nav__item> <a href=../../../community/highlights/ class=md-nav__link> <span class=md-ellipsis> Highlights </span> </a> </li> <li class=md-nav__item> <a href=../../../community/contributing/ class=md-nav__link> <span class=md-ellipsis> Contributing </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2> <label class=md-nav__link for=__nav_2 id=__nav_2_label tabindex=0> <span class=md-ellipsis> Configuration </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_2_label aria-expanded=false> <label class=md-nav__title for=__nav_2> <span class="md-nav__icon md-icon"></span> Configuration </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../config/metadata/ class=md-nav__link> <span class=md-ellipsis> Metadata </span> </a> </li> <li class=md-nav__item> <a href=../../../config/dependency/ class=md-nav__link> <span class=md-ellipsis> Dependencies </span> </a> </li> <li class=md-nav__item> <a href=../../../config/build/ class=md-nav__link> <span class=md-ellipsis> Build </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_4> <label class=md-nav__link for=__nav_2_4 id=__nav_2_4_label tabindex=0> <span class=md-ellipsis> Environments </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_2_4_label aria-expanded=false> <label class=md-nav__title for=__nav_2_4> <span class="md-nav__icon md-icon"></span> Environments </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../config/environment/overview/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> <li class=md-nav__item> <a href=../../../config/environment/advanced/ class=md-nav__link> <span class=md-ellipsis> Advanced </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_5> <label class=md-nav__link for=__nav_2_5 id=__nav_2_5_label tabindex=0> <span class=md-ellipsis> Internal </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_2_5_label aria-expanded=false> <label class=md-nav__title for=__nav_2_5> <span class="md-nav__icon md-icon"></span> Internal </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../config/internal/testing/ class=md-nav__link> <span class=md-ellipsis> Testing </span> </a> </li> <li class=md-nav__item> <a href=../../../config/internal/static-analysis/ class=md-nav__link> <span class=md-ellipsis> Static analysis </span> </a> </li> <li class=md-nav__item> <a href=../../../config/internal/build/ class=md-nav__link> <span class=md-ellipsis> Building </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../../config/context/ class=md-nav__link> <span class=md-ellipsis> Context formatting </span> </a> </li> <li class=md-nav__item> <a href=../../../config/project-templates/ class=md-nav__link> <span class=md-ellipsis> Project templates </span> </a> </li> <li class=md-nav__item> <a href=../../../config/hatch/ class=md-nav__link> <span class=md-ellipsis> Hatch </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_3> <label class=md-nav__link for=__nav_3 id=__nav_3_label tabindex=0> <span class=md-ellipsis> CLI </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_3_label aria-expanded=false> <label class=md-nav__title for=__nav_3> <span class="md-nav__icon md-icon"></span> CLI </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../cli/about/ class=md-nav__link> <span class=md-ellipsis> About </span> </a> </li> <li class=md-nav__item> <a href=../../../cli/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_4 checked> <label class=md-nav__link for=__nav_4 id=__nav_4_label tabindex> <span class=md-ellipsis> Plugins </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_4_label aria-expanded=true> <label class=md-nav__title for=__nav_4> <span class="md-nav__icon md-icon"></span> Plugins </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../about/ class=md-nav__link> <span class=md-ellipsis> About </span> </a> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_2> <label class=md-nav__link for=__nav_4_2 id=__nav_4_2_label tabindex> <span class=md-ellipsis> Builder </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_2_label aria-expanded=false> <label class=md-nav__title for=__nav_4_2> <span class="md-nav__icon md-icon"></span> Builder </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../builder/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../builder/wheel/ class=md-nav__link> <span class=md-ellipsis> Wheel </span> </a> </li> <li class=md-nav__item> <a href=../../builder/sdist/ class=md-nav__link> <span class=md-ellipsis> Source distribution </span> </a> </li> <li class=md-nav__item> <a href=../../builder/binary/ class=md-nav__link> <span class=md-ellipsis> Binary </span> </a> </li> <li class=md-nav__item> <a href=../../builder/custom/ class=md-nav__link> <span class=md-ellipsis> Custom </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_3> <label class=md-nav__link for=__nav_4_3 id=__nav_4_3_label tabindex> <span class=md-ellipsis> Build hook </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_3_label aria-expanded=false> <label class=md-nav__title for=__nav_4_3> <span class="md-nav__icon md-icon"></span> Build hook </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../build-hook/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../build-hook/version/ class=md-nav__link> <span class=md-ellipsis> Version </span> </a> </li> <li class=md-nav__item> <a href=../../build-hook/custom/ class=md-nav__link> <span class=md-ellipsis> Custom </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_4> <label class=md-nav__link for=__nav_4_4 id=__nav_4_4_label tabindex> <span class=md-ellipsis> Metadata hook </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_4_label aria-expanded=false> <label class=md-nav__title for=__nav_4_4> <span class="md-nav__icon md-icon"></span> Metadata hook </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../metadata-hook/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../metadata-hook/custom/ class=md-nav__link> <span class=md-ellipsis> Custom </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_4_5 checked> <label class=md-nav__link for=__nav_4_5 id=__nav_4_5_label tabindex> <span class=md-ellipsis> Environment </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_5_label aria-expanded=true> <label class=md-nav__title for=__nav_4_5> <span class="md-nav__icon md-icon"></span> Environment </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type=checkbox id=__toc> <label class="md-nav__link md-nav__link--active" for=__toc> <span class=md-ellipsis> Reference </span> <span class="md-nav__icon md-icon"></span> </label> <a href=./ class="md-nav__link md-nav__link--active"> <span class=md-ellipsis> Reference </span> </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#known-third-party class=md-nav__link> <span class=md-ellipsis> Known third-party </span> </a> </li> <li class=md-nav__item> <a href=#installation class=md-nav__link> <span class=md-ellipsis> Installation </span> </a> </li> <li class=md-nav__item> <a href=#life-cycle class=md-nav__link> <span class=md-ellipsis> Life cycle </span> </a> </li> <li class=md-nav__item> <a href=#build-environments class=md-nav__link> <span class=md-ellipsis> Build environments </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface class=md-nav__link> <span class=md-ellipsis> EnvironmentInterface </span> </a> <nav class=md-nav aria-label=EnvironmentInterface> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.PLUGIN_NAME class=md-nav__link> <span class=md-ellipsis> PLUGIN_NAME </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.project_root class=md-nav__link> <span class=md-ellipsis> project_root </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.sep class=md-nav__link> <span class=md-ellipsis> sep </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.pathsep class=md-nav__link> <span class=md-ellipsis> pathsep </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app class=md-nav__link> <span class=md-ellipsis> app </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.root class=md-nav__link> <span class=md-ellipsis> root </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.name class=md-nav__link> <span class=md-ellipsis> name </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.data_directory class=md-nav__link> <span class=md-ellipsis> data_directory </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.isolated_data_directory class=md-nav__link> <span class=md-ellipsis> isolated_data_directory </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.config class=md-nav__link> <span class=md-ellipsis> config </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.platform class=md-nav__link> <span class=md-ellipsis> platform </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.environment_dependencies class=md-nav__link> <span class=md-ellipsis> environment_dependencies </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.dependencies class=md-nav__link> <span class=md-ellipsis> dependencies </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.env_vars class=md-nav__link> <span class=md-ellipsis> env_vars </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.env_include class=md-nav__link> <span class=md-ellipsis> env_include </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.env_exclude class=md-nav__link> <span class=md-ellipsis> env_exclude </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.platforms class=md-nav__link> <span class=md-ellipsis> platforms </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.skip_install class=md-nav__link> <span class=md-ellipsis> skip_install </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.dev_mode class=md-nav__link> <span class=md-ellipsis> dev_mode </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.description class=md-nav__link> <span class=md-ellipsis> description </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.find class=md-nav__link> <span class=md-ellipsis> find </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.create class=md-nav__link> <span class=md-ellipsis> create </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.remove class=md-nav__link> <span class=md-ellipsis> remove </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.exists class=md-nav__link> <span class=md-ellipsis> exists </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.install_project class=md-nav__link> <span class=md-ellipsis> install_project </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.install_project_dev_mode class=md-nav__link> <span class=md-ellipsis> install_project_dev_mode </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.dependencies_in_sync class=md-nav__link> <span class=md-ellipsis> dependencies_in_sync </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.sync_dependencies class=md-nav__link> <span class=md-ellipsis> sync_dependencies </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.dependency_hash class=md-nav__link> <span class=md-ellipsis> dependency_hash </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.fs_context class=md-nav__link> <span class=md-ellipsis> fs_context </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.activate class=md-nav__link> <span class=md-ellipsis> activate </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.deactivate class=md-nav__link> <span class=md-ellipsis> deactivate </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_creation class=md-nav__link> <span class=md-ellipsis> app_status_creation </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_pre_installation class=md-nav__link> <span class=md-ellipsis> app_status_pre_installation </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_post_installation class=md-nav__link> <span class=md-ellipsis> app_status_post_installation </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_project_installation class=md-nav__link> <span class=md-ellipsis> app_status_project_installation </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_state_check class=md-nav__link> <span class=md-ellipsis> app_status_dependency_state_check </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_installation_check class=md-nav__link> <span class=md-ellipsis> app_status_dependency_installation_check </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_synchronization class=md-nav__link> <span class=md-ellipsis> app_status_dependency_synchronization </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.command_context class=md-nav__link> <span class=md-ellipsis> command_context </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.enter_shell class=md-nav__link> <span class=md-ellipsis> enter_shell </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.run_shell_command class=md-nav__link> <span class=md-ellipsis> run_shell_command </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.resolve_commands class=md-nav__link> <span class=md-ellipsis> resolve_commands </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.get_env_vars class=md-nav__link> <span class=md-ellipsis> get_env_vars </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.apply_features class=md-nav__link> <span class=md-ellipsis> apply_features </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.construct_pip_install_command class=md-nav__link> <span class=md-ellipsis> construct_pip_install_command </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.join_command_args class=md-nav__link> <span class=md-ellipsis> join_command_args </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.check_compatibility class=md-nav__link> <span class=md-ellipsis> check_compatibility </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.get_option_types class=md-nav__link> <span class=md-ellipsis> get_option_types </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.get_env_var_option class=md-nav__link> <span class=md-ellipsis> get_env_var_option </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.get_context class=md-nav__link> <span class=md-ellipsis> get_context </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../virtual/ class=md-nav__link> <span class=md-ellipsis> Virtual </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_6> <label class=md-nav__link for=__nav_4_6 id=__nav_4_6_label tabindex> <span class=md-ellipsis> Environment collector </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_6_label aria-expanded=false> <label class=md-nav__title for=__nav_4_6> <span class="md-nav__icon md-icon"></span> Environment collector </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../environment-collector/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../environment-collector/custom/ class=md-nav__link> <span class=md-ellipsis> Custom </span> </a> </li> <li class=md-nav__item> <a href=../../environment-collector/default/ class=md-nav__link> <span class=md-ellipsis> Default </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_7> <label class=md-nav__link for=__nav_4_7 id=__nav_4_7_label tabindex> <span class=md-ellipsis> Publisher </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_7_label aria-expanded=false> <label class=md-nav__title for=__nav_4_7> <span class="md-nav__icon md-icon"></span> Publisher </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../publisher/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../publisher/package-index/ class=md-nav__link> <span class=md-ellipsis> Index </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_8> <label class=md-nav__link for=__nav_4_8 id=__nav_4_8_label tabindex> <span class=md-ellipsis> Version source </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_8_label aria-expanded=false> <label class=md-nav__title for=__nav_4_8> <span class="md-nav__icon md-icon"></span> Version source </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../version-source/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../version-source/regex/ class=md-nav__link> <span class=md-ellipsis> Regex </span> </a> </li> <li class=md-nav__item> <a href=../../version-source/code/ class=md-nav__link> <span class=md-ellipsis> Code </span> </a> </li> <li class=md-nav__item> <a href=../../version-source/env/ class=md-nav__link> <span class=md-ellipsis> Environment </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_9> <label class=md-nav__link for=__nav_4_9 id=__nav_4_9_label tabindex> <span class=md-ellipsis> Version scheme </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_9_label aria-expanded=false> <label class=md-nav__title for=__nav_4_9> <span class="md-nav__icon md-icon"></span> Version scheme </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../version-scheme/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../version-scheme/standard/ class=md-nav__link> <span class=md-ellipsis> Standard </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../utilities/ class=md-nav__link> <span class=md-ellipsis> Utilities </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5> <label class=md-nav__link for=__nav_5 id=__nav_5_label tabindex=0> <span class=md-ellipsis> How-to </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_5_label aria-expanded=false> <label class=md-nav__title for=__nav_5> <span class="md-nav__icon md-icon"></span> How-to </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_1> <label class=md-nav__link for=__nav_5_1 id=__nav_5_1_label tabindex=0> <span class=md-ellipsis> Meta </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_1_label aria-expanded=false> <label class=md-nav__title for=__nav_5_1> <span class="md-nav__icon md-icon"></span> Meta </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../how-to/meta/report-issues/ class=md-nav__link> <span class=md-ellipsis> Report issues </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_2> <label class=md-nav__link for=__nav_5_2 id=__nav_5_2_label tabindex=0> <span class=md-ellipsis> Integrate </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_2_label aria-expanded=false> <label class=md-nav__title for=__nav_5_2> <span class="md-nav__icon md-icon"></span> Integrate </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../how-to/integrate/vscode/ class=md-nav__link> <span class=md-ellipsis> Visual Studio Code </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_3> <label class=md-nav__link for=__nav_5_3 id=__nav_5_3_label tabindex=0> <span class=md-ellipsis> Run </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_3_label aria-expanded=false> <label class=md-nav__title for=__nav_5_3> <span class="md-nav__icon md-icon"></span> Run </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../how-to/run/python-scripts/ class=md-nav__link> <span class=md-ellipsis> Python scripts </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_4> <label class=md-nav__link for=__nav_5_4 id=__nav_5_4_label tabindex=0> <span class=md-ellipsis> Config </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_4_label aria-expanded=false> <label class=md-nav__title for=__nav_5_4> <span class="md-nav__icon md-icon"></span> Config </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../how-to/config/dynamic-metadata/ class=md-nav__link> <span class=md-ellipsis> Dynamic metadata </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_5> <label class=md-nav__link for=__nav_5_5 id=__nav_5_5_label tabindex=0> <span class=md-ellipsis> Environments </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_5_label aria-expanded=false> <label class=md-nav__title for=__nav_5_5> <span class="md-nav__icon md-icon"></span> Environments </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../how-to/environment/select-installer/ class=md-nav__link> <span class=md-ellipsis> Select installer </span> </a> </li> <li class=md-nav__item> <a href=../../../how-to/environment/dependency-resolution/ class=md-nav__link> <span class=md-ellipsis> Dependency resolution </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_6> <label class=md-nav__link for=__nav_5_6 id=__nav_5_6_label tabindex=0> <span class=md-ellipsis> Static analysis </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_6_label aria-expanded=false> <label class=md-nav__title for=__nav_5_6> <span class="md-nav__icon md-icon"></span> Static analysis </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../how-to/static-analysis/behavior/ class=md-nav__link> <span class=md-ellipsis> Customize behavior </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_7> <label class=md-nav__link for=__nav_5_7 id=__nav_5_7_label tabindex=0> <span class=md-ellipsis> Python </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_7_label aria-expanded=false> <label class=md-nav__title for=__nav_5_7> <span class="md-nav__icon md-icon"></span> Python </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../how-to/python/custom/ class=md-nav__link> <span class=md-ellipsis> Custom distributions </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_8> <label class=md-nav__link for=__nav_5_8 id=__nav_5_8_label tabindex=0> <span class=md-ellipsis> Publishing </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_8_label aria-expanded=false> <label class=md-nav__title for=__nav_5_8> <span class="md-nav__icon md-icon"></span> Publishing </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../how-to/publish/auth/ class=md-nav__link> <span class=md-ellipsis> Authentication </span> </a> </li> <li class=md-nav__item> <a href=../../../how-to/publish/repo/ class=md-nav__link> <span class=md-ellipsis> Repository selection </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_9> <label class=md-nav__link for=__nav_5_9 id=__nav_5_9_label tabindex=0> <span class=md-ellipsis> Plugins </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_9_label aria-expanded=false> <label class=md-nav__title for=__nav_5_9> <span class="md-nav__icon md-icon"></span> Plugins </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../how-to/plugins/testing-builds/ class=md-nav__link> <span class=md-ellipsis> Testing builds </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_6> <label class=md-nav__link for=__nav_6 id=__nav_6_label tabindex=0> <span class=md-ellipsis> Tutorials </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_6_label aria-expanded=false> <label class=md-nav__title for=__nav_6> <span class="md-nav__icon md-icon"></span> Tutorials </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_6_1> <label class=md-nav__link for=__nav_6_1 id=__nav_6_1_label tabindex=0> <span class=md-ellipsis> Python </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_6_1_label aria-expanded=false> <label class=md-nav__title for=__nav_6_1> <span class="md-nav__icon md-icon"></span> Python </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../tutorials/python/manage/ class=md-nav__link> <span class=md-ellipsis> Management </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_6_2> <label class=md-nav__link for=__nav_6_2 id=__nav_6_2_label tabindex=0> <span class=md-ellipsis> Environments </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_6_2_label aria-expanded=false> <label class=md-nav__title for=__nav_6_2> <span class="md-nav__icon md-icon"></span> Environments </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../tutorials/environment/basic-usage/ class=md-nav__link> <span class=md-ellipsis> Basic usage </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_6_3> <label class=md-nav__link for=__nav_6_3 id=__nav_6_3_label tabindex=0> <span class=md-ellipsis> Testing </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_6_3_label aria-expanded=false> <label class=md-nav__title for=__nav_6_3> <span class="md-nav__icon md-icon"></span> Testing </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../tutorials/testing/overview/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_7> <label class=md-nav__link for=__nav_7 id=__nav_7_label tabindex=0> <span class=md-ellipsis> Meta </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_7_label aria-expanded=false> <label class=md-nav__title for=__nav_7> <span class="md-nav__icon md-icon"></span> Meta </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../meta/faq/ class=md-nav__link> <span class=md-ellipsis> FAQ </span> </a> </li> <li class=md-nav__item> <a href=../../../meta/authors/ class=md-nav__link> <span class=md-ellipsis> Authors </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_8> <label class=md-nav__link for=__nav_8 id=__nav_8_label tabindex=0> <span class=md-ellipsis> Blog </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_8_label aria-expanded=false> <label class=md-nav__title for=__nav_8> <span class="md-nav__icon md-icon"></span> Blog </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../blog/ class=md-nav__link> <span class=md-ellipsis> Blog </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_8_2> <label class=md-nav__link for=__nav_8_2 id=__nav_8_2_label tabindex=0> <span class=md-ellipsis> Archive </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_8_2_label aria-expanded=false> <label class=md-nav__title for=__nav_8_2> <span class="md-nav__icon md-icon"></span> Archive </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../blog/archive/2024/ class=md-nav__link> <span class=md-ellipsis> 2024 </span> </a> </li> <li class=md-nav__item> <a href=../../../blog/archive/2023/ class=md-nav__link> <span class=md-ellipsis> 2023 </span> </a> </li> <li class=md-nav__item> <a href=../../../blog/archive/2022/ class=md-nav__link> <span class=md-ellipsis> 2022 </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_8_3> <label class=md-nav__link for=__nav_8_3 id=__nav_8_3_label tabindex=0> <span class=md-ellipsis> Categories </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_8_3_label aria-expanded=false> <label class=md-nav__title for=__nav_8_3> <span class="md-nav__icon md-icon"></span> Categories </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../../blog/category/release/ class=md-nav__link> <span class=md-ellipsis> Release </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=sidebar data-md-type=toc> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#known-third-party class=md-nav__link> <span class=md-ellipsis> Known third-party </span> </a> </li> <li class=md-nav__item> <a href=#installation class=md-nav__link> <span class=md-ellipsis> Installation </span> </a> </li> <li class=md-nav__item> <a href=#life-cycle class=md-nav__link> <span class=md-ellipsis> Life cycle </span> </a> </li> <li class=md-nav__item> <a href=#build-environments class=md-nav__link> <span class=md-ellipsis> Build environments </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface class=md-nav__link> <span class=md-ellipsis> EnvironmentInterface </span> </a> <nav class=md-nav aria-label=EnvironmentInterface> <ul class=md-nav__list> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.PLUGIN_NAME class=md-nav__link> <span class=md-ellipsis> PLUGIN_NAME </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.project_root class=md-nav__link> <span class=md-ellipsis> project_root </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.sep class=md-nav__link> <span class=md-ellipsis> sep </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.pathsep class=md-nav__link> <span class=md-ellipsis> pathsep </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app class=md-nav__link> <span class=md-ellipsis> app </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.root class=md-nav__link> <span class=md-ellipsis> root </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.name class=md-nav__link> <span class=md-ellipsis> name </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.data_directory class=md-nav__link> <span class=md-ellipsis> data_directory </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.isolated_data_directory class=md-nav__link> <span class=md-ellipsis> isolated_data_directory </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.config class=md-nav__link> <span class=md-ellipsis> config </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.platform class=md-nav__link> <span class=md-ellipsis> platform </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.environment_dependencies class=md-nav__link> <span class=md-ellipsis> environment_dependencies </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.dependencies class=md-nav__link> <span class=md-ellipsis> dependencies </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.env_vars class=md-nav__link> <span class=md-ellipsis> env_vars </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.env_include class=md-nav__link> <span class=md-ellipsis> env_include </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.env_exclude class=md-nav__link> <span class=md-ellipsis> env_exclude </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.platforms class=md-nav__link> <span class=md-ellipsis> platforms </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.skip_install class=md-nav__link> <span class=md-ellipsis> skip_install </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.dev_mode class=md-nav__link> <span class=md-ellipsis> dev_mode </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.description class=md-nav__link> <span class=md-ellipsis> description </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.find class=md-nav__link> <span class=md-ellipsis> find </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.create class=md-nav__link> <span class=md-ellipsis> create </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.remove class=md-nav__link> <span class=md-ellipsis> remove </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.exists class=md-nav__link> <span class=md-ellipsis> exists </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.install_project class=md-nav__link> <span class=md-ellipsis> install_project </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.install_project_dev_mode class=md-nav__link> <span class=md-ellipsis> install_project_dev_mode </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.dependencies_in_sync class=md-nav__link> <span class=md-ellipsis> dependencies_in_sync </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.sync_dependencies class=md-nav__link> <span class=md-ellipsis> sync_dependencies </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.dependency_hash class=md-nav__link> <span class=md-ellipsis> dependency_hash </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.fs_context class=md-nav__link> <span class=md-ellipsis> fs_context </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.activate class=md-nav__link> <span class=md-ellipsis> activate </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.deactivate class=md-nav__link> <span class=md-ellipsis> deactivate </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_creation class=md-nav__link> <span class=md-ellipsis> app_status_creation </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_pre_installation class=md-nav__link> <span class=md-ellipsis> app_status_pre_installation </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_post_installation class=md-nav__link> <span class=md-ellipsis> app_status_post_installation </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_project_installation class=md-nav__link> <span class=md-ellipsis> app_status_project_installation </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_state_check class=md-nav__link> <span class=md-ellipsis> app_status_dependency_state_check </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_installation_check class=md-nav__link> <span class=md-ellipsis> app_status_dependency_installation_check </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_synchronization class=md-nav__link> <span class=md-ellipsis> app_status_dependency_synchronization </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.command_context class=md-nav__link> <span class=md-ellipsis> command_context </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.enter_shell class=md-nav__link> <span class=md-ellipsis> enter_shell </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.run_shell_command class=md-nav__link> <span class=md-ellipsis> run_shell_command </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.resolve_commands class=md-nav__link> <span class=md-ellipsis> resolve_commands </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.get_env_vars class=md-nav__link> <span class=md-ellipsis> get_env_vars </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.apply_features class=md-nav__link> <span class=md-ellipsis> apply_features </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.construct_pip_install_command class=md-nav__link> <span class=md-ellipsis> construct_pip_install_command </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.join_command_args class=md-nav__link> <span class=md-ellipsis> join_command_args </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.check_compatibility class=md-nav__link> <span class=md-ellipsis> check_compatibility </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.get_option_types class=md-nav__link> <span class=md-ellipsis> get_option_types </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.get_env_var_option class=md-nav__link> <span class=md-ellipsis> get_env_var_option </span> </a> </li> <li class=md-nav__item> <a href=#hatch.env.plugin.interface.EnvironmentInterface.get_context class=md-nav__link> <span class=md-ellipsis> get_context </span> </a> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class=md-content data-md-component=content> <article class="md-content__inner md-typeset"> <a href=https://github.com/pypa/hatch/blob/master/docs/plugins/environment/reference.md title="Edit this page" class="md-content__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4v-2m10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1 2.1 2.1Z"/></svg> </a> <h1 id=environment-plugins>Environment plugins<a class=headerlink href=#environment-plugins title="Permanent link">&para;</a></h1> <hr> <p>See the documentation for <a href=../../../config/environment/overview/ >environment configuration</a>.</p> <h2 id=known-third-party>Known third-party<a class=headerlink href=#known-third-party title="Permanent link">&para;</a></h2> <ul> <li><a href=https://github.com/OldGrumpyViking/hatch-conda>hatch-conda</a> - environments backed by Conda/Mamba</li> <li><a href=https://github.com/ofek/hatch-containers>hatch-containers</a> - environments run inside containers</li> <li><a href=https://github.com/juftin/hatch-pip-compile>hatch-pip-compile</a> - use <a href=https://github.com/jazzband/pip-tools>pip-compile</a> to manage project dependencies and lockfiles</li> <li><a href=https://github.com/sbidoul/hatch-pip-deepfreeze>hatch-pip-deepfreeze</a> - <a href=../virtual/ >virtual</a> environments with dependency locking by <a href=https://github.com/sbidoul/pip-deepfreeze>pip-deepfreeze</a></li> </ul> <h2 id=installation>Installation<a class=headerlink href=#installation title="Permanent link">&para;</a></h2> <p>Any required environment types that are not built-in must be manually installed alongside Hatch or listed in the <code>tool.hatch.env.requires</code> array for automatic management:</p> <div class="tabbed-set tabbed-alternate" data-tabs=1:2><input checked=checked id=pyprojecttoml name=__tabbed_1 type=radio><input id=hatchtoml name=__tabbed_1 type=radio><div class=tabbed-labels><label for=pyprojecttoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> pyproject.toml</label><label for=hatchtoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> hatch.toml</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[tool.hatch.env]</span>
<span class=n>requires</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
<span class=w> </span><span class=s2>&quot;...&quot;</span><span class=p>,</span>
<span class=p>]</span>
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[env]</span>
<span class=n>requires</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
<span class=w> </span><span class=s2>&quot;...&quot;</span><span class=p>,</span>
<span class=p>]</span>
</code></pre></div> </div> </div> </div> <h2 id=life-cycle>Life cycle<a class=headerlink href=#life-cycle title="Permanent link">&para;</a></h2> <p>Whenever an environment is used, the following logic is performed:</p> <div class="doc doc-object doc-function"> <div class="doc doc-contents first"> <details class=quote> <summary>Source code in <code>src/hatch/project/core.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="149 "></span><span class=k>def</span> <span class=nf>prepare_environment</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>environment</span><span class=p>:</span> <span class=n>EnvironmentInterface</span><span class=p>):</span>
<span class=linenos data-linenos="150 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=n>environment</span><span class=o>.</span><span class=n>exists</span><span class=p>():</span>
<span class=linenos data-linenos="151 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>env_metadata</span><span class=o>.</span><span class=n>reset</span><span class=p>(</span><span class=n>environment</span><span class=p>)</span>
<span class=linenos data-linenos="152 "></span>
<span class=linenos data-linenos="153 "></span> <span class=k>with</span> <span class=n>environment</span><span class=o>.</span><span class=n>app_status_creation</span><span class=p>():</span>
<span class=linenos data-linenos="154 "></span> <span class=n>environment</span><span class=o>.</span><span class=n>create</span><span class=p>()</span>
<span class=linenos data-linenos="155 "></span>
<span class=linenos data-linenos="156 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=n>environment</span><span class=o>.</span><span class=n>skip_install</span><span class=p>:</span>
<span class=linenos data-linenos="157 "></span> <span class=k>if</span> <span class=n>environment</span><span class=o>.</span><span class=n>pre_install_commands</span><span class=p>:</span>
<span class=linenos data-linenos="158 "></span> <span class=k>with</span> <span class=n>environment</span><span class=o>.</span><span class=n>app_status_pre_installation</span><span class=p>():</span>
<span class=linenos data-linenos="159 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>run_shell_commands</span><span class=p>(</span>
<span class=linenos data-linenos="160 "></span> <span class=n>ExecutionContext</span><span class=p>(</span>
<span class=linenos data-linenos="161 "></span> <span class=n>environment</span><span class=p>,</span>
<span class=linenos data-linenos="162 "></span> <span class=n>shell_commands</span><span class=o>=</span><span class=n>environment</span><span class=o>.</span><span class=n>pre_install_commands</span><span class=p>,</span>
<span class=linenos data-linenos="163 "></span> <span class=n>source</span><span class=o>=</span><span class=s1>&#39;pre-install&#39;</span><span class=p>,</span>
<span class=linenos data-linenos="164 "></span> <span class=n>show_code_on_error</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
<span class=linenos data-linenos="165 "></span> <span class=p>)</span>
<span class=linenos data-linenos="166 "></span> <span class=p>)</span>
<span class=linenos data-linenos="167 "></span>
<span class=linenos data-linenos="168 "></span> <span class=k>with</span> <span class=n>environment</span><span class=o>.</span><span class=n>app_status_project_installation</span><span class=p>():</span>
<span class=linenos data-linenos="169 "></span> <span class=k>if</span> <span class=n>environment</span><span class=o>.</span><span class=n>dev_mode</span><span class=p>:</span>
<span class=linenos data-linenos="170 "></span> <span class=n>environment</span><span class=o>.</span><span class=n>install_project_dev_mode</span><span class=p>()</span>
<span class=linenos data-linenos="171 "></span> <span class=k>else</span><span class=p>:</span>
<span class=linenos data-linenos="172 "></span> <span class=n>environment</span><span class=o>.</span><span class=n>install_project</span><span class=p>()</span>
<span class=linenos data-linenos="173 "></span>
<span class=linenos data-linenos="174 "></span> <span class=k>if</span> <span class=n>environment</span><span class=o>.</span><span class=n>post_install_commands</span><span class=p>:</span>
<span class=linenos data-linenos="175 "></span> <span class=k>with</span> <span class=n>environment</span><span class=o>.</span><span class=n>app_status_post_installation</span><span class=p>():</span>
<span class=linenos data-linenos="176 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>run_shell_commands</span><span class=p>(</span>
<span class=linenos data-linenos="177 "></span> <span class=n>ExecutionContext</span><span class=p>(</span>
<span class=linenos data-linenos="178 "></span> <span class=n>environment</span><span class=p>,</span>
<span class=linenos data-linenos="179 "></span> <span class=n>shell_commands</span><span class=o>=</span><span class=n>environment</span><span class=o>.</span><span class=n>post_install_commands</span><span class=p>,</span>
<span class=linenos data-linenos="180 "></span> <span class=n>source</span><span class=o>=</span><span class=s1>&#39;post-install&#39;</span><span class=p>,</span>
<span class=linenos data-linenos="181 "></span> <span class=n>show_code_on_error</span><span class=o>=</span><span class=kc>True</span><span class=p>,</span>
<span class=linenos data-linenos="182 "></span> <span class=p>)</span>
<span class=linenos data-linenos="183 "></span> <span class=p>)</span>
<span class=linenos data-linenos="184 "></span>
<span class=linenos data-linenos="185 "></span> <span class=k>with</span> <span class=n>environment</span><span class=o>.</span><span class=n>app_status_dependency_state_check</span><span class=p>():</span>
<span class=linenos data-linenos="186 "></span> <span class=n>new_dep_hash</span> <span class=o>=</span> <span class=n>environment</span><span class=o>.</span><span class=n>dependency_hash</span><span class=p>()</span>
<span class=linenos data-linenos="187 "></span>
<span class=linenos data-linenos="188 "></span> <span class=n>current_dep_hash</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>env_metadata</span><span class=o>.</span><span class=n>dependency_hash</span><span class=p>(</span><span class=n>environment</span><span class=p>)</span>
<span class=linenos data-linenos="189 "></span> <span class=k>if</span> <span class=n>new_dep_hash</span> <span class=o>!=</span> <span class=n>current_dep_hash</span><span class=p>:</span>
<span class=linenos data-linenos="190 "></span> <span class=k>with</span> <span class=n>environment</span><span class=o>.</span><span class=n>app_status_dependency_installation_check</span><span class=p>():</span>
<span class=linenos data-linenos="191 "></span> <span class=n>dependencies_in_sync</span> <span class=o>=</span> <span class=n>environment</span><span class=o>.</span><span class=n>dependencies_in_sync</span><span class=p>()</span>
<span class=linenos data-linenos="192 "></span>
<span class=linenos data-linenos="193 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=n>dependencies_in_sync</span><span class=p>:</span>
<span class=linenos data-linenos="194 "></span> <span class=k>with</span> <span class=n>environment</span><span class=o>.</span><span class=n>app_status_dependency_synchronization</span><span class=p>():</span>
<span class=linenos data-linenos="195 "></span> <span class=n>environment</span><span class=o>.</span><span class=n>sync_dependencies</span><span class=p>()</span>
<span class=linenos data-linenos="196 "></span> <span class=n>new_dep_hash</span> <span class=o>=</span> <span class=n>environment</span><span class=o>.</span><span class=n>dependency_hash</span><span class=p>()</span>
<span class=linenos data-linenos="197 "></span>
<span class=linenos data-linenos="198 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>env_metadata</span><span class=o>.</span><span class=n>update_dependency_hash</span><span class=p>(</span><span class=n>environment</span><span class=p>,</span> <span class=n>new_dep_hash</span><span class=p>)</span>
</code></pre></div> </details> </div> </div><h2 id=build-environments>Build environments<a class=headerlink href=#build-environments title="Permanent link">&para;</a></h2> <p>All environment types should <a href=#hatch.env.plugin.interface.EnvironmentInterface.fs_context>offer support</a> for synchronized storage between the local file system and the environment. This functionality is used in the following scenarios:</p> <ul> <li>the <a href=../../../cli/reference/#hatch-build><code>build</code></a> command</li> <li>commands that read dependencies, like <a href=../../../cli/reference/#hatch-dep-hash><code>dep hash</code></a>, if any <a href=../../../config/metadata/#dependencies>project dependencies</a> are <a href=../../../config/metadata/#dynamic>set dynamically</a></li> </ul> <div class="doc doc-object doc-class"> <h2 id=hatch.env.plugin.interface.EnvironmentInterface class="doc doc-heading"> <code>EnvironmentInterface</code> <a href=#hatch.env.plugin.interface.EnvironmentInterface class=headerlink title="Permanent link">&para;</a></h2> <div class="doc doc-contents first"> <p>Example usage:</p> <div class="tabbed-set tabbed-alternate" data-tabs=1:2><input checked=checked id=hatch.env.plugin.interface.EnvironmentInterface--pluginpy name=hatch.env.plugin.interface.EnvironmentInterface--__tabbed_1 type=radio><input id=hatch.env.plugin.interface.EnvironmentInterface--hookspy name=hatch.env.plugin.interface.EnvironmentInterface--__tabbed_1 type=radio><div class=tabbed-labels><label for=hatch.env.plugin.interface.EnvironmentInterface--pluginpy><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> plugin.py</label><label for=hatch.env.plugin.interface.EnvironmentInterface--hookspy><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> hooks.py</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><pre><span></span><code> <span class=kn>from</span> <span class=nn>hatch.env.plugin.interface</span> <span class=kn>import</span> <span class=n>EnvironmentInterface</span>
<span class=k>class</span> <span class=nc>SpecialEnvironment</span><span class=p>(</span><span class=n>EnvironmentInterface</span><span class=p>):</span>
<span class=n>PLUGIN_NAME</span> <span class=o>=</span> <span class=s1>&#39;special&#39;</span>
<span class=o>...</span>
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code> <span class=kn>from</span> <span class=nn>hatchling.plugin</span> <span class=kn>import</span> <span class=n>hookimpl</span>
<span class=kn>from</span> <span class=nn>.plugin</span> <span class=kn>import</span> <span class=n>SpecialEnvironment</span>
<span class=nd>@hookimpl</span>
<span class=k>def</span> <span class=nf>hatch_register_environment</span><span class=p>():</span>
<span class=k>return</span> <span class=n>SpecialEnvironment</span>
</code></pre></div> </div> </div> </div> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos=" 22 "></span><span class=k>class</span> <span class=nc>EnvironmentInterface</span><span class=p>(</span><span class=n>ABC</span><span class=p>):</span>
<span class=linenos data-linenos=" 23 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos=" 24 "></span><span class=sd> Example usage:</span>
<span class=linenos data-linenos=" 25 "></span>
<span class=linenos data-linenos=" 26 "></span><span class=sd> ```python tab=&quot;plugin.py&quot;</span>
<span class=linenos data-linenos=" 27 "></span><span class=sd> from hatch.env.plugin.interface import EnvironmentInterface</span>
<span class=linenos data-linenos=" 28 "></span>
<span class=linenos data-linenos=" 29 "></span>
<span class=linenos data-linenos=" 30 "></span><span class=sd> class SpecialEnvironment(EnvironmentInterface):</span>
<span class=linenos data-linenos=" 31 "></span><span class=sd> PLUGIN_NAME = &#39;special&#39;</span>
<span class=linenos data-linenos=" 32 "></span><span class=sd> ...</span>
<span class=linenos data-linenos=" 33 "></span><span class=sd> ```</span>
<span class=linenos data-linenos=" 34 "></span>
<span class=linenos data-linenos=" 35 "></span><span class=sd> ```python tab=&quot;hooks.py&quot;</span>
<span class=linenos data-linenos=" 36 "></span><span class=sd> from hatchling.plugin import hookimpl</span>
<span class=linenos data-linenos=" 37 "></span>
<span class=linenos data-linenos=" 38 "></span><span class=sd> from .plugin import SpecialEnvironment</span>
<span class=linenos data-linenos=" 39 "></span>
<span class=linenos data-linenos=" 40 "></span>
<span class=linenos data-linenos=" 41 "></span><span class=sd> @hookimpl</span>
<span class=linenos data-linenos=" 42 "></span><span class=sd> def hatch_register_environment():</span>
<span class=linenos data-linenos=" 43 "></span><span class=sd> return SpecialEnvironment</span>
<span class=linenos data-linenos=" 44 "></span><span class=sd> ```</span>
<span class=linenos data-linenos=" 45 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos=" 46 "></span>
<span class=linenos data-linenos=" 47 "></span> <span class=n>PLUGIN_NAME</span> <span class=o>=</span> <span class=s1>&#39;&#39;</span>
<span class=linenos data-linenos=" 48 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;The name used for selection.&quot;&quot;&quot;</span>
<span class=linenos data-linenos=" 49 "></span>
<span class=linenos data-linenos=" 50 "></span> <span class=k>def</span> <span class=fm>__init__</span><span class=p>(</span>
<span class=linenos data-linenos=" 51 "></span> <span class=bp>self</span><span class=p>,</span>
<span class=linenos data-linenos=" 52 "></span> <span class=n>root</span><span class=p>,</span>
<span class=linenos data-linenos=" 53 "></span> <span class=n>metadata</span><span class=p>,</span>
<span class=linenos data-linenos=" 54 "></span> <span class=n>name</span><span class=p>,</span>
<span class=linenos data-linenos=" 55 "></span> <span class=n>config</span><span class=p>,</span>
<span class=linenos data-linenos=" 56 "></span> <span class=n>matrix_variables</span><span class=p>,</span>
<span class=linenos data-linenos=" 57 "></span> <span class=n>data_directory</span><span class=p>,</span>
<span class=linenos data-linenos=" 58 "></span> <span class=n>isolated_data_directory</span><span class=p>,</span>
<span class=linenos data-linenos=" 59 "></span> <span class=n>platform</span><span class=p>,</span>
<span class=linenos data-linenos=" 60 "></span> <span class=n>verbosity</span><span class=p>,</span>
<span class=linenos data-linenos=" 61 "></span> <span class=n>app</span><span class=p>,</span>
<span class=linenos data-linenos=" 62 "></span> <span class=p>):</span>
<span class=linenos data-linenos=" 63 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>__root</span> <span class=o>=</span> <span class=n>root</span>
<span class=linenos data-linenos=" 64 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>__metadata</span> <span class=o>=</span> <span class=n>metadata</span>
<span class=linenos data-linenos=" 65 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>__name</span> <span class=o>=</span> <span class=n>name</span>
<span class=linenos data-linenos=" 66 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>__config</span> <span class=o>=</span> <span class=n>config</span>
<span class=linenos data-linenos=" 67 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>__matrix_variables</span> <span class=o>=</span> <span class=n>matrix_variables</span>
<span class=linenos data-linenos=" 68 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>__data_directory</span> <span class=o>=</span> <span class=n>data_directory</span>
<span class=linenos data-linenos=" 69 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>__isolated_data_directory</span> <span class=o>=</span> <span class=n>isolated_data_directory</span>
<span class=linenos data-linenos=" 70 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>__platform</span> <span class=o>=</span> <span class=n>platform</span>
<span class=linenos data-linenos=" 71 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>__verbosity</span> <span class=o>=</span> <span class=n>verbosity</span>
<span class=linenos data-linenos=" 72 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>__app</span> <span class=o>=</span> <span class=n>app</span>
<span class=linenos data-linenos=" 73 "></span>
<span class=linenos data-linenos=" 74 "></span> <span class=nd>@property</span>
<span class=linenos data-linenos=" 75 "></span> <span class=k>def</span> <span class=nf>matrix_variables</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos=" 76 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>__matrix_variables</span>
<span class=linenos data-linenos=" 77 "></span>
<span class=linenos data-linenos=" 78 "></span> <span class=nd>@property</span>
<span class=linenos data-linenos=" 79 "></span> <span class=k>def</span> <span class=nf>app</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos=" 80 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos=" 81 "></span><span class=sd> An instance of [Application](../utilities.md#hatchling.bridge.app.Application).</span>
<span class=linenos data-linenos=" 82 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos=" 83 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>__app</span>
<span class=linenos data-linenos=" 84 "></span>
<span class=linenos data-linenos=" 85 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos=" 86 "></span> <span class=k>def</span> <span class=nf>context</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos=" 87 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>get_context</span><span class=p>()</span>
<span class=linenos data-linenos=" 88 "></span>
<span class=linenos data-linenos=" 89 "></span> <span class=nd>@property</span>
<span class=linenos data-linenos=" 90 "></span> <span class=k>def</span> <span class=nf>verbosity</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos=" 91 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>__verbosity</span>
<span class=linenos data-linenos=" 92 "></span>
<span class=linenos data-linenos=" 93 "></span> <span class=nd>@property</span>
<span class=linenos data-linenos=" 94 "></span> <span class=k>def</span> <span class=nf>root</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos=" 95 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos=" 96 "></span><span class=sd> The root of the local project tree as a path-like object.</span>
<span class=linenos data-linenos=" 97 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos=" 98 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>__root</span>
<span class=linenos data-linenos=" 99 "></span>
<span class=linenos data-linenos="100 "></span> <span class=nd>@property</span>
<span class=linenos data-linenos="101 "></span> <span class=k>def</span> <span class=nf>metadata</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="102 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>__metadata</span>
<span class=linenos data-linenos="103 "></span>
<span class=linenos data-linenos="104 "></span> <span class=nd>@property</span>
<span class=linenos data-linenos="105 "></span> <span class=k>def</span> <span class=nf>name</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>str</span><span class=p>:</span>
<span class=linenos data-linenos="106 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="107 "></span><span class=sd> The name of the environment.</span>
<span class=linenos data-linenos="108 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="109 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>__name</span>
<span class=linenos data-linenos="110 "></span>
<span class=linenos data-linenos="111 "></span> <span class=nd>@property</span>
<span class=linenos data-linenos="112 "></span> <span class=k>def</span> <span class=nf>platform</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="113 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="114 "></span><span class=sd> An instance of [Platform](../utilities.md#hatch.utils.platform.Platform).</span>
<span class=linenos data-linenos="115 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="116 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>__platform</span>
<span class=linenos data-linenos="117 "></span>
<span class=linenos data-linenos="118 "></span> <span class=nd>@property</span>
<span class=linenos data-linenos="119 "></span> <span class=k>def</span> <span class=nf>data_directory</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="120 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="121 "></span><span class=sd> The [directory](../../config/hatch.md#environments) this plugin should use for storage as a path-like object.</span>
<span class=linenos data-linenos="122 "></span><span class=sd> If the user has not configured one then this will be the same as the</span>
<span class=linenos data-linenos="123 "></span><span class=sd> [isolated data directory](reference.md#hatch.env.plugin.interface.EnvironmentInterface.isolated_data_directory).</span>
<span class=linenos data-linenos="124 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="125 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>__data_directory</span>
<span class=linenos data-linenos="126 "></span>
<span class=linenos data-linenos="127 "></span> <span class=nd>@property</span>
<span class=linenos data-linenos="128 "></span> <span class=k>def</span> <span class=nf>isolated_data_directory</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="129 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="130 "></span><span class=sd> The default [directory](../../config/hatch.md#environments) reserved exclusively for this plugin as a path-like</span>
<span class=linenos data-linenos="131 "></span><span class=sd> object.</span>
<span class=linenos data-linenos="132 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="133 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>__isolated_data_directory</span>
<span class=linenos data-linenos="134 "></span>
<span class=linenos data-linenos="135 "></span> <span class=nd>@property</span>
<span class=linenos data-linenos="136 "></span> <span class=k>def</span> <span class=nf>config</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>dict</span><span class=p>:</span>
<span class=linenos data-linenos="137 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="138 "></span><span class=sd> ```toml config-example</span>
<span class=linenos data-linenos="139 "></span><span class=sd> [tool.hatch.envs.&lt;ENV_NAME&gt;]</span>
<span class=linenos data-linenos="140 "></span><span class=sd> ```</span>
<span class=linenos data-linenos="141 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="142 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>__config</span>
<span class=linenos data-linenos="143 "></span>
<span class=linenos data-linenos="144 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="145 "></span> <span class=k>def</span> <span class=nf>project_root</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>str</span><span class=p>:</span>
<span class=linenos data-linenos="146 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="147 "></span><span class=sd> The root of the project tree as a string. If the environment is not running locally,</span>
<span class=linenos data-linenos="148 "></span><span class=sd> this should be the remote path to the project.</span>
<span class=linenos data-linenos="149 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="150 "></span> <span class=k>return</span> <span class=nb>str</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>root</span><span class=p>)</span>
<span class=linenos data-linenos="151 "></span>
<span class=linenos data-linenos="152 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="153 "></span> <span class=k>def</span> <span class=nf>sep</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>str</span><span class=p>:</span>
<span class=linenos data-linenos="154 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="155 "></span><span class=sd> The character used to separate directories in paths. By default, this is `\\` on Windows and `/` otherwise.</span>
<span class=linenos data-linenos="156 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="157 "></span> <span class=k>return</span> <span class=n>os</span><span class=o>.</span><span class=n>sep</span>
<span class=linenos data-linenos="158 "></span>
<span class=linenos data-linenos="159 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="160 "></span> <span class=k>def</span> <span class=nf>pathsep</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>str</span><span class=p>:</span>
<span class=linenos data-linenos="161 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="162 "></span><span class=sd> The character used to separate paths. By default, this is `;` on Windows and `:` otherwise.</span>
<span class=linenos data-linenos="163 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="164 "></span> <span class=k>return</span> <span class=n>os</span><span class=o>.</span><span class=n>pathsep</span>
<span class=linenos data-linenos="165 "></span>
<span class=linenos data-linenos="166 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="167 "></span> <span class=k>def</span> <span class=nf>system_python</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="168 "></span> <span class=n>system_python</span> <span class=o>=</span> <span class=n>os</span><span class=o>.</span><span class=n>environ</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=n>AppEnvVars</span><span class=o>.</span><span class=n>PYTHON</span><span class=p>)</span>
<span class=linenos data-linenos="169 "></span> <span class=k>if</span> <span class=n>system_python</span> <span class=o>==</span> <span class=s1>&#39;self&#39;</span><span class=p>:</span>
<span class=linenos data-linenos="170 "></span> <span class=n>system_python</span> <span class=o>=</span> <span class=n>sys</span><span class=o>.</span><span class=n>executable</span>
<span class=linenos data-linenos="171 "></span>
<span class=linenos data-linenos="172 "></span> <span class=n>system_python</span> <span class=o>=</span> <span class=p>(</span>
<span class=linenos data-linenos="173 "></span> <span class=n>system_python</span>
<span class=linenos data-linenos="174 "></span> <span class=ow>or</span> <span class=bp>self</span><span class=o>.</span><span class=n>platform</span><span class=o>.</span><span class=n>modules</span><span class=o>.</span><span class=n>shutil</span><span class=o>.</span><span class=n>which</span><span class=p>(</span><span class=s1>&#39;python&#39;</span><span class=p>)</span>
<span class=linenos data-linenos="175 "></span> <span class=ow>or</span> <span class=bp>self</span><span class=o>.</span><span class=n>platform</span><span class=o>.</span><span class=n>modules</span><span class=o>.</span><span class=n>shutil</span><span class=o>.</span><span class=n>which</span><span class=p>(</span><span class=s1>&#39;python3&#39;</span><span class=p>)</span>
<span class=linenos data-linenos="176 "></span> <span class=ow>or</span> <span class=n>sys</span><span class=o>.</span><span class=n>executable</span>
<span class=linenos data-linenos="177 "></span> <span class=p>)</span>
<span class=linenos data-linenos="178 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=n>isabs</span><span class=p>(</span><span class=n>system_python</span><span class=p>):</span>
<span class=linenos data-linenos="179 "></span> <span class=n>system_python</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>platform</span><span class=o>.</span><span class=n>modules</span><span class=o>.</span><span class=n>shutil</span><span class=o>.</span><span class=n>which</span><span class=p>(</span><span class=n>system_python</span><span class=p>)</span>
<span class=linenos data-linenos="180 "></span>
<span class=linenos data-linenos="181 "></span> <span class=k>return</span> <span class=n>system_python</span>
<span class=linenos data-linenos="182 "></span>
<span class=linenos data-linenos="183 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="184 "></span> <span class=k>def</span> <span class=nf>env_vars</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>dict</span><span class=p>:</span>
<span class=linenos data-linenos="185 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="186 "></span><span class=sd> ```toml config-example</span>
<span class=linenos data-linenos="187 "></span><span class=sd> [tool.hatch.envs.&lt;ENV_NAME&gt;.env-vars]</span>
<span class=linenos data-linenos="188 "></span><span class=sd> ```</span>
<span class=linenos data-linenos="189 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="190 "></span> <span class=n>env_vars</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>config</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=s1>&#39;env-vars&#39;</span><span class=p>,</span> <span class=p>{})</span>
<span class=linenos data-linenos="191 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>env_vars</span><span class=p>,</span> <span class=nb>dict</span><span class=p>):</span>
<span class=linenos data-linenos="192 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.env-vars` must be a mapping&#39;</span>
<span class=linenos data-linenos="193 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="194 "></span>
<span class=linenos data-linenos="195 "></span> <span class=k>for</span> <span class=n>key</span><span class=p>,</span> <span class=n>value</span> <span class=ow>in</span> <span class=n>env_vars</span><span class=o>.</span><span class=n>items</span><span class=p>():</span>
<span class=linenos data-linenos="196 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>value</span><span class=p>,</span> <span class=nb>str</span><span class=p>):</span>
<span class=linenos data-linenos="197 "></span> <span class=n>message</span> <span class=o>=</span> <span class=p>(</span>
<span class=linenos data-linenos="198 "></span> <span class=sa>f</span><span class=s1>&#39;Environment variable `</span><span class=si>{</span><span class=n>key</span><span class=si>}</span><span class=s1>` of field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.env-vars` must be a string&#39;</span>
<span class=linenos data-linenos="199 "></span> <span class=p>)</span>
<span class=linenos data-linenos="200 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="201 "></span>
<span class=linenos data-linenos="202 "></span> <span class=n>new_env_vars</span> <span class=o>=</span> <span class=p>{}</span>
<span class=linenos data-linenos="203 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>context</span><span class=o>.</span><span class=n>apply_context</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>context</span><span class=p>):</span>
<span class=linenos data-linenos="204 "></span> <span class=k>for</span> <span class=n>key</span><span class=p>,</span> <span class=n>value</span> <span class=ow>in</span> <span class=n>env_vars</span><span class=o>.</span><span class=n>items</span><span class=p>():</span>
<span class=linenos data-linenos="205 "></span> <span class=n>new_env_vars</span><span class=p>[</span><span class=n>key</span><span class=p>]</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>context</span><span class=o>.</span><span class=n>format</span><span class=p>(</span><span class=n>value</span><span class=p>)</span>
<span class=linenos data-linenos="206 "></span>
<span class=linenos data-linenos="207 "></span> <span class=n>new_env_vars</span><span class=p>[</span><span class=n>AppEnvVars</span><span class=o>.</span><span class=n>ENV_ACTIVE</span><span class=p>]</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>name</span>
<span class=linenos data-linenos="208 "></span> <span class=k>return</span> <span class=n>new_env_vars</span>
<span class=linenos data-linenos="209 "></span>
<span class=linenos data-linenos="210 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="211 "></span> <span class=k>def</span> <span class=nf>env_include</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]:</span>
<span class=linenos data-linenos="212 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="213 "></span><span class=sd> ```toml config-example</span>
<span class=linenos data-linenos="214 "></span><span class=sd> [tool.hatch.envs.&lt;ENV_NAME&gt;]</span>
<span class=linenos data-linenos="215 "></span><span class=sd> env-include = [...]</span>
<span class=linenos data-linenos="216 "></span><span class=sd> ```</span>
<span class=linenos data-linenos="217 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="218 "></span> <span class=n>env_include</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>config</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=s1>&#39;env-include&#39;</span><span class=p>,</span> <span class=p>[])</span>
<span class=linenos data-linenos="219 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>env_include</span><span class=p>,</span> <span class=nb>list</span><span class=p>):</span>
<span class=linenos data-linenos="220 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.env-include` must be an array&#39;</span>
<span class=linenos data-linenos="221 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="222 "></span>
<span class=linenos data-linenos="223 "></span> <span class=k>for</span> <span class=n>i</span><span class=p>,</span> <span class=n>pattern</span> <span class=ow>in</span> <span class=nb>enumerate</span><span class=p>(</span><span class=n>env_include</span><span class=p>,</span> <span class=mi>1</span><span class=p>):</span>
<span class=linenos data-linenos="224 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>pattern</span><span class=p>,</span> <span class=nb>str</span><span class=p>):</span>
<span class=linenos data-linenos="225 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Pattern #</span><span class=si>{</span><span class=n>i</span><span class=si>}</span><span class=s1> of field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.env-include` must be a string&#39;</span>
<span class=linenos data-linenos="226 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="227 "></span>
<span class=linenos data-linenos="228 "></span> <span class=k>return</span> <span class=p>[</span><span class=s1>&#39;HATCH_BUILD_*&#39;</span><span class=p>,</span> <span class=o>*</span><span class=n>env_include</span><span class=p>]</span> <span class=k>if</span> <span class=n>env_include</span> <span class=k>else</span> <span class=n>env_include</span>
<span class=linenos data-linenos="229 "></span>
<span class=linenos data-linenos="230 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="231 "></span> <span class=k>def</span> <span class=nf>env_exclude</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]:</span>
<span class=linenos data-linenos="232 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="233 "></span><span class=sd> ```toml config-example</span>
<span class=linenos data-linenos="234 "></span><span class=sd> [tool.hatch.envs.&lt;ENV_NAME&gt;]</span>
<span class=linenos data-linenos="235 "></span><span class=sd> env-exclude = [...]</span>
<span class=linenos data-linenos="236 "></span><span class=sd> ```</span>
<span class=linenos data-linenos="237 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="238 "></span> <span class=n>env_exclude</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>config</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=s1>&#39;env-exclude&#39;</span><span class=p>,</span> <span class=p>[])</span>
<span class=linenos data-linenos="239 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>env_exclude</span><span class=p>,</span> <span class=nb>list</span><span class=p>):</span>
<span class=linenos data-linenos="240 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.env-exclude` must be an array&#39;</span>
<span class=linenos data-linenos="241 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="242 "></span>
<span class=linenos data-linenos="243 "></span> <span class=k>for</span> <span class=n>i</span><span class=p>,</span> <span class=n>pattern</span> <span class=ow>in</span> <span class=nb>enumerate</span><span class=p>(</span><span class=n>env_exclude</span><span class=p>,</span> <span class=mi>1</span><span class=p>):</span>
<span class=linenos data-linenos="244 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>pattern</span><span class=p>,</span> <span class=nb>str</span><span class=p>):</span>
<span class=linenos data-linenos="245 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Pattern #</span><span class=si>{</span><span class=n>i</span><span class=si>}</span><span class=s1> of field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.env-exclude` must be a string&#39;</span>
<span class=linenos data-linenos="246 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="247 "></span>
<span class=linenos data-linenos="248 "></span> <span class=k>return</span> <span class=n>env_exclude</span>
<span class=linenos data-linenos="249 "></span>
<span class=linenos data-linenos="250 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="251 "></span> <span class=k>def</span> <span class=nf>environment_dependencies_complex</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="252 "></span> <span class=kn>from</span> <span class=nn>packaging.requirements</span> <span class=kn>import</span> <span class=n>InvalidRequirement</span><span class=p>,</span> <span class=n>Requirement</span>
<span class=linenos data-linenos="253 "></span>
<span class=linenos data-linenos="254 "></span> <span class=n>dependencies_complex</span> <span class=o>=</span> <span class=p>[]</span>
<span class=linenos data-linenos="255 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>apply_context</span><span class=p>():</span>
<span class=linenos data-linenos="256 "></span> <span class=k>for</span> <span class=n>option</span> <span class=ow>in</span> <span class=p>(</span><span class=s1>&#39;dependencies&#39;</span><span class=p>,</span> <span class=s1>&#39;extra-dependencies&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="257 "></span> <span class=n>dependencies</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>config</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=n>option</span><span class=p>,</span> <span class=p>[])</span>
<span class=linenos data-linenos="258 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>dependencies</span><span class=p>,</span> <span class=nb>list</span><span class=p>):</span>
<span class=linenos data-linenos="259 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.</span><span class=si>{</span><span class=n>option</span><span class=si>}</span><span class=s1>` must be an array&#39;</span>
<span class=linenos data-linenos="260 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="261 "></span>
<span class=linenos data-linenos="262 "></span> <span class=k>for</span> <span class=n>i</span><span class=p>,</span> <span class=n>entry</span> <span class=ow>in</span> <span class=nb>enumerate</span><span class=p>(</span><span class=n>dependencies</span><span class=p>,</span> <span class=mi>1</span><span class=p>):</span>
<span class=linenos data-linenos="263 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>entry</span><span class=p>,</span> <span class=nb>str</span><span class=p>):</span>
<span class=linenos data-linenos="264 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Dependency #</span><span class=si>{</span><span class=n>i</span><span class=si>}</span><span class=s1> of field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.</span><span class=si>{</span><span class=n>option</span><span class=si>}</span><span class=s1>` must be a string&#39;</span>
<span class=linenos data-linenos="265 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="266 "></span>
<span class=linenos data-linenos="267 "></span> <span class=k>try</span><span class=p>:</span>
<span class=linenos data-linenos="268 "></span> <span class=n>dependencies_complex</span><span class=o>.</span><span class=n>append</span><span class=p>(</span><span class=n>Requirement</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>context</span><span class=o>.</span><span class=n>format</span><span class=p>(</span><span class=n>entry</span><span class=p>)))</span>
<span class=linenos data-linenos="269 "></span> <span class=k>except</span> <span class=n>InvalidRequirement</span> <span class=k>as</span> <span class=n>e</span><span class=p>:</span>
<span class=linenos data-linenos="270 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Dependency #</span><span class=si>{</span><span class=n>i</span><span class=si>}</span><span class=s1> of field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.</span><span class=si>{</span><span class=n>option</span><span class=si>}</span><span class=s1>` is invalid: </span><span class=si>{</span><span class=n>e</span><span class=si>}</span><span class=s1>&#39;</span>
<span class=linenos data-linenos="271 "></span> <span class=k>raise</span> <span class=ne>ValueError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span> <span class=kn>from</span> <span class=kc>None</span>
<span class=linenos data-linenos="272 "></span>
<span class=linenos data-linenos="273 "></span> <span class=k>return</span> <span class=n>dependencies_complex</span>
<span class=linenos data-linenos="274 "></span>
<span class=linenos data-linenos="275 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="276 "></span> <span class=k>def</span> <span class=nf>environment_dependencies</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]:</span>
<span class=linenos data-linenos="277 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="278 "></span><span class=sd> The list of all [environment dependencies](../../config/environment/overview.md#dependencies).</span>
<span class=linenos data-linenos="279 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="280 "></span> <span class=k>return</span> <span class=p>[</span><span class=nb>str</span><span class=p>(</span><span class=n>dependency</span><span class=p>)</span> <span class=k>for</span> <span class=n>dependency</span> <span class=ow>in</span> <span class=bp>self</span><span class=o>.</span><span class=n>environment_dependencies_complex</span><span class=p>]</span>
<span class=linenos data-linenos="281 "></span>
<span class=linenos data-linenos="282 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="283 "></span> <span class=k>def</span> <span class=nf>dependencies_complex</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="284 "></span> <span class=n>all_dependencies_complex</span> <span class=o>=</span> <span class=nb>list</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>environment_dependencies_complex</span><span class=p>)</span>
<span class=linenos data-linenos="285 "></span> <span class=k>if</span> <span class=bp>self</span><span class=o>.</span><span class=n>builder</span><span class=p>:</span>
<span class=linenos data-linenos="286 "></span> <span class=n>all_dependencies_complex</span><span class=o>.</span><span class=n>extend</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>build</span><span class=o>.</span><span class=n>requires_complex</span><span class=p>)</span>
<span class=linenos data-linenos="287 "></span> <span class=k>return</span> <span class=n>all_dependencies_complex</span>
<span class=linenos data-linenos="288 "></span>
<span class=linenos data-linenos="289 "></span> <span class=c1># Ensure these are checked last to speed up initial environment creation since</span>
<span class=linenos data-linenos="290 "></span> <span class=c1># they will already be installed along with the project</span>
<span class=linenos data-linenos="291 "></span> <span class=k>if</span> <span class=p>(</span><span class=ow>not</span> <span class=bp>self</span><span class=o>.</span><span class=n>skip_install</span> <span class=ow>and</span> <span class=bp>self</span><span class=o>.</span><span class=n>dev_mode</span><span class=p>)</span> <span class=ow>or</span> <span class=bp>self</span><span class=o>.</span><span class=n>features</span><span class=p>:</span>
<span class=linenos data-linenos="292 "></span> <span class=kn>from</span> <span class=nn>hatch.utils.dep</span> <span class=kn>import</span> <span class=n>get_complex_dependencies</span><span class=p>,</span> <span class=n>get_complex_features</span>
<span class=linenos data-linenos="293 "></span>
<span class=linenos data-linenos="294 "></span> <span class=n>dependencies</span><span class=p>,</span> <span class=n>optional_dependencies</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>project</span><span class=o>.</span><span class=n>get_dependencies</span><span class=p>()</span>
<span class=linenos data-linenos="295 "></span> <span class=n>dependencies_complex</span> <span class=o>=</span> <span class=n>get_complex_dependencies</span><span class=p>(</span><span class=n>dependencies</span><span class=p>)</span>
<span class=linenos data-linenos="296 "></span> <span class=n>optional_dependencies_complex</span> <span class=o>=</span> <span class=n>get_complex_features</span><span class=p>(</span><span class=n>optional_dependencies</span><span class=p>)</span>
<span class=linenos data-linenos="297 "></span>
<span class=linenos data-linenos="298 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=bp>self</span><span class=o>.</span><span class=n>skip_install</span> <span class=ow>and</span> <span class=bp>self</span><span class=o>.</span><span class=n>dev_mode</span><span class=p>:</span>
<span class=linenos data-linenos="299 "></span> <span class=n>all_dependencies_complex</span><span class=o>.</span><span class=n>extend</span><span class=p>(</span><span class=n>dependencies_complex</span><span class=o>.</span><span class=n>values</span><span class=p>())</span>
<span class=linenos data-linenos="300 "></span>
<span class=linenos data-linenos="301 "></span> <span class=k>for</span> <span class=n>feature</span> <span class=ow>in</span> <span class=bp>self</span><span class=o>.</span><span class=n>features</span><span class=p>:</span>
<span class=linenos data-linenos="302 "></span> <span class=k>if</span> <span class=n>feature</span> <span class=ow>not</span> <span class=ow>in</span> <span class=n>optional_dependencies_complex</span><span class=p>:</span>
<span class=linenos data-linenos="303 "></span> <span class=n>message</span> <span class=o>=</span> <span class=p>(</span>
<span class=linenos data-linenos="304 "></span> <span class=sa>f</span><span class=s1>&#39;Feature `</span><span class=si>{</span><span class=n>feature</span><span class=si>}</span><span class=s1>` of field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.features` is not &#39;</span>
<span class=linenos data-linenos="305 "></span> <span class=sa>f</span><span class=s1>&#39;defined in the dynamic field `project.optional-dependencies`&#39;</span>
<span class=linenos data-linenos="306 "></span> <span class=p>)</span>
<span class=linenos data-linenos="307 "></span> <span class=k>raise</span> <span class=ne>ValueError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="308 "></span>
<span class=linenos data-linenos="309 "></span> <span class=n>all_dependencies_complex</span><span class=o>.</span><span class=n>extend</span><span class=p>(</span><span class=n>optional_dependencies_complex</span><span class=p>[</span><span class=n>feature</span><span class=p>]</span><span class=o>.</span><span class=n>values</span><span class=p>())</span>
<span class=linenos data-linenos="310 "></span>
<span class=linenos data-linenos="311 "></span> <span class=k>return</span> <span class=n>all_dependencies_complex</span>
<span class=linenos data-linenos="312 "></span>
<span class=linenos data-linenos="313 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="314 "></span> <span class=k>def</span> <span class=nf>dependencies</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]:</span>
<span class=linenos data-linenos="315 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="316 "></span><span class=sd> The list of all [project dependencies](../../config/metadata.md#dependencies) (if</span>
<span class=linenos data-linenos="317 "></span><span class=sd> [installed](../../config/environment/overview.md#skip-install) and in</span>
<span class=linenos data-linenos="318 "></span><span class=sd> [dev mode](../../config/environment/overview.md#dev-mode)), selected</span>
<span class=linenos data-linenos="319 "></span><span class=sd> [optional dependencies](../../config/environment/overview.md#features), and</span>
<span class=linenos data-linenos="320 "></span><span class=sd> [environment dependencies](../../config/environment/overview.md#dependencies).</span>
<span class=linenos data-linenos="321 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="322 "></span> <span class=k>return</span> <span class=p>[</span><span class=nb>str</span><span class=p>(</span><span class=n>dependency</span><span class=p>)</span> <span class=k>for</span> <span class=n>dependency</span> <span class=ow>in</span> <span class=bp>self</span><span class=o>.</span><span class=n>dependencies_complex</span><span class=p>]</span>
<span class=linenos data-linenos="323 "></span>
<span class=linenos data-linenos="324 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="325 "></span> <span class=k>def</span> <span class=nf>platforms</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]:</span>
<span class=linenos data-linenos="326 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="327 "></span><span class=sd> All names are stored as their lower-cased version.</span>
<span class=linenos data-linenos="328 "></span>
<span class=linenos data-linenos="329 "></span><span class=sd> ```toml config-example</span>
<span class=linenos data-linenos="330 "></span><span class=sd> [tool.hatch.envs.&lt;ENV_NAME&gt;]</span>
<span class=linenos data-linenos="331 "></span><span class=sd> platforms = [...]</span>
<span class=linenos data-linenos="332 "></span><span class=sd> ```</span>
<span class=linenos data-linenos="333 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="334 "></span> <span class=n>platforms</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>config</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=s1>&#39;platforms&#39;</span><span class=p>,</span> <span class=p>[])</span>
<span class=linenos data-linenos="335 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>platforms</span><span class=p>,</span> <span class=nb>list</span><span class=p>):</span>
<span class=linenos data-linenos="336 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.platforms` must be an array&#39;</span>
<span class=linenos data-linenos="337 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="338 "></span>
<span class=linenos data-linenos="339 "></span> <span class=k>for</span> <span class=n>i</span><span class=p>,</span> <span class=n>command</span> <span class=ow>in</span> <span class=nb>enumerate</span><span class=p>(</span><span class=n>platforms</span><span class=p>,</span> <span class=mi>1</span><span class=p>):</span>
<span class=linenos data-linenos="340 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>command</span><span class=p>,</span> <span class=nb>str</span><span class=p>):</span>
<span class=linenos data-linenos="341 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Platform #</span><span class=si>{</span><span class=n>i</span><span class=si>}</span><span class=s1> of field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.platforms` must be a string&#39;</span>
<span class=linenos data-linenos="342 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="343 "></span>
<span class=linenos data-linenos="344 "></span> <span class=k>return</span> <span class=p>[</span><span class=n>platform</span><span class=o>.</span><span class=n>lower</span><span class=p>()</span> <span class=k>for</span> <span class=n>platform</span> <span class=ow>in</span> <span class=n>platforms</span><span class=p>]</span>
<span class=linenos data-linenos="345 "></span>
<span class=linenos data-linenos="346 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="347 "></span> <span class=k>def</span> <span class=nf>skip_install</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>bool</span><span class=p>:</span>
<span class=linenos data-linenos="348 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="349 "></span><span class=sd> ```toml config-example</span>
<span class=linenos data-linenos="350 "></span><span class=sd> [tool.hatch.envs.&lt;ENV_NAME&gt;]</span>
<span class=linenos data-linenos="351 "></span><span class=sd> skip-install = ...</span>
<span class=linenos data-linenos="352 "></span><span class=sd> ```</span>
<span class=linenos data-linenos="353 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="354 "></span> <span class=n>skip_install</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>config</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=s1>&#39;skip-install&#39;</span><span class=p>,</span> <span class=ow>not</span> <span class=bp>self</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>has_project_file</span><span class=p>())</span>
<span class=linenos data-linenos="355 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>skip_install</span><span class=p>,</span> <span class=nb>bool</span><span class=p>):</span>
<span class=linenos data-linenos="356 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.skip-install` must be a boolean&#39;</span>
<span class=linenos data-linenos="357 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="358 "></span>
<span class=linenos data-linenos="359 "></span> <span class=k>return</span> <span class=n>skip_install</span>
<span class=linenos data-linenos="360 "></span>
<span class=linenos data-linenos="361 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="362 "></span> <span class=k>def</span> <span class=nf>dev_mode</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>bool</span><span class=p>:</span>
<span class=linenos data-linenos="363 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="364 "></span><span class=sd> ```toml config-example</span>
<span class=linenos data-linenos="365 "></span><span class=sd> [tool.hatch.envs.&lt;ENV_NAME&gt;]</span>
<span class=linenos data-linenos="366 "></span><span class=sd> dev-mode = ...</span>
<span class=linenos data-linenos="367 "></span><span class=sd> ```</span>
<span class=linenos data-linenos="368 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="369 "></span> <span class=n>dev_mode</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>config</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=s1>&#39;dev-mode&#39;</span><span class=p>,</span> <span class=kc>True</span><span class=p>)</span>
<span class=linenos data-linenos="370 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>dev_mode</span><span class=p>,</span> <span class=nb>bool</span><span class=p>):</span>
<span class=linenos data-linenos="371 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.dev-mode` must be a boolean&#39;</span>
<span class=linenos data-linenos="372 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="373 "></span>
<span class=linenos data-linenos="374 "></span> <span class=k>return</span> <span class=n>dev_mode</span>
<span class=linenos data-linenos="375 "></span>
<span class=linenos data-linenos="376 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="377 "></span> <span class=k>def</span> <span class=nf>builder</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>bool</span><span class=p>:</span>
<span class=linenos data-linenos="378 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="379 "></span><span class=sd> ```toml config-example</span>
<span class=linenos data-linenos="380 "></span><span class=sd> [tool.hatch.envs.&lt;ENV_NAME&gt;]</span>
<span class=linenos data-linenos="381 "></span><span class=sd> builder = ...</span>
<span class=linenos data-linenos="382 "></span><span class=sd> ```</span>
<span class=linenos data-linenos="383 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="384 "></span> <span class=n>builder</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>config</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=s1>&#39;builder&#39;</span><span class=p>,</span> <span class=kc>False</span><span class=p>)</span>
<span class=linenos data-linenos="385 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>builder</span><span class=p>,</span> <span class=nb>bool</span><span class=p>):</span>
<span class=linenos data-linenos="386 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.builder` must be a boolean&#39;</span>
<span class=linenos data-linenos="387 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="388 "></span>
<span class=linenos data-linenos="389 "></span> <span class=k>return</span> <span class=n>builder</span>
<span class=linenos data-linenos="390 "></span>
<span class=linenos data-linenos="391 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="392 "></span> <span class=k>def</span> <span class=nf>features</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="393 "></span> <span class=kn>from</span> <span class=nn>hatchling.metadata.utils</span> <span class=kn>import</span> <span class=n>normalize_project_name</span>
<span class=linenos data-linenos="394 "></span>
<span class=linenos data-linenos="395 "></span> <span class=n>features</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>config</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=s1>&#39;features&#39;</span><span class=p>,</span> <span class=p>[])</span>
<span class=linenos data-linenos="396 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>features</span><span class=p>,</span> <span class=nb>list</span><span class=p>):</span>
<span class=linenos data-linenos="397 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.features` must be an array of strings&#39;</span>
<span class=linenos data-linenos="398 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="399 "></span>
<span class=linenos data-linenos="400 "></span> <span class=n>all_features</span> <span class=o>=</span> <span class=nb>set</span><span class=p>()</span>
<span class=linenos data-linenos="401 "></span> <span class=k>for</span> <span class=n>i</span><span class=p>,</span> <span class=n>feature</span> <span class=ow>in</span> <span class=nb>enumerate</span><span class=p>(</span><span class=n>features</span><span class=p>,</span> <span class=mi>1</span><span class=p>):</span>
<span class=linenos data-linenos="402 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>feature</span><span class=p>,</span> <span class=nb>str</span><span class=p>):</span>
<span class=linenos data-linenos="403 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Feature #</span><span class=si>{</span><span class=n>i</span><span class=si>}</span><span class=s1> of field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.features` must be a string&#39;</span>
<span class=linenos data-linenos="404 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="405 "></span>
<span class=linenos data-linenos="406 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=n>feature</span><span class=p>:</span>
<span class=linenos data-linenos="407 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Feature #</span><span class=si>{</span><span class=n>i</span><span class=si>}</span><span class=s1> of field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.features` cannot be an empty string&#39;</span>
<span class=linenos data-linenos="408 "></span> <span class=k>raise</span> <span class=ne>ValueError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="409 "></span>
<span class=linenos data-linenos="410 "></span> <span class=n>normalized_feature</span> <span class=o>=</span> <span class=p>(</span>
<span class=linenos data-linenos="411 "></span> <span class=n>feature</span> <span class=k>if</span> <span class=bp>self</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>hatch</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>allow_ambiguous_features</span> <span class=k>else</span> <span class=n>normalize_project_name</span><span class=p>(</span><span class=n>feature</span><span class=p>)</span>
<span class=linenos data-linenos="412 "></span> <span class=p>)</span>
<span class=linenos data-linenos="413 "></span> <span class=k>if</span> <span class=p>(</span>
<span class=linenos data-linenos="414 "></span> <span class=ow>not</span> <span class=bp>self</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>hatch</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>hook_config</span>
<span class=linenos data-linenos="415 "></span> <span class=ow>and</span> <span class=n>normalized_feature</span> <span class=ow>not</span> <span class=ow>in</span> <span class=bp>self</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>core</span><span class=o>.</span><span class=n>optional_dependencies</span>
<span class=linenos data-linenos="416 "></span> <span class=p>):</span>
<span class=linenos data-linenos="417 "></span> <span class=n>message</span> <span class=o>=</span> <span class=p>(</span>
<span class=linenos data-linenos="418 "></span> <span class=sa>f</span><span class=s1>&#39;Feature `</span><span class=si>{</span><span class=n>normalized_feature</span><span class=si>}</span><span class=s1>` of field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.features` is not &#39;</span>
<span class=linenos data-linenos="419 "></span> <span class=sa>f</span><span class=s1>&#39;defined in field `project.optional-dependencies`&#39;</span>
<span class=linenos data-linenos="420 "></span> <span class=p>)</span>
<span class=linenos data-linenos="421 "></span> <span class=k>raise</span> <span class=ne>ValueError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="422 "></span>
<span class=linenos data-linenos="423 "></span> <span class=n>all_features</span><span class=o>.</span><span class=n>add</span><span class=p>(</span><span class=n>normalized_feature</span><span class=p>)</span>
<span class=linenos data-linenos="424 "></span>
<span class=linenos data-linenos="425 "></span> <span class=k>return</span> <span class=nb>sorted</span><span class=p>(</span><span class=n>all_features</span><span class=p>)</span>
<span class=linenos data-linenos="426 "></span>
<span class=linenos data-linenos="427 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="428 "></span> <span class=k>def</span> <span class=nf>description</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>str</span><span class=p>:</span>
<span class=linenos data-linenos="429 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="430 "></span><span class=sd> ```toml config-example</span>
<span class=linenos data-linenos="431 "></span><span class=sd> [tool.hatch.envs.&lt;ENV_NAME&gt;]</span>
<span class=linenos data-linenos="432 "></span><span class=sd> description = ...</span>
<span class=linenos data-linenos="433 "></span><span class=sd> ```</span>
<span class=linenos data-linenos="434 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="435 "></span> <span class=n>description</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>config</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=s1>&#39;description&#39;</span><span class=p>,</span> <span class=s1>&#39;&#39;</span><span class=p>)</span>
<span class=linenos data-linenos="436 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>description</span><span class=p>,</span> <span class=nb>str</span><span class=p>):</span>
<span class=linenos data-linenos="437 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.description` must be a string&#39;</span>
<span class=linenos data-linenos="438 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="439 "></span>
<span class=linenos data-linenos="440 "></span> <span class=k>return</span> <span class=n>description</span>
<span class=linenos data-linenos="441 "></span>
<span class=linenos data-linenos="442 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="443 "></span> <span class=k>def</span> <span class=nf>scripts</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="444 "></span> <span class=n>config</span> <span class=o>=</span> <span class=p>{}</span>
<span class=linenos data-linenos="445 "></span>
<span class=linenos data-linenos="446 "></span> <span class=c1># Extra scripts should come first to give less precedence</span>
<span class=linenos data-linenos="447 "></span> <span class=k>for</span> <span class=n>field</span> <span class=ow>in</span> <span class=p>(</span><span class=s1>&#39;extra-scripts&#39;</span><span class=p>,</span> <span class=s1>&#39;scripts&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="448 "></span> <span class=n>script_config</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>config</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=n>field</span><span class=p>,</span> <span class=p>{})</span>
<span class=linenos data-linenos="449 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>script_config</span><span class=p>,</span> <span class=nb>dict</span><span class=p>):</span>
<span class=linenos data-linenos="450 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.</span><span class=si>{</span><span class=n>field</span><span class=si>}</span><span class=s1>` must be a table&#39;</span>
<span class=linenos data-linenos="451 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="452 "></span>
<span class=linenos data-linenos="453 "></span> <span class=k>for</span> <span class=n>name</span><span class=p>,</span> <span class=n>data</span> <span class=ow>in</span> <span class=n>script_config</span><span class=o>.</span><span class=n>items</span><span class=p>():</span>
<span class=linenos data-linenos="454 "></span> <span class=k>if</span> <span class=s1>&#39; &#39;</span> <span class=ow>in</span> <span class=n>name</span><span class=p>:</span>
<span class=linenos data-linenos="455 "></span> <span class=n>message</span> <span class=o>=</span> <span class=p>(</span>
<span class=linenos data-linenos="456 "></span> <span class=sa>f</span><span class=s1>&#39;Script name `</span><span class=si>{</span><span class=n>name</span><span class=si>}</span><span class=s1>` in field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.</span><span class=si>{</span><span class=n>field</span><span class=si>}</span><span class=s1>` &#39;</span>
<span class=linenos data-linenos="457 "></span> <span class=sa>f</span><span class=s1>&#39;must not contain spaces&#39;</span>
<span class=linenos data-linenos="458 "></span> <span class=p>)</span>
<span class=linenos data-linenos="459 "></span> <span class=k>raise</span> <span class=ne>ValueError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="460 "></span>
<span class=linenos data-linenos="461 "></span> <span class=n>commands</span> <span class=o>=</span> <span class=p>[]</span>
<span class=linenos data-linenos="462 "></span>
<span class=linenos data-linenos="463 "></span> <span class=k>if</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>data</span><span class=p>,</span> <span class=nb>str</span><span class=p>):</span>
<span class=linenos data-linenos="464 "></span> <span class=n>commands</span><span class=o>.</span><span class=n>append</span><span class=p>(</span><span class=n>data</span><span class=p>)</span>
<span class=linenos data-linenos="465 "></span> <span class=k>elif</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>data</span><span class=p>,</span> <span class=nb>list</span><span class=p>):</span>
<span class=linenos data-linenos="466 "></span> <span class=k>for</span> <span class=n>i</span><span class=p>,</span> <span class=n>command</span> <span class=ow>in</span> <span class=nb>enumerate</span><span class=p>(</span><span class=n>data</span><span class=p>,</span> <span class=mi>1</span><span class=p>):</span>
<span class=linenos data-linenos="467 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>command</span><span class=p>,</span> <span class=nb>str</span><span class=p>):</span>
<span class=linenos data-linenos="468 "></span> <span class=n>message</span> <span class=o>=</span> <span class=p>(</span>
<span class=linenos data-linenos="469 "></span> <span class=sa>f</span><span class=s1>&#39;Command #</span><span class=si>{</span><span class=n>i</span><span class=si>}</span><span class=s1> in field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.</span><span class=si>{</span><span class=n>field</span><span class=si>}</span><span class=s1>.</span><span class=si>{</span><span class=n>name</span><span class=si>}</span><span class=s1>` &#39;</span>
<span class=linenos data-linenos="470 "></span> <span class=sa>f</span><span class=s1>&#39;must be a string&#39;</span>
<span class=linenos data-linenos="471 "></span> <span class=p>)</span>
<span class=linenos data-linenos="472 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="473 "></span>
<span class=linenos data-linenos="474 "></span> <span class=n>commands</span><span class=o>.</span><span class=n>append</span><span class=p>(</span><span class=n>command</span><span class=p>)</span>
<span class=linenos data-linenos="475 "></span> <span class=k>else</span><span class=p>:</span>
<span class=linenos data-linenos="476 "></span> <span class=n>message</span> <span class=o>=</span> <span class=p>(</span>
<span class=linenos data-linenos="477 "></span> <span class=sa>f</span><span class=s1>&#39;Field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.</span><span class=si>{</span><span class=n>field</span><span class=si>}</span><span class=s1>.</span><span class=si>{</span><span class=n>name</span><span class=si>}</span><span class=s1>` must be &#39;</span>
<span class=linenos data-linenos="478 "></span> <span class=sa>f</span><span class=s1>&#39;a string or an array of strings&#39;</span>
<span class=linenos data-linenos="479 "></span> <span class=p>)</span>
<span class=linenos data-linenos="480 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="481 "></span>
<span class=linenos data-linenos="482 "></span> <span class=n>config</span><span class=p>[</span><span class=n>name</span><span class=p>]</span> <span class=o>=</span> <span class=n>commands</span>
<span class=linenos data-linenos="483 "></span>
<span class=linenos data-linenos="484 "></span> <span class=n>seen</span> <span class=o>=</span> <span class=p>{}</span>
<span class=linenos data-linenos="485 "></span> <span class=n>active</span> <span class=o>=</span> <span class=p>[]</span>
<span class=linenos data-linenos="486 "></span> <span class=k>for</span> <span class=n>script_name</span><span class=p>,</span> <span class=n>commands</span> <span class=ow>in</span> <span class=n>config</span><span class=o>.</span><span class=n>items</span><span class=p>():</span>
<span class=linenos data-linenos="487 "></span> <span class=n>commands</span><span class=p>[:]</span> <span class=o>=</span> <span class=n>expand_script_commands</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=p>,</span> <span class=n>script_name</span><span class=p>,</span> <span class=n>commands</span><span class=p>,</span> <span class=n>config</span><span class=p>,</span> <span class=n>seen</span><span class=p>,</span> <span class=n>active</span><span class=p>)</span>
<span class=linenos data-linenos="488 "></span>
<span class=linenos data-linenos="489 "></span> <span class=k>return</span> <span class=n>config</span>
<span class=linenos data-linenos="490 "></span>
<span class=linenos data-linenos="491 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="492 "></span> <span class=k>def</span> <span class=nf>pre_install_commands</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="493 "></span> <span class=n>pre_install_commands</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>config</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=s1>&#39;pre-install-commands&#39;</span><span class=p>,</span> <span class=p>[])</span>
<span class=linenos data-linenos="494 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>pre_install_commands</span><span class=p>,</span> <span class=nb>list</span><span class=p>):</span>
<span class=linenos data-linenos="495 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.pre-install-commands` must be an array&#39;</span>
<span class=linenos data-linenos="496 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="497 "></span>
<span class=linenos data-linenos="498 "></span> <span class=k>for</span> <span class=n>i</span><span class=p>,</span> <span class=n>command</span> <span class=ow>in</span> <span class=nb>enumerate</span><span class=p>(</span><span class=n>pre_install_commands</span><span class=p>,</span> <span class=mi>1</span><span class=p>):</span>
<span class=linenos data-linenos="499 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>command</span><span class=p>,</span> <span class=nb>str</span><span class=p>):</span>
<span class=linenos data-linenos="500 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Command #</span><span class=si>{</span><span class=n>i</span><span class=si>}</span><span class=s1> of field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.pre-install-commands` must be a string&#39;</span>
<span class=linenos data-linenos="501 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="502 "></span>
<span class=linenos data-linenos="503 "></span> <span class=k>return</span> <span class=nb>list</span><span class=p>(</span><span class=n>pre_install_commands</span><span class=p>)</span>
<span class=linenos data-linenos="504 "></span>
<span class=linenos data-linenos="505 "></span> <span class=nd>@cached_property</span>
<span class=linenos data-linenos="506 "></span> <span class=k>def</span> <span class=nf>post_install_commands</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="507 "></span> <span class=n>post_install_commands</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>config</span><span class=o>.</span><span class=n>get</span><span class=p>(</span><span class=s1>&#39;post-install-commands&#39;</span><span class=p>,</span> <span class=p>[])</span>
<span class=linenos data-linenos="508 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>post_install_commands</span><span class=p>,</span> <span class=nb>list</span><span class=p>):</span>
<span class=linenos data-linenos="509 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.post-install-commands` must be an array&#39;</span>
<span class=linenos data-linenos="510 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="511 "></span>
<span class=linenos data-linenos="512 "></span> <span class=k>for</span> <span class=n>i</span><span class=p>,</span> <span class=n>command</span> <span class=ow>in</span> <span class=nb>enumerate</span><span class=p>(</span><span class=n>post_install_commands</span><span class=p>,</span> <span class=mi>1</span><span class=p>):</span>
<span class=linenos data-linenos="513 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=nb>isinstance</span><span class=p>(</span><span class=n>command</span><span class=p>,</span> <span class=nb>str</span><span class=p>):</span>
<span class=linenos data-linenos="514 "></span> <span class=n>message</span> <span class=o>=</span> <span class=sa>f</span><span class=s1>&#39;Command #</span><span class=si>{</span><span class=n>i</span><span class=si>}</span><span class=s1> of field `tool.hatch.envs.</span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>.post-install-commands` must be a string&#39;</span>
<span class=linenos data-linenos="515 "></span> <span class=k>raise</span> <span class=ne>TypeError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="516 "></span>
<span class=linenos data-linenos="517 "></span> <span class=k>return</span> <span class=nb>list</span><span class=p>(</span><span class=n>post_install_commands</span><span class=p>)</span>
<span class=linenos data-linenos="518 "></span>
<span class=linenos data-linenos="519 "></span> <span class=k>def</span> <span class=nf>activate</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="520 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="521 "></span><span class=sd> A convenience method called when using the environment as a context manager:</span>
<span class=linenos data-linenos="522 "></span>
<span class=linenos data-linenos="523 "></span><span class=sd> ```python</span>
<span class=linenos data-linenos="524 "></span><span class=sd> with environment:</span>
<span class=linenos data-linenos="525 "></span><span class=sd> ...</span>
<span class=linenos data-linenos="526 "></span><span class=sd> ```</span>
<span class=linenos data-linenos="527 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="528 "></span>
<span class=linenos data-linenos="529 "></span> <span class=k>def</span> <span class=nf>deactivate</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="530 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="531 "></span><span class=sd> A convenience method called after using the environment as a context manager:</span>
<span class=linenos data-linenos="532 "></span>
<span class=linenos data-linenos="533 "></span><span class=sd> ```python</span>
<span class=linenos data-linenos="534 "></span><span class=sd> with environment:</span>
<span class=linenos data-linenos="535 "></span><span class=sd> ...</span>
<span class=linenos data-linenos="536 "></span><span class=sd> ```</span>
<span class=linenos data-linenos="537 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="538 "></span>
<span class=linenos data-linenos="539 "></span> <span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="540 "></span> <span class=k>def</span> <span class=nf>find</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="541 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="542 "></span><span class=sd> :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:</span>
<span class=linenos data-linenos="543 "></span>
<span class=linenos data-linenos="544 "></span><span class=sd> This should return information about how to locate the environment or represent its ID in</span>
<span class=linenos data-linenos="545 "></span><span class=sd> some way. Additionally, this is expected to return something even if the environment is</span>
<span class=linenos data-linenos="546 "></span><span class=sd> [incompatible](reference.md#hatch.env.plugin.interface.EnvironmentInterface.check_compatibility).</span>
<span class=linenos data-linenos="547 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="548 "></span>
<span class=linenos data-linenos="549 "></span> <span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="550 "></span> <span class=k>def</span> <span class=nf>create</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="551 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="552 "></span><span class=sd> :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:</span>
<span class=linenos data-linenos="553 "></span>
<span class=linenos data-linenos="554 "></span><span class=sd> This should perform the necessary steps to set up the environment.</span>
<span class=linenos data-linenos="555 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="556 "></span>
<span class=linenos data-linenos="557 "></span> <span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="558 "></span> <span class=k>def</span> <span class=nf>remove</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="559 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="560 "></span><span class=sd> :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:</span>
<span class=linenos data-linenos="561 "></span>
<span class=linenos data-linenos="562 "></span><span class=sd> This should perform the necessary steps to completely remove the environment from the system and will only</span>
<span class=linenos data-linenos="563 "></span><span class=sd> be triggered manually by users with the [`env remove`](../../cli/reference.md#hatch-env-remove) or</span>
<span class=linenos data-linenos="564 "></span><span class=sd> [`env prune`](../../cli/reference.md#hatch-env-prune) commands.</span>
<span class=linenos data-linenos="565 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="566 "></span>
<span class=linenos data-linenos="567 "></span> <span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="568 "></span> <span class=k>def</span> <span class=nf>exists</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>bool</span><span class=p>:</span>
<span class=linenos data-linenos="569 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="570 "></span><span class=sd> :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:</span>
<span class=linenos data-linenos="571 "></span>
<span class=linenos data-linenos="572 "></span><span class=sd> This should indicate whether or not the environment has already been created.</span>
<span class=linenos data-linenos="573 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="574 "></span>
<span class=linenos data-linenos="575 "></span> <span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="576 "></span> <span class=k>def</span> <span class=nf>install_project</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="577 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="578 "></span><span class=sd> :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:</span>
<span class=linenos data-linenos="579 "></span>
<span class=linenos data-linenos="580 "></span><span class=sd> This should install the project in the environment.</span>
<span class=linenos data-linenos="581 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="582 "></span>
<span class=linenos data-linenos="583 "></span> <span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="584 "></span> <span class=k>def</span> <span class=nf>install_project_dev_mode</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="585 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="586 "></span><span class=sd> :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:</span>
<span class=linenos data-linenos="587 "></span>
<span class=linenos data-linenos="588 "></span><span class=sd> This should install the project in the environment such that the environment</span>
<span class=linenos data-linenos="589 "></span><span class=sd> always reflects the current state of the project.</span>
<span class=linenos data-linenos="590 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="591 "></span>
<span class=linenos data-linenos="592 "></span> <span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="593 "></span> <span class=k>def</span> <span class=nf>dependencies_in_sync</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>bool</span><span class=p>:</span>
<span class=linenos data-linenos="594 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="595 "></span><span class=sd> :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:</span>
<span class=linenos data-linenos="596 "></span>
<span class=linenos data-linenos="597 "></span><span class=sd> This should indicate whether or not the environment is compatible with the current</span>
<span class=linenos data-linenos="598 "></span><span class=sd> [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies).</span>
<span class=linenos data-linenos="599 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="600 "></span>
<span class=linenos data-linenos="601 "></span> <span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="602 "></span> <span class=k>def</span> <span class=nf>sync_dependencies</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="603 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="604 "></span><span class=sd> :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:</span>
<span class=linenos data-linenos="605 "></span>
<span class=linenos data-linenos="606 "></span><span class=sd> This should install the</span>
<span class=linenos data-linenos="607 "></span><span class=sd> [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies)</span>
<span class=linenos data-linenos="608 "></span><span class=sd> in the environment.</span>
<span class=linenos data-linenos="609 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="610 "></span>
<span class=linenos data-linenos="611 "></span> <span class=k>def</span> <span class=nf>dependency_hash</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="612 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="613 "></span><span class=sd> This should return a hash of the environment&#39;s</span>
<span class=linenos data-linenos="614 "></span><span class=sd> [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies)</span>
<span class=linenos data-linenos="615 "></span><span class=sd> and any other data that is handled by the</span>
<span class=linenos data-linenos="616 "></span><span class=sd> [sync_dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.sync_dependencies)</span>
<span class=linenos data-linenos="617 "></span><span class=sd> and</span>
<span class=linenos data-linenos="618 "></span><span class=sd> [dependencies_in_sync](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies_in_sync)</span>
<span class=linenos data-linenos="619 "></span><span class=sd> methods.</span>
<span class=linenos data-linenos="620 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="621 "></span> <span class=kn>from</span> <span class=nn>hatch.utils.dep</span> <span class=kn>import</span> <span class=n>hash_dependencies</span>
<span class=linenos data-linenos="622 "></span>
<span class=linenos data-linenos="623 "></span> <span class=k>return</span> <span class=n>hash_dependencies</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>dependencies_complex</span><span class=p>)</span>
<span class=linenos data-linenos="624 "></span>
<span class=linenos data-linenos="625 "></span> <span class=nd>@contextmanager</span>
<span class=linenos data-linenos="626 "></span> <span class=k>def</span> <span class=nf>app_status_creation</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="627 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="628 "></span><span class=sd> See the [life cycle of environments](reference.md#life-cycle).</span>
<span class=linenos data-linenos="629 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="630 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>status</span><span class=p>(</span><span class=sa>f</span><span class=s1>&#39;Creating environment: </span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="631 "></span> <span class=k>yield</span>
<span class=linenos data-linenos="632 "></span>
<span class=linenos data-linenos="633 "></span> <span class=nd>@contextmanager</span>
<span class=linenos data-linenos="634 "></span> <span class=k>def</span> <span class=nf>app_status_pre_installation</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="635 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="636 "></span><span class=sd> See the [life cycle of environments](reference.md#life-cycle).</span>
<span class=linenos data-linenos="637 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="638 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>status</span><span class=p>(</span><span class=s1>&#39;Running pre-installation commands&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="639 "></span> <span class=k>yield</span>
<span class=linenos data-linenos="640 "></span>
<span class=linenos data-linenos="641 "></span> <span class=nd>@contextmanager</span>
<span class=linenos data-linenos="642 "></span> <span class=k>def</span> <span class=nf>app_status_post_installation</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="643 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="644 "></span><span class=sd> See the [life cycle of environments](reference.md#life-cycle).</span>
<span class=linenos data-linenos="645 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="646 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>status</span><span class=p>(</span><span class=s1>&#39;Running post-installation commands&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="647 "></span> <span class=k>yield</span>
<span class=linenos data-linenos="648 "></span>
<span class=linenos data-linenos="649 "></span> <span class=nd>@contextmanager</span>
<span class=linenos data-linenos="650 "></span> <span class=k>def</span> <span class=nf>app_status_project_installation</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="651 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="652 "></span><span class=sd> See the [life cycle of environments](reference.md#life-cycle).</span>
<span class=linenos data-linenos="653 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="654 "></span> <span class=k>if</span> <span class=bp>self</span><span class=o>.</span><span class=n>dev_mode</span><span class=p>:</span>
<span class=linenos data-linenos="655 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>status</span><span class=p>(</span><span class=s1>&#39;Installing project in development mode&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="656 "></span> <span class=k>yield</span>
<span class=linenos data-linenos="657 "></span> <span class=k>else</span><span class=p>:</span>
<span class=linenos data-linenos="658 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>status</span><span class=p>(</span><span class=s1>&#39;Installing project&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="659 "></span> <span class=k>yield</span>
<span class=linenos data-linenos="660 "></span>
<span class=linenos data-linenos="661 "></span> <span class=nd>@contextmanager</span>
<span class=linenos data-linenos="662 "></span> <span class=k>def</span> <span class=nf>app_status_dependency_state_check</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="663 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="664 "></span><span class=sd> See the [life cycle of environments](reference.md#life-cycle).</span>
<span class=linenos data-linenos="665 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="666 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=bp>self</span><span class=o>.</span><span class=n>skip_install</span> <span class=ow>and</span> <span class=p>(</span>
<span class=linenos data-linenos="667 "></span> <span class=s1>&#39;dependencies&#39;</span> <span class=ow>in</span> <span class=bp>self</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>dynamic</span> <span class=ow>or</span> <span class=s1>&#39;optional-dependencies&#39;</span> <span class=ow>in</span> <span class=bp>self</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>dynamic</span>
<span class=linenos data-linenos="668 "></span> <span class=p>):</span>
<span class=linenos data-linenos="669 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>status</span><span class=p>(</span><span class=s1>&#39;Polling dependency state&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="670 "></span> <span class=k>yield</span>
<span class=linenos data-linenos="671 "></span> <span class=k>else</span><span class=p>:</span>
<span class=linenos data-linenos="672 "></span> <span class=k>yield</span>
<span class=linenos data-linenos="673 "></span>
<span class=linenos data-linenos="674 "></span> <span class=nd>@contextmanager</span>
<span class=linenos data-linenos="675 "></span> <span class=k>def</span> <span class=nf>app_status_dependency_installation_check</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="676 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="677 "></span><span class=sd> See the [life cycle of environments](reference.md#life-cycle).</span>
<span class=linenos data-linenos="678 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="679 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>status</span><span class=p>(</span><span class=s1>&#39;Checking dependencies&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="680 "></span> <span class=k>yield</span>
<span class=linenos data-linenos="681 "></span>
<span class=linenos data-linenos="682 "></span> <span class=nd>@contextmanager</span>
<span class=linenos data-linenos="683 "></span> <span class=k>def</span> <span class=nf>app_status_dependency_synchronization</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="684 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="685 "></span><span class=sd> See the [life cycle of environments](reference.md#life-cycle).</span>
<span class=linenos data-linenos="686 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="687 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>status</span><span class=p>(</span><span class=s1>&#39;Syncing dependencies&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="688 "></span> <span class=k>yield</span>
<span class=linenos data-linenos="689 "></span>
<span class=linenos data-linenos="690 "></span> <span class=nd>@contextmanager</span>
<span class=linenos data-linenos="691 "></span> <span class=k>def</span> <span class=nf>fs_context</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=n>Generator</span><span class=p>[</span><span class=n>FileSystemContext</span><span class=p>,</span> <span class=kc>None</span><span class=p>,</span> <span class=kc>None</span><span class=p>]:</span>
<span class=linenos data-linenos="692 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="693 "></span><span class=sd> A context manager that must yield a subclass of</span>
<span class=linenos data-linenos="694 "></span><span class=sd> [FileSystemContext](../utilities.md#hatch.env.plugin.interface.FileSystemContext).</span>
<span class=linenos data-linenos="695 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="696 "></span> <span class=kn>from</span> <span class=nn>hatch.utils.fs</span> <span class=kn>import</span> <span class=n>temp_directory</span>
<span class=linenos data-linenos="697 "></span>
<span class=linenos data-linenos="698 "></span> <span class=k>with</span> <span class=n>temp_directory</span><span class=p>()</span> <span class=k>as</span> <span class=n>temp_dir</span><span class=p>:</span>
<span class=linenos data-linenos="699 "></span> <span class=k>yield</span> <span class=n>FileSystemContext</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>local_path</span><span class=o>=</span><span class=n>temp_dir</span><span class=p>,</span> <span class=n>env_path</span><span class=o>=</span><span class=nb>str</span><span class=p>(</span><span class=n>temp_dir</span><span class=p>))</span>
<span class=linenos data-linenos="700 "></span>
<span class=linenos data-linenos="701 "></span> <span class=k>def</span> <span class=nf>enter_shell</span><span class=p>(</span>
<span class=linenos data-linenos="702 "></span> <span class=bp>self</span><span class=p>,</span>
<span class=linenos data-linenos="703 "></span> <span class=n>name</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=c1># noqa: ARG002</span>
<span class=linenos data-linenos="704 "></span> <span class=n>path</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span>
<span class=linenos data-linenos="705 "></span> <span class=n>args</span><span class=p>:</span> <span class=n>Iterable</span><span class=p>[</span><span class=nb>str</span><span class=p>],</span>
<span class=linenos data-linenos="706 "></span> <span class=p>):</span>
<span class=linenos data-linenos="707 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="708 "></span><span class=sd> Spawn a [shell](../../config/hatch.md#shell) within the environment.</span>
<span class=linenos data-linenos="709 "></span>
<span class=linenos data-linenos="710 "></span><span class=sd> This should either use</span>
<span class=linenos data-linenos="711 "></span><span class=sd> [command_context](reference.md#hatch.env.plugin.interface.EnvironmentInterface.command_context)</span>
<span class=linenos data-linenos="712 "></span><span class=sd> directly or provide the same guarantee.</span>
<span class=linenos data-linenos="713 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="714 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>command_context</span><span class=p>():</span>
<span class=linenos data-linenos="715 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>platform</span><span class=o>.</span><span class=n>exit_with_command</span><span class=p>([</span><span class=n>path</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>])</span>
<span class=linenos data-linenos="716 "></span>
<span class=linenos data-linenos="717 "></span> <span class=k>def</span> <span class=nf>run_shell_command</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>command</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>):</span>
<span class=linenos data-linenos="718 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="719 "></span><span class=sd> This should return the standard library&#39;s</span>
<span class=linenos data-linenos="720 "></span><span class=sd> [subprocess.CompletedProcess](https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess)</span>
<span class=linenos data-linenos="721 "></span><span class=sd> and will always be called when the</span>
<span class=linenos data-linenos="722 "></span><span class=sd> [command_context](reference.md#hatch.env.plugin.interface.EnvironmentInterface.command_context)</span>
<span class=linenos data-linenos="723 "></span><span class=sd> is active, with the expectation of providing the same guarantee.</span>
<span class=linenos data-linenos="724 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="725 "></span> <span class=n>kwargs</span><span class=o>.</span><span class=n>setdefault</span><span class=p>(</span><span class=s1>&#39;shell&#39;</span><span class=p>,</span> <span class=kc>True</span><span class=p>)</span>
<span class=linenos data-linenos="726 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>platform</span><span class=o>.</span><span class=n>run_command</span><span class=p>(</span><span class=n>command</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>)</span>
<span class=linenos data-linenos="727 "></span>
<span class=linenos data-linenos="728 "></span> <span class=nd>@contextmanager</span>
<span class=linenos data-linenos="729 "></span> <span class=k>def</span> <span class=nf>command_context</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="730 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="731 "></span><span class=sd> A context manager that when active should make executed shell commands reflect any</span>
<span class=linenos data-linenos="732 "></span><span class=sd> [environment variables](reference.md#hatch.env.plugin.interface.EnvironmentInterface.get_env_vars)</span>
<span class=linenos data-linenos="733 "></span><span class=sd> the user defined either currently or at the time of</span>
<span class=linenos data-linenos="734 "></span><span class=sd> [creation](reference.md#hatch.env.plugin.interface.EnvironmentInterface.create).</span>
<span class=linenos data-linenos="735 "></span>
<span class=linenos data-linenos="736 "></span><span class=sd> For an example, open the default implementation below:</span>
<span class=linenos data-linenos="737 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="738 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>get_env_vars</span><span class=p>():</span>
<span class=linenos data-linenos="739 "></span> <span class=k>yield</span>
<span class=linenos data-linenos="740 "></span>
<span class=linenos data-linenos="741 "></span> <span class=k>def</span> <span class=nf>resolve_commands</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>commands</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]):</span>
<span class=linenos data-linenos="742 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="743 "></span><span class=sd> This expands each command into one or more commands based on any</span>
<span class=linenos data-linenos="744 "></span><span class=sd> [scripts](../../config/environment/overview.md#scripts) that the user defined.</span>
<span class=linenos data-linenos="745 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="746 "></span> <span class=k>for</span> <span class=n>command</span> <span class=ow>in</span> <span class=n>commands</span><span class=p>:</span>
<span class=linenos data-linenos="747 "></span> <span class=k>yield from</span> <span class=bp>self</span><span class=o>.</span><span class=n>expand_command</span><span class=p>(</span><span class=n>command</span><span class=p>)</span>
<span class=linenos data-linenos="748 "></span>
<span class=linenos data-linenos="749 "></span> <span class=k>def</span> <span class=nf>expand_command</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>command</span><span class=p>):</span>
<span class=linenos data-linenos="750 "></span> <span class=n>possible_script</span><span class=p>,</span> <span class=n>args</span><span class=p>,</span> <span class=n>_ignore_exit_code</span> <span class=o>=</span> <span class=n>parse_script_command</span><span class=p>(</span><span class=n>command</span><span class=p>)</span>
<span class=linenos data-linenos="751 "></span>
<span class=linenos data-linenos="752 "></span> <span class=c1># Indicate undefined</span>
<span class=linenos data-linenos="753 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=n>args</span><span class=p>:</span>
<span class=linenos data-linenos="754 "></span> <span class=n>args</span> <span class=o>=</span> <span class=kc>None</span>
<span class=linenos data-linenos="755 "></span>
<span class=linenos data-linenos="756 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>apply_context</span><span class=p>():</span>
<span class=linenos data-linenos="757 "></span> <span class=k>if</span> <span class=n>possible_script</span> <span class=ow>in</span> <span class=bp>self</span><span class=o>.</span><span class=n>scripts</span><span class=p>:</span>
<span class=linenos data-linenos="758 "></span> <span class=k>if</span> <span class=n>args</span> <span class=ow>is</span> <span class=ow>not</span> <span class=kc>None</span><span class=p>:</span>
<span class=linenos data-linenos="759 "></span> <span class=n>args</span> <span class=o>=</span> <span class=bp>self</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>context</span><span class=o>.</span><span class=n>format</span><span class=p>(</span><span class=n>args</span><span class=p>)</span>
<span class=linenos data-linenos="760 "></span>
<span class=linenos data-linenos="761 "></span> <span class=k>for</span> <span class=n>cmd</span> <span class=ow>in</span> <span class=bp>self</span><span class=o>.</span><span class=n>scripts</span><span class=p>[</span><span class=n>possible_script</span><span class=p>]:</span>
<span class=linenos data-linenos="762 "></span> <span class=k>yield</span> <span class=bp>self</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>context</span><span class=o>.</span><span class=n>format</span><span class=p>(</span><span class=n>cmd</span><span class=p>,</span> <span class=n>args</span><span class=o>=</span><span class=n>args</span><span class=p>)</span><span class=o>.</span><span class=n>strip</span><span class=p>()</span>
<span class=linenos data-linenos="763 "></span> <span class=k>else</span><span class=p>:</span>
<span class=linenos data-linenos="764 "></span> <span class=k>yield</span> <span class=bp>self</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>context</span><span class=o>.</span><span class=n>format</span><span class=p>(</span><span class=n>command</span><span class=p>,</span> <span class=n>args</span><span class=o>=</span><span class=n>args</span><span class=p>)</span><span class=o>.</span><span class=n>strip</span><span class=p>()</span>
<span class=linenos data-linenos="765 "></span>
<span class=linenos data-linenos="766 "></span> <span class=k>def</span> <span class=nf>construct_pip_install_command</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>args</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]):</span>
<span class=linenos data-linenos="767 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="768 "></span><span class=sd> A convenience method for constructing a [`pip install`](https://pip.pypa.io/en/stable/cli/pip_install/)</span>
<span class=linenos data-linenos="769 "></span><span class=sd> command with the given verbosity. The default verbosity is set to one less than Hatch&#39;s verbosity.</span>
<span class=linenos data-linenos="770 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="771 "></span> <span class=n>command</span> <span class=o>=</span> <span class=p>[</span><span class=s1>&#39;python&#39;</span><span class=p>,</span> <span class=s1>&#39;-u&#39;</span><span class=p>,</span> <span class=s1>&#39;-m&#39;</span><span class=p>,</span> <span class=s1>&#39;pip&#39;</span><span class=p>,</span> <span class=s1>&#39;install&#39;</span><span class=p>,</span> <span class=s1>&#39;--disable-pip-version-check&#39;</span><span class=p>,</span> <span class=s1>&#39;--no-python-version-warning&#39;</span><span class=p>]</span>
<span class=linenos data-linenos="772 "></span>
<span class=linenos data-linenos="773 "></span> <span class=c1># Default to -1 verbosity</span>
<span class=linenos data-linenos="774 "></span> <span class=n>add_verbosity_flag</span><span class=p>(</span><span class=n>command</span><span class=p>,</span> <span class=bp>self</span><span class=o>.</span><span class=n>verbosity</span><span class=p>,</span> <span class=n>adjustment</span><span class=o>=-</span><span class=mi>1</span><span class=p>)</span>
<span class=linenos data-linenos="775 "></span>
<span class=linenos data-linenos="776 "></span> <span class=n>command</span><span class=o>.</span><span class=n>extend</span><span class=p>(</span><span class=n>args</span><span class=p>)</span>
<span class=linenos data-linenos="777 "></span> <span class=k>return</span> <span class=n>command</span>
<span class=linenos data-linenos="778 "></span>
<span class=linenos data-linenos="779 "></span> <span class=k>def</span> <span class=nf>join_command_args</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>args</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]):</span>
<span class=linenos data-linenos="780 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="781 "></span><span class=sd> This is used by the [`run`](../../cli/reference.md#hatch-run) command to construct the root command string</span>
<span class=linenos data-linenos="782 "></span><span class=sd> from the received arguments.</span>
<span class=linenos data-linenos="783 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="784 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>platform</span><span class=o>.</span><span class=n>join_command_args</span><span class=p>(</span><span class=n>args</span><span class=p>)</span>
<span class=linenos data-linenos="785 "></span>
<span class=linenos data-linenos="786 "></span> <span class=k>def</span> <span class=nf>apply_features</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>requirement</span><span class=p>:</span> <span class=nb>str</span><span class=p>):</span>
<span class=linenos data-linenos="787 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="788 "></span><span class=sd> A convenience method that applies any user defined [features](../../config/environment/overview.md#features)</span>
<span class=linenos data-linenos="789 "></span><span class=sd> to the given requirement.</span>
<span class=linenos data-linenos="790 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="791 "></span> <span class=k>if</span> <span class=bp>self</span><span class=o>.</span><span class=n>features</span><span class=p>:</span>
<span class=linenos data-linenos="792 "></span> <span class=n>features</span> <span class=o>=</span> <span class=s1>&#39;,&#39;</span><span class=o>.</span><span class=n>join</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>features</span><span class=p>)</span>
<span class=linenos data-linenos="793 "></span> <span class=k>return</span> <span class=sa>f</span><span class=s1>&#39;</span><span class=si>{</span><span class=n>requirement</span><span class=si>}</span><span class=s1>[</span><span class=si>{</span><span class=n>features</span><span class=si>}</span><span class=s1>]&#39;</span>
<span class=linenos data-linenos="794 "></span>
<span class=linenos data-linenos="795 "></span> <span class=k>return</span> <span class=n>requirement</span>
<span class=linenos data-linenos="796 "></span>
<span class=linenos data-linenos="797 "></span> <span class=k>def</span> <span class=nf>check_compatibility</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="798 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="799 "></span><span class=sd> This raises an exception if the environment is not compatible with the user&#39;s setup. The default behavior</span>
<span class=linenos data-linenos="800 "></span><span class=sd> checks for [platform compatibility](../../config/environment/overview.md#supported-platforms)</span>
<span class=linenos data-linenos="801 "></span><span class=sd> and any method override should keep this check.</span>
<span class=linenos data-linenos="802 "></span>
<span class=linenos data-linenos="803 "></span><span class=sd> This check is never performed if the environment has been</span>
<span class=linenos data-linenos="804 "></span><span class=sd> [created](reference.md#hatch.env.plugin.interface.EnvironmentInterface.create).</span>
<span class=linenos data-linenos="805 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="806 "></span> <span class=k>if</span> <span class=bp>self</span><span class=o>.</span><span class=n>platforms</span> <span class=ow>and</span> <span class=bp>self</span><span class=o>.</span><span class=n>platform</span><span class=o>.</span><span class=n>name</span> <span class=ow>not</span> <span class=ow>in</span> <span class=bp>self</span><span class=o>.</span><span class=n>platforms</span><span class=p>:</span>
<span class=linenos data-linenos="807 "></span> <span class=n>message</span> <span class=o>=</span> <span class=s1>&#39;unsupported platform&#39;</span>
<span class=linenos data-linenos="808 "></span> <span class=k>raise</span> <span class=ne>OSError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
<span class=linenos data-linenos="809 "></span>
<span class=linenos data-linenos="810 "></span> <span class=k>def</span> <span class=nf>get_env_vars</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=n>EnvVars</span><span class=p>:</span>
<span class=linenos data-linenos="811 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="812 "></span><span class=sd> Returns a mapping of environment variables that should be available to the environment. The object can</span>
<span class=linenos data-linenos="813 "></span><span class=sd> be used as a context manager to temporarily apply the environment variables to the current process.</span>
<span class=linenos data-linenos="814 "></span>
<span class=linenos data-linenos="815 "></span><span class=sd> !!! note</span>
<span class=linenos data-linenos="816 "></span><span class=sd> The environment variable `HATCH_ENV_ACTIVE` will always be set to the name of the environment.</span>
<span class=linenos data-linenos="817 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="818 "></span> <span class=k>return</span> <span class=n>EnvVars</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>env_vars</span><span class=p>,</span> <span class=bp>self</span><span class=o>.</span><span class=n>env_include</span><span class=p>,</span> <span class=bp>self</span><span class=o>.</span><span class=n>env_exclude</span><span class=p>)</span>
<span class=linenos data-linenos="819 "></span>
<span class=linenos data-linenos="820 "></span> <span class=k>def</span> <span class=nf>get_env_var_option</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>option</span><span class=p>:</span> <span class=nb>str</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>str</span><span class=p>:</span>
<span class=linenos data-linenos="821 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="822 "></span><span class=sd> Returns the value of the upper-cased environment variable `HATCH_ENV_TYPE_&lt;PLUGIN_NAME&gt;_&lt;option&gt;`.</span>
<span class=linenos data-linenos="823 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="824 "></span> <span class=k>return</span> <span class=n>get_env_var_option</span><span class=p>(</span><span class=n>plugin_name</span><span class=o>=</span><span class=bp>self</span><span class=o>.</span><span class=n>PLUGIN_NAME</span><span class=p>,</span> <span class=n>option</span><span class=o>=</span><span class=n>option</span><span class=p>)</span>
<span class=linenos data-linenos="825 "></span>
<span class=linenos data-linenos="826 "></span> <span class=k>def</span> <span class=nf>get_context</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="827 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="828 "></span><span class=sd> Returns a subclass of</span>
<span class=linenos data-linenos="829 "></span><span class=sd> [EnvironmentContextFormatter](../utilities.md#hatch.env.context.EnvironmentContextFormatter).</span>
<span class=linenos data-linenos="830 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="831 "></span> <span class=kn>from</span> <span class=nn>hatch.env.context</span> <span class=kn>import</span> <span class=n>EnvironmentContextFormatter</span>
<span class=linenos data-linenos="832 "></span>
<span class=linenos data-linenos="833 "></span> <span class=k>return</span> <span class=n>EnvironmentContextFormatter</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span>
<span class=linenos data-linenos="834 "></span>
<span class=linenos data-linenos="835 "></span> <span class=nd>@staticmethod</span>
<span class=linenos data-linenos="836 "></span> <span class=k>def</span> <span class=nf>get_option_types</span><span class=p>()</span> <span class=o>-&gt;</span> <span class=nb>dict</span><span class=p>:</span>
<span class=linenos data-linenos="837 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="838 "></span><span class=sd> Returns a mapping of supported options to their respective types so that they can be used by</span>
<span class=linenos data-linenos="839 "></span><span class=sd> [overrides](../../config/environment/advanced.md#option-overrides).</span>
<span class=linenos data-linenos="840 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="841 "></span> <span class=k>return</span> <span class=p>{}</span>
<span class=linenos data-linenos="842 "></span>
<span class=linenos data-linenos="843 "></span> <span class=nd>@contextmanager</span>
<span class=linenos data-linenos="844 "></span> <span class=k>def</span> <span class=nf>apply_context</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="845 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>get_env_vars</span><span class=p>(),</span> <span class=bp>self</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>context</span><span class=o>.</span><span class=n>apply_context</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>context</span><span class=p>):</span>
<span class=linenos data-linenos="846 "></span> <span class=k>yield</span>
<span class=linenos data-linenos="847 "></span>
<span class=linenos data-linenos="848 "></span> <span class=k>def</span> <span class=fm>__enter__</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="849 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>activate</span><span class=p>()</span>
<span class=linenos data-linenos="850 "></span> <span class=k>return</span> <span class=bp>self</span>
<span class=linenos data-linenos="851 "></span>
<span class=linenos data-linenos="852 "></span> <span class=k>def</span> <span class=fm>__exit__</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>exc_type</span><span class=p>,</span> <span class=n>exc_value</span><span class=p>,</span> <span class=n>traceback</span><span class=p>):</span>
<span class=linenos data-linenos="853 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>deactivate</span><span class=p>()</span>
</code></pre></div> </details> <div class="doc doc-children"> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.PLUGIN_NAME class="doc doc-heading"> <code class="highlight language-python"><span class=n>PLUGIN_NAME</span> <span class=o>=</span> <span class=s1>&#39;&#39;</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-class-attribute"><code>class-attribute</code></small> <small class="doc doc-label doc-label-instance-attribute"><code>instance-attribute</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.PLUGIN_NAME class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>The name used for selection.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.project_root class="doc doc-heading"> <code class="highlight language-python"><span class=n>project_root</span><span class=p>:</span> <span class=nb>str</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-cached"><code>cached</code></small> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.project_root class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>The root of the project tree as a string. If the environment is not running locally, this should be the remote path to the project.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.sep class="doc doc-heading"> <code class="highlight language-python"><span class=n>sep</span><span class=p>:</span> <span class=nb>str</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-cached"><code>cached</code></small> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.sep class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>The character used to separate directories in paths. By default, this is <code>\</code> on Windows and <code>/</code> otherwise.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.pathsep class="doc doc-heading"> <code class="highlight language-python"><span class=n>pathsep</span><span class=p>:</span> <span class=nb>str</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-cached"><code>cached</code></small> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.pathsep class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>The character used to separate paths. By default, this is <code>;</code> on Windows and <code>:</code> otherwise.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.app class="doc doc-heading"> <code class="highlight language-python"><span class=n>app</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>An instance of <a href=../../utilities/#hatchling.bridge.app.Application>Application</a>.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.root class="doc doc-heading"> <code class="highlight language-python"><span class=n>root</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.root class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>The root of the local project tree as a path-like object.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.name class="doc doc-heading"> <code class="highlight language-python"><span class=n>name</span><span class=p>:</span> <span class=nb>str</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.name class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>The name of the environment.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.data_directory class="doc doc-heading"> <code class="highlight language-python"><span class=n>data_directory</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.data_directory class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>The <a href=../../../config/hatch/#environments>directory</a> this plugin should use for storage as a path-like object. If the user has not configured one then this will be the same as the <a href=./#hatch.env.plugin.interface.EnvironmentInterface.isolated_data_directory>isolated data directory</a>.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.isolated_data_directory class="doc doc-heading"> <code class="highlight language-python"><span class=n>isolated_data_directory</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.isolated_data_directory class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>The default <a href=../../../config/hatch/#environments>directory</a> reserved exclusively for this plugin as a path-like object.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.config class="doc doc-heading"> <code class="highlight language-python"><span class=n>config</span><span class=p>:</span> <span class=nb>dict</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.config class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <div class="tabbed-set tabbed-alternate" data-tabs=1:2><input checked=checked id=hatch.env.plugin.interface.EnvironmentInterface.config--pyprojecttoml name=hatch.env.plugin.interface.EnvironmentInterface.config--__tabbed_1 type=radio><input id=hatch.env.plugin.interface.EnvironmentInterface.config--hatchtoml name=hatch.env.plugin.interface.EnvironmentInterface.config--__tabbed_1 type=radio><div class=tabbed-labels><label for=hatch.env.plugin.interface.EnvironmentInterface.config--pyprojecttoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> pyproject.toml</label><label for=hatch.env.plugin.interface.EnvironmentInterface.config--hatchtoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> hatch.toml</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[tool.hatch.envs.</span><span class=err>&lt;</span><span class=k>ENV_NAME</span><span class=err>&gt;</span><span class=k>]</span>
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.</span><span class=err>&lt;</span><span class=k>ENV_NAME</span><span class=err>&gt;</span><span class=k>]</span>
</code></pre></div> </div> </div> </div> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.platform class="doc doc-heading"> <code class="highlight language-python"><span class=n>platform</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.platform class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>An instance of <a href=../../utilities/#hatch.utils.platform.Platform>Platform</a>.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.environment_dependencies class="doc doc-heading"> <code class="highlight language-python"><span class=n>environment_dependencies</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-cached"><code>cached</code></small> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.environment_dependencies class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>The list of all <a href=../../../config/environment/overview/#dependencies>environment dependencies</a>.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.dependencies class="doc doc-heading"> <code class="highlight language-python"><span class=n>dependencies</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-cached"><code>cached</code></small> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.dependencies class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>The list of all <a href=../../../config/metadata/#dependencies>project dependencies</a> (if <a href=../../../config/environment/overview/#skip-install>installed</a> and in <a href=../../../config/environment/overview/#dev-mode>dev mode</a>), selected <a href=../../../config/environment/overview/#features>optional dependencies</a>, and <a href=../../../config/environment/overview/#dependencies>environment dependencies</a>.</p> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.env_vars class="doc doc-heading"> <code class="highlight language-python"><span class=n>env_vars</span><span class=p>:</span> <span class=nb>dict</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-cached"><code>cached</code></small> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.env_vars class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <div class="tabbed-set tabbed-alternate" data-tabs=1:2><input checked=checked id=hatch.env.plugin.interface.EnvironmentInterface.env_vars--pyprojecttoml name=hatch.env.plugin.interface.EnvironmentInterface.env_vars--__tabbed_1 type=radio><input id=hatch.env.plugin.interface.EnvironmentInterface.env_vars--hatchtoml name=hatch.env.plugin.interface.EnvironmentInterface.env_vars--__tabbed_1 type=radio><div class=tabbed-labels><label for=hatch.env.plugin.interface.EnvironmentInterface.env_vars--pyprojecttoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> pyproject.toml</label><label for=hatch.env.plugin.interface.EnvironmentInterface.env_vars--hatchtoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> hatch.toml</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[tool.hatch.envs.</span><span class=err>&lt;</span><span class=k>ENV_NAME</span><span class=err>&gt;</span><span class=k>.env-vars]</span>
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.</span><span class=err>&lt;</span><span class=k>ENV_NAME</span><span class=err>&gt;</span><span class=k>.env-vars]</span>
</code></pre></div> </div> </div> </div> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.env_include class="doc doc-heading"> <code class="highlight language-python"><span class=n>env_include</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-cached"><code>cached</code></small> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.env_include class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <div class="tabbed-set tabbed-alternate" data-tabs=1:2><input checked=checked id=hatch.env.plugin.interface.EnvironmentInterface.env_include--pyprojecttoml name=hatch.env.plugin.interface.EnvironmentInterface.env_include--__tabbed_1 type=radio><input id=hatch.env.plugin.interface.EnvironmentInterface.env_include--hatchtoml name=hatch.env.plugin.interface.EnvironmentInterface.env_include--__tabbed_1 type=radio><div class=tabbed-labels><label for=hatch.env.plugin.interface.EnvironmentInterface.env_include--pyprojecttoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> pyproject.toml</label><label for=hatch.env.plugin.interface.EnvironmentInterface.env_include--hatchtoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> hatch.toml</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[tool.hatch.envs.</span><span class=err>&lt;</span><span class=k>ENV_NAME</span><span class=err>&gt;</span><span class=k>]</span>
<span class=n>env-include</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=err>...]</span>
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.</span><span class=err>&lt;</span><span class=k>ENV_NAME</span><span class=err>&gt;</span><span class=k>]</span>
<span class=n>env-include</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=err>...]</span>
</code></pre></div> </div> </div> </div> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.env_exclude class="doc doc-heading"> <code class="highlight language-python"><span class=n>env_exclude</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-cached"><code>cached</code></small> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.env_exclude class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <div class="tabbed-set tabbed-alternate" data-tabs=1:2><input checked=checked id=hatch.env.plugin.interface.EnvironmentInterface.env_exclude--pyprojecttoml name=hatch.env.plugin.interface.EnvironmentInterface.env_exclude--__tabbed_1 type=radio><input id=hatch.env.plugin.interface.EnvironmentInterface.env_exclude--hatchtoml name=hatch.env.plugin.interface.EnvironmentInterface.env_exclude--__tabbed_1 type=radio><div class=tabbed-labels><label for=hatch.env.plugin.interface.EnvironmentInterface.env_exclude--pyprojecttoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> pyproject.toml</label><label for=hatch.env.plugin.interface.EnvironmentInterface.env_exclude--hatchtoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> hatch.toml</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[tool.hatch.envs.</span><span class=err>&lt;</span><span class=k>ENV_NAME</span><span class=err>&gt;</span><span class=k>]</span>
<span class=n>env-exclude</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=err>...]</span>
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.</span><span class=err>&lt;</span><span class=k>ENV_NAME</span><span class=err>&gt;</span><span class=k>]</span>
<span class=n>env-exclude</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=err>...]</span>
</code></pre></div> </div> </div> </div> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.platforms class="doc doc-heading"> <code class="highlight language-python"><span class=n>platforms</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-cached"><code>cached</code></small> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.platforms class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>All names are stored as their lower-cased version.</p> <div class="tabbed-set tabbed-alternate" data-tabs=1:2><input checked=checked id=hatch.env.plugin.interface.EnvironmentInterface.platforms--pyprojecttoml name=hatch.env.plugin.interface.EnvironmentInterface.platforms--__tabbed_1 type=radio><input id=hatch.env.plugin.interface.EnvironmentInterface.platforms--hatchtoml name=hatch.env.plugin.interface.EnvironmentInterface.platforms--__tabbed_1 type=radio><div class=tabbed-labels><label for=hatch.env.plugin.interface.EnvironmentInterface.platforms--pyprojecttoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> pyproject.toml</label><label for=hatch.env.plugin.interface.EnvironmentInterface.platforms--hatchtoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> hatch.toml</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[tool.hatch.envs.</span><span class=err>&lt;</span><span class=k>ENV_NAME</span><span class=err>&gt;</span><span class=k>]</span>
<span class=n>platforms</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=err>...]</span>
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.</span><span class=err>&lt;</span><span class=k>ENV_NAME</span><span class=err>&gt;</span><span class=k>]</span>
<span class=n>platforms</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=err>...]</span>
</code></pre></div> </div> </div> </div> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.skip_install class="doc doc-heading"> <code class="highlight language-python"><span class=n>skip_install</span><span class=p>:</span> <span class=nb>bool</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-cached"><code>cached</code></small> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.skip_install class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <div class="tabbed-set tabbed-alternate" data-tabs=1:2><input checked=checked id=hatch.env.plugin.interface.EnvironmentInterface.skip_install--pyprojecttoml name=hatch.env.plugin.interface.EnvironmentInterface.skip_install--__tabbed_1 type=radio><input id=hatch.env.plugin.interface.EnvironmentInterface.skip_install--hatchtoml name=hatch.env.plugin.interface.EnvironmentInterface.skip_install--__tabbed_1 type=radio><div class=tabbed-labels><label for=hatch.env.plugin.interface.EnvironmentInterface.skip_install--pyprojecttoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> pyproject.toml</label><label for=hatch.env.plugin.interface.EnvironmentInterface.skip_install--hatchtoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> hatch.toml</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[tool.hatch.envs.</span><span class=err>&lt;</span><span class=k>ENV_NAME</span><span class=err>&gt;</span><span class=k>]</span>
<span class=n>skip-install</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=err>...</span>
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.</span><span class=err>&lt;</span><span class=k>ENV_NAME</span><span class=err>&gt;</span><span class=k>]</span>
<span class=n>skip-install</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=err>...</span>
</code></pre></div> </div> </div> </div> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.dev_mode class="doc doc-heading"> <code class="highlight language-python"><span class=n>dev_mode</span><span class=p>:</span> <span class=nb>bool</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-cached"><code>cached</code></small> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.dev_mode class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <div class="tabbed-set tabbed-alternate" data-tabs=1:2><input checked=checked id=hatch.env.plugin.interface.EnvironmentInterface.dev_mode--pyprojecttoml name=hatch.env.plugin.interface.EnvironmentInterface.dev_mode--__tabbed_1 type=radio><input id=hatch.env.plugin.interface.EnvironmentInterface.dev_mode--hatchtoml name=hatch.env.plugin.interface.EnvironmentInterface.dev_mode--__tabbed_1 type=radio><div class=tabbed-labels><label for=hatch.env.plugin.interface.EnvironmentInterface.dev_mode--pyprojecttoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> pyproject.toml</label><label for=hatch.env.plugin.interface.EnvironmentInterface.dev_mode--hatchtoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> hatch.toml</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[tool.hatch.envs.</span><span class=err>&lt;</span><span class=k>ENV_NAME</span><span class=err>&gt;</span><span class=k>]</span>
<span class=n>dev-mode</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=err>...</span>
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.</span><span class=err>&lt;</span><span class=k>ENV_NAME</span><span class=err>&gt;</span><span class=k>]</span>
<span class=n>dev-mode</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=err>...</span>
</code></pre></div> </div> </div> </div> </div> </div> <div class="doc doc-object doc-attribute"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.description class="doc doc-heading"> <code class="highlight language-python"><span class=n>description</span><span class=p>:</span> <span class=nb>str</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-cached"><code>cached</code></small> <small class="doc doc-label doc-label-property"><code>property</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.description class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <div class="tabbed-set tabbed-alternate" data-tabs=1:2><input checked=checked id=hatch.env.plugin.interface.EnvironmentInterface.description--pyprojecttoml name=hatch.env.plugin.interface.EnvironmentInterface.description--__tabbed_1 type=radio><input id=hatch.env.plugin.interface.EnvironmentInterface.description--hatchtoml name=hatch.env.plugin.interface.EnvironmentInterface.description--__tabbed_1 type=radio><div class=tabbed-labels><label for=hatch.env.plugin.interface.EnvironmentInterface.description--pyprojecttoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> pyproject.toml</label><label for=hatch.env.plugin.interface.EnvironmentInterface.description--hatchtoml><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 16 16"><path d="M4 1.75C4 .784 4.784 0 5.75 0h5.586c.464 0 .909.184 1.237.513l2.914 2.914c.329.328.513.773.513 1.237v8.586A1.75 1.75 0 0 1 14.25 15h-9a.75.75 0 0 1 0-1.5h9a.25.25 0 0 0 .25-.25V6h-2.75A1.75 1.75 0 0 1 10 4.25V1.5H5.75a.25.25 0 0 0-.25.25v2.5a.75.75 0 0 1-1.5 0Zm1.72 4.97a.75.75 0 0 1 1.06 0l2 2a.75.75 0 0 1 0 1.06l-2 2a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734l1.47-1.47-1.47-1.47a.75.75 0 0 1 0-1.06ZM3.28 7.78 1.81 9.25l1.47 1.47a.751.751 0 0 1-.018 1.042.751.751 0 0 1-1.042.018l-2-2a.75.75 0 0 1 0-1.06l2-2a.751.751 0 0 1 1.042.018.751.751 0 0 1 .018 1.042Zm8.22-6.218V4.25c0 .138.112.25.25.25h2.688l-.011-.013-2.914-2.914-.013-.011Z"/></svg></span> hatch.toml</label></div> <div class=tabbed-content> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[tool.hatch.envs.</span><span class=err>&lt;</span><span class=k>ENV_NAME</span><span class=err>&gt;</span><span class=k>]</span>
<span class=n>description</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=err>...</span>
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.</span><span class=err>&lt;</span><span class=k>ENV_NAME</span><span class=err>&gt;</span><span class=k>]</span>
<span class=n>description</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=err>...</span>
</code></pre></div> </div> </div> </div> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.find class="doc doc-heading"> <code class="highlight language-python"><span class=n>find</span><span class=p>()</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.find class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 22H2V2h2v20M22 7H6v3h16V7m-6 7H6v3h10v-3Z"/></svg></span> <strong>REQUIRED</strong> <span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 2h2v20h-2V2M2 10h16V7H2v3m6 7h10v-3H8v3Z"/></svg></span></p> <p>This should return information about how to locate the environment or represent its ID in some way. Additionally, this is expected to return something even if the environment is <a href=./#hatch.env.plugin.interface.EnvironmentInterface.check_compatibility>incompatible</a>.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="539 "></span><span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="540 "></span><span class=k>def</span> <span class=nf>find</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="541 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="542 "></span><span class=sd> :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:</span>
<span class=linenos data-linenos="543 "></span>
<span class=linenos data-linenos="544 "></span><span class=sd> This should return information about how to locate the environment or represent its ID in</span>
<span class=linenos data-linenos="545 "></span><span class=sd> some way. Additionally, this is expected to return something even if the environment is</span>
<span class=linenos data-linenos="546 "></span><span class=sd> [incompatible](reference.md#hatch.env.plugin.interface.EnvironmentInterface.check_compatibility).</span>
<span class=linenos data-linenos="547 "></span><span class=sd> &quot;&quot;&quot;</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.create class="doc doc-heading"> <code class="highlight language-python"><span class=n>create</span><span class=p>()</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.create class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 22H2V2h2v20M22 7H6v3h16V7m-6 7H6v3h10v-3Z"/></svg></span> <strong>REQUIRED</strong> <span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 2h2v20h-2V2M2 10h16V7H2v3m6 7h10v-3H8v3Z"/></svg></span></p> <p>This should perform the necessary steps to set up the environment.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="549 "></span><span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="550 "></span><span class=k>def</span> <span class=nf>create</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="551 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="552 "></span><span class=sd> :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:</span>
<span class=linenos data-linenos="553 "></span>
<span class=linenos data-linenos="554 "></span><span class=sd> This should perform the necessary steps to set up the environment.</span>
<span class=linenos data-linenos="555 "></span><span class=sd> &quot;&quot;&quot;</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.remove class="doc doc-heading"> <code class="highlight language-python"><span class=n>remove</span><span class=p>()</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.remove class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 22H2V2h2v20M22 7H6v3h16V7m-6 7H6v3h10v-3Z"/></svg></span> <strong>REQUIRED</strong> <span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 2h2v20h-2V2M2 10h16V7H2v3m6 7h10v-3H8v3Z"/></svg></span></p> <p>This should perform the necessary steps to completely remove the environment from the system and will only be triggered manually by users with the <a href=../../../cli/reference/#hatch-env-remove><code>env remove</code></a> or <a href=../../../cli/reference/#hatch-env-prune><code>env prune</code></a> commands.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="557 "></span><span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="558 "></span><span class=k>def</span> <span class=nf>remove</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="559 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="560 "></span><span class=sd> :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:</span>
<span class=linenos data-linenos="561 "></span>
<span class=linenos data-linenos="562 "></span><span class=sd> This should perform the necessary steps to completely remove the environment from the system and will only</span>
<span class=linenos data-linenos="563 "></span><span class=sd> be triggered manually by users with the [`env remove`](../../cli/reference.md#hatch-env-remove) or</span>
<span class=linenos data-linenos="564 "></span><span class=sd> [`env prune`](../../cli/reference.md#hatch-env-prune) commands.</span>
<span class=linenos data-linenos="565 "></span><span class=sd> &quot;&quot;&quot;</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.exists class="doc doc-heading"> <code class="highlight language-python"><span class=n>exists</span><span class=p>()</span> <span class=o>-&gt;</span> <span class=nb>bool</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.exists class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 22H2V2h2v20M22 7H6v3h16V7m-6 7H6v3h10v-3Z"/></svg></span> <strong>REQUIRED</strong> <span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 2h2v20h-2V2M2 10h16V7H2v3m6 7h10v-3H8v3Z"/></svg></span></p> <p>This should indicate whether or not the environment has already been created.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="567 "></span><span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="568 "></span><span class=k>def</span> <span class=nf>exists</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>bool</span><span class=p>:</span>
<span class=linenos data-linenos="569 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="570 "></span><span class=sd> :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:</span>
<span class=linenos data-linenos="571 "></span>
<span class=linenos data-linenos="572 "></span><span class=sd> This should indicate whether or not the environment has already been created.</span>
<span class=linenos data-linenos="573 "></span><span class=sd> &quot;&quot;&quot;</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.install_project class="doc doc-heading"> <code class="highlight language-python"><span class=n>install_project</span><span class=p>()</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.install_project class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 22H2V2h2v20M22 7H6v3h16V7m-6 7H6v3h10v-3Z"/></svg></span> <strong>REQUIRED</strong> <span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 2h2v20h-2V2M2 10h16V7H2v3m6 7h10v-3H8v3Z"/></svg></span></p> <p>This should install the project in the environment.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="575 "></span><span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="576 "></span><span class=k>def</span> <span class=nf>install_project</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="577 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="578 "></span><span class=sd> :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:</span>
<span class=linenos data-linenos="579 "></span>
<span class=linenos data-linenos="580 "></span><span class=sd> This should install the project in the environment.</span>
<span class=linenos data-linenos="581 "></span><span class=sd> &quot;&quot;&quot;</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.install_project_dev_mode class="doc doc-heading"> <code class="highlight language-python"><span class=n>install_project_dev_mode</span><span class=p>()</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.install_project_dev_mode class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 22H2V2h2v20M22 7H6v3h16V7m-6 7H6v3h10v-3Z"/></svg></span> <strong>REQUIRED</strong> <span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 2h2v20h-2V2M2 10h16V7H2v3m6 7h10v-3H8v3Z"/></svg></span></p> <p>This should install the project in the environment such that the environment always reflects the current state of the project.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="583 "></span><span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="584 "></span><span class=k>def</span> <span class=nf>install_project_dev_mode</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="585 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="586 "></span><span class=sd> :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:</span>
<span class=linenos data-linenos="587 "></span>
<span class=linenos data-linenos="588 "></span><span class=sd> This should install the project in the environment such that the environment</span>
<span class=linenos data-linenos="589 "></span><span class=sd> always reflects the current state of the project.</span>
<span class=linenos data-linenos="590 "></span><span class=sd> &quot;&quot;&quot;</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.dependencies_in_sync class="doc doc-heading"> <code class="highlight language-python"><span class=n>dependencies_in_sync</span><span class=p>()</span> <span class=o>-&gt;</span> <span class=nb>bool</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.dependencies_in_sync class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 22H2V2h2v20M22 7H6v3h16V7m-6 7H6v3h10v-3Z"/></svg></span> <strong>REQUIRED</strong> <span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 2h2v20h-2V2M2 10h16V7H2v3m6 7h10v-3H8v3Z"/></svg></span></p> <p>This should indicate whether or not the environment is compatible with the current <a href=./#hatch.env.plugin.interface.EnvironmentInterface.dependencies>dependencies</a>.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="592 "></span><span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="593 "></span><span class=k>def</span> <span class=nf>dependencies_in_sync</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>bool</span><span class=p>:</span>
<span class=linenos data-linenos="594 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="595 "></span><span class=sd> :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:</span>
<span class=linenos data-linenos="596 "></span>
<span class=linenos data-linenos="597 "></span><span class=sd> This should indicate whether or not the environment is compatible with the current</span>
<span class=linenos data-linenos="598 "></span><span class=sd> [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies).</span>
<span class=linenos data-linenos="599 "></span><span class=sd> &quot;&quot;&quot;</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.sync_dependencies class="doc doc-heading"> <code class="highlight language-python"><span class=n>sync_dependencies</span><span class=p>()</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-abstractmethod"><code>abstractmethod</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.sync_dependencies class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p><span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 22H2V2h2v20M22 7H6v3h16V7m-6 7H6v3h10v-3Z"/></svg></span> <strong>REQUIRED</strong> <span class=twemoji><svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 2h2v20h-2V2M2 10h16V7H2v3m6 7h10v-3H8v3Z"/></svg></span></p> <p>This should install the <a href=./#hatch.env.plugin.interface.EnvironmentInterface.dependencies>dependencies</a> in the environment.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="601 "></span><span class=nd>@abstractmethod</span>
<span class=linenos data-linenos="602 "></span><span class=k>def</span> <span class=nf>sync_dependencies</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="603 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="604 "></span><span class=sd> :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:</span>
<span class=linenos data-linenos="605 "></span>
<span class=linenos data-linenos="606 "></span><span class=sd> This should install the</span>
<span class=linenos data-linenos="607 "></span><span class=sd> [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies)</span>
<span class=linenos data-linenos="608 "></span><span class=sd> in the environment.</span>
<span class=linenos data-linenos="609 "></span><span class=sd> &quot;&quot;&quot;</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.dependency_hash class="doc doc-heading"> <code class="highlight language-python"><span class=n>dependency_hash</span><span class=p>()</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.dependency_hash class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>This should return a hash of the environment's <a href=./#hatch.env.plugin.interface.EnvironmentInterface.dependencies>dependencies</a> and any other data that is handled by the <a href=./#hatch.env.plugin.interface.EnvironmentInterface.sync_dependencies>sync_dependencies</a> and <a href=./#hatch.env.plugin.interface.EnvironmentInterface.dependencies_in_sync>dependencies_in_sync</a> methods.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="611 "></span><span class=k>def</span> <span class=nf>dependency_hash</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="612 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="613 "></span><span class=sd> This should return a hash of the environment&#39;s</span>
<span class=linenos data-linenos="614 "></span><span class=sd> [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies)</span>
<span class=linenos data-linenos="615 "></span><span class=sd> and any other data that is handled by the</span>
<span class=linenos data-linenos="616 "></span><span class=sd> [sync_dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.sync_dependencies)</span>
<span class=linenos data-linenos="617 "></span><span class=sd> and</span>
<span class=linenos data-linenos="618 "></span><span class=sd> [dependencies_in_sync](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies_in_sync)</span>
<span class=linenos data-linenos="619 "></span><span class=sd> methods.</span>
<span class=linenos data-linenos="620 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="621 "></span> <span class=kn>from</span> <span class=nn>hatch.utils.dep</span> <span class=kn>import</span> <span class=n>hash_dependencies</span>
<span class=linenos data-linenos="622 "></span>
<span class=linenos data-linenos="623 "></span> <span class=k>return</span> <span class=n>hash_dependencies</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>dependencies_complex</span><span class=p>)</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.fs_context class="doc doc-heading"> <code class="highlight language-python"><span class=n>fs_context</span><span class=p>()</span> <span class=o>-&gt;</span> <span class=n>Generator</span><span class=p>[</span><span class=n>FileSystemContext</span><span class=p>,</span> <span class=kc>None</span><span class=p>,</span> <span class=kc>None</span><span class=p>]</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.fs_context class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>A context manager that must yield a subclass of <a href=../../utilities/#hatch.env.plugin.interface.FileSystemContext>FileSystemContext</a>.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="690 "></span><span class=nd>@contextmanager</span>
<span class=linenos data-linenos="691 "></span><span class=k>def</span> <span class=nf>fs_context</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=n>Generator</span><span class=p>[</span><span class=n>FileSystemContext</span><span class=p>,</span> <span class=kc>None</span><span class=p>,</span> <span class=kc>None</span><span class=p>]:</span>
<span class=linenos data-linenos="692 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="693 "></span><span class=sd> A context manager that must yield a subclass of</span>
<span class=linenos data-linenos="694 "></span><span class=sd> [FileSystemContext](../utilities.md#hatch.env.plugin.interface.FileSystemContext).</span>
<span class=linenos data-linenos="695 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="696 "></span> <span class=kn>from</span> <span class=nn>hatch.utils.fs</span> <span class=kn>import</span> <span class=n>temp_directory</span>
<span class=linenos data-linenos="697 "></span>
<span class=linenos data-linenos="698 "></span> <span class=k>with</span> <span class=n>temp_directory</span><span class=p>()</span> <span class=k>as</span> <span class=n>temp_dir</span><span class=p>:</span>
<span class=linenos data-linenos="699 "></span> <span class=k>yield</span> <span class=n>FileSystemContext</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>local_path</span><span class=o>=</span><span class=n>temp_dir</span><span class=p>,</span> <span class=n>env_path</span><span class=o>=</span><span class=nb>str</span><span class=p>(</span><span class=n>temp_dir</span><span class=p>))</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.activate class="doc doc-heading"> <code class="highlight language-python"><span class=n>activate</span><span class=p>()</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.activate class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>A convenience method called when using the environment as a context manager:</p> <div class=highlight><pre><span></span><code><span class=k>with</span> <span class=n>environment</span><span class=p>:</span>
<span class=o>...</span>
</code></pre></div> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="519 "></span><span class=k>def</span> <span class=nf>activate</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="520 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="521 "></span><span class=sd> A convenience method called when using the environment as a context manager:</span>
<span class=linenos data-linenos="522 "></span>
<span class=linenos data-linenos="523 "></span><span class=sd> ```python</span>
<span class=linenos data-linenos="524 "></span><span class=sd> with environment:</span>
<span class=linenos data-linenos="525 "></span><span class=sd> ...</span>
<span class=linenos data-linenos="526 "></span><span class=sd> ```</span>
<span class=linenos data-linenos="527 "></span><span class=sd> &quot;&quot;&quot;</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.deactivate class="doc doc-heading"> <code class="highlight language-python"><span class=n>deactivate</span><span class=p>()</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.deactivate class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>A convenience method called after using the environment as a context manager:</p> <div class=highlight><pre><span></span><code><span class=k>with</span> <span class=n>environment</span><span class=p>:</span>
<span class=o>...</span>
</code></pre></div> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="529 "></span><span class=k>def</span> <span class=nf>deactivate</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="530 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="531 "></span><span class=sd> A convenience method called after using the environment as a context manager:</span>
<span class=linenos data-linenos="532 "></span>
<span class=linenos data-linenos="533 "></span><span class=sd> ```python</span>
<span class=linenos data-linenos="534 "></span><span class=sd> with environment:</span>
<span class=linenos data-linenos="535 "></span><span class=sd> ...</span>
<span class=linenos data-linenos="536 "></span><span class=sd> ```</span>
<span class=linenos data-linenos="537 "></span><span class=sd> &quot;&quot;&quot;</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.app_status_creation class="doc doc-heading"> <code class="highlight language-python"><span class=n>app_status_creation</span><span class=p>()</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_creation class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>See the <a href=./#life-cycle>life cycle of environments</a>.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="625 "></span><span class=nd>@contextmanager</span>
<span class=linenos data-linenos="626 "></span><span class=k>def</span> <span class=nf>app_status_creation</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="627 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="628 "></span><span class=sd> See the [life cycle of environments](reference.md#life-cycle).</span>
<span class=linenos data-linenos="629 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="630 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>status</span><span class=p>(</span><span class=sa>f</span><span class=s1>&#39;Creating environment: </span><span class=si>{</span><span class=bp>self</span><span class=o>.</span><span class=n>name</span><span class=si>}</span><span class=s1>&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="631 "></span> <span class=k>yield</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.app_status_pre_installation class="doc doc-heading"> <code class="highlight language-python"><span class=n>app_status_pre_installation</span><span class=p>()</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_pre_installation class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>See the <a href=./#life-cycle>life cycle of environments</a>.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="633 "></span><span class=nd>@contextmanager</span>
<span class=linenos data-linenos="634 "></span><span class=k>def</span> <span class=nf>app_status_pre_installation</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="635 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="636 "></span><span class=sd> See the [life cycle of environments](reference.md#life-cycle).</span>
<span class=linenos data-linenos="637 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="638 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>status</span><span class=p>(</span><span class=s1>&#39;Running pre-installation commands&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="639 "></span> <span class=k>yield</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.app_status_post_installation class="doc doc-heading"> <code class="highlight language-python"><span class=n>app_status_post_installation</span><span class=p>()</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_post_installation class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>See the <a href=./#life-cycle>life cycle of environments</a>.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="641 "></span><span class=nd>@contextmanager</span>
<span class=linenos data-linenos="642 "></span><span class=k>def</span> <span class=nf>app_status_post_installation</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="643 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="644 "></span><span class=sd> See the [life cycle of environments](reference.md#life-cycle).</span>
<span class=linenos data-linenos="645 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="646 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>status</span><span class=p>(</span><span class=s1>&#39;Running post-installation commands&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="647 "></span> <span class=k>yield</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.app_status_project_installation class="doc doc-heading"> <code class="highlight language-python"><span class=n>app_status_project_installation</span><span class=p>()</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_project_installation class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>See the <a href=./#life-cycle>life cycle of environments</a>.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="649 "></span><span class=nd>@contextmanager</span>
<span class=linenos data-linenos="650 "></span><span class=k>def</span> <span class=nf>app_status_project_installation</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="651 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="652 "></span><span class=sd> See the [life cycle of environments](reference.md#life-cycle).</span>
<span class=linenos data-linenos="653 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="654 "></span> <span class=k>if</span> <span class=bp>self</span><span class=o>.</span><span class=n>dev_mode</span><span class=p>:</span>
<span class=linenos data-linenos="655 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>status</span><span class=p>(</span><span class=s1>&#39;Installing project in development mode&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="656 "></span> <span class=k>yield</span>
<span class=linenos data-linenos="657 "></span> <span class=k>else</span><span class=p>:</span>
<span class=linenos data-linenos="658 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>status</span><span class=p>(</span><span class=s1>&#39;Installing project&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="659 "></span> <span class=k>yield</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_state_check class="doc doc-heading"> <code class="highlight language-python"><span class=n>app_status_dependency_state_check</span><span class=p>()</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_state_check class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>See the <a href=./#life-cycle>life cycle of environments</a>.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="661 "></span><span class=nd>@contextmanager</span>
<span class=linenos data-linenos="662 "></span><span class=k>def</span> <span class=nf>app_status_dependency_state_check</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="663 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="664 "></span><span class=sd> See the [life cycle of environments](reference.md#life-cycle).</span>
<span class=linenos data-linenos="665 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="666 "></span> <span class=k>if</span> <span class=ow>not</span> <span class=bp>self</span><span class=o>.</span><span class=n>skip_install</span> <span class=ow>and</span> <span class=p>(</span>
<span class=linenos data-linenos="667 "></span> <span class=s1>&#39;dependencies&#39;</span> <span class=ow>in</span> <span class=bp>self</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>dynamic</span> <span class=ow>or</span> <span class=s1>&#39;optional-dependencies&#39;</span> <span class=ow>in</span> <span class=bp>self</span><span class=o>.</span><span class=n>metadata</span><span class=o>.</span><span class=n>dynamic</span>
<span class=linenos data-linenos="668 "></span> <span class=p>):</span>
<span class=linenos data-linenos="669 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>status</span><span class=p>(</span><span class=s1>&#39;Polling dependency state&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="670 "></span> <span class=k>yield</span>
<span class=linenos data-linenos="671 "></span> <span class=k>else</span><span class=p>:</span>
<span class=linenos data-linenos="672 "></span> <span class=k>yield</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_installation_check class="doc doc-heading"> <code class="highlight language-python"><span class=n>app_status_dependency_installation_check</span><span class=p>()</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_installation_check class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>See the <a href=./#life-cycle>life cycle of environments</a>.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="674 "></span><span class=nd>@contextmanager</span>
<span class=linenos data-linenos="675 "></span><span class=k>def</span> <span class=nf>app_status_dependency_installation_check</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="676 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="677 "></span><span class=sd> See the [life cycle of environments](reference.md#life-cycle).</span>
<span class=linenos data-linenos="678 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="679 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>status</span><span class=p>(</span><span class=s1>&#39;Checking dependencies&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="680 "></span> <span class=k>yield</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_synchronization class="doc doc-heading"> <code class="highlight language-python"><span class=n>app_status_dependency_synchronization</span><span class=p>()</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_synchronization class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>See the <a href=./#life-cycle>life cycle of environments</a>.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="682 "></span><span class=nd>@contextmanager</span>
<span class=linenos data-linenos="683 "></span><span class=k>def</span> <span class=nf>app_status_dependency_synchronization</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="684 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="685 "></span><span class=sd> See the [life cycle of environments](reference.md#life-cycle).</span>
<span class=linenos data-linenos="686 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="687 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>app</span><span class=o>.</span><span class=n>status</span><span class=p>(</span><span class=s1>&#39;Syncing dependencies&#39;</span><span class=p>):</span>
<span class=linenos data-linenos="688 "></span> <span class=k>yield</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.command_context class="doc doc-heading"> <code class="highlight language-python"><span class=n>command_context</span><span class=p>()</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.command_context class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>A context manager that when active should make executed shell commands reflect any <a href=./#hatch.env.plugin.interface.EnvironmentInterface.get_env_vars>environment variables</a> the user defined either currently or at the time of <a href=./#hatch.env.plugin.interface.EnvironmentInterface.create>creation</a>.</p> <p>For an example, open the default implementation below:</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="728 "></span><span class=nd>@contextmanager</span>
<span class=linenos data-linenos="729 "></span><span class=k>def</span> <span class=nf>command_context</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="730 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="731 "></span><span class=sd> A context manager that when active should make executed shell commands reflect any</span>
<span class=linenos data-linenos="732 "></span><span class=sd> [environment variables](reference.md#hatch.env.plugin.interface.EnvironmentInterface.get_env_vars)</span>
<span class=linenos data-linenos="733 "></span><span class=sd> the user defined either currently or at the time of</span>
<span class=linenos data-linenos="734 "></span><span class=sd> [creation](reference.md#hatch.env.plugin.interface.EnvironmentInterface.create).</span>
<span class=linenos data-linenos="735 "></span>
<span class=linenos data-linenos="736 "></span><span class=sd> For an example, open the default implementation below:</span>
<span class=linenos data-linenos="737 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="738 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>get_env_vars</span><span class=p>():</span>
<span class=linenos data-linenos="739 "></span> <span class=k>yield</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.enter_shell class="doc doc-heading"> <code class="highlight language-python"><span class=n>enter_shell</span><span class=p>(</span><span class=n>name</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>path</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=n>args</span><span class=p>:</span> <span class=n>Iterable</span><span class=p>[</span><span class=nb>str</span><span class=p>])</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.enter_shell class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>Spawn a <a href=../../../config/hatch/#shell>shell</a> within the environment.</p> <p>This should either use <a href=./#hatch.env.plugin.interface.EnvironmentInterface.command_context>command_context</a> directly or provide the same guarantee.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="701 "></span><span class=k>def</span> <span class=nf>enter_shell</span><span class=p>(</span>
<span class=linenos data-linenos="702 "></span> <span class=bp>self</span><span class=p>,</span>
<span class=linenos data-linenos="703 "></span> <span class=n>name</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=c1># noqa: ARG002</span>
<span class=linenos data-linenos="704 "></span> <span class=n>path</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span>
<span class=linenos data-linenos="705 "></span> <span class=n>args</span><span class=p>:</span> <span class=n>Iterable</span><span class=p>[</span><span class=nb>str</span><span class=p>],</span>
<span class=linenos data-linenos="706 "></span><span class=p>):</span>
<span class=linenos data-linenos="707 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="708 "></span><span class=sd> Spawn a [shell](../../config/hatch.md#shell) within the environment.</span>
<span class=linenos data-linenos="709 "></span>
<span class=linenos data-linenos="710 "></span><span class=sd> This should either use</span>
<span class=linenos data-linenos="711 "></span><span class=sd> [command_context](reference.md#hatch.env.plugin.interface.EnvironmentInterface.command_context)</span>
<span class=linenos data-linenos="712 "></span><span class=sd> directly or provide the same guarantee.</span>
<span class=linenos data-linenos="713 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="714 "></span> <span class=k>with</span> <span class=bp>self</span><span class=o>.</span><span class=n>command_context</span><span class=p>():</span>
<span class=linenos data-linenos="715 "></span> <span class=bp>self</span><span class=o>.</span><span class=n>platform</span><span class=o>.</span><span class=n>exit_with_command</span><span class=p>([</span><span class=n>path</span><span class=p>,</span> <span class=o>*</span><span class=n>args</span><span class=p>])</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.run_shell_command class="doc doc-heading"> <code class="highlight language-python"><span class=n>run_shell_command</span><span class=p>(</span><span class=n>command</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>)</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.run_shell_command class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>This should return the standard library's <a href=https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess>subprocess.CompletedProcess</a> and will always be called when the <a href=./#hatch.env.plugin.interface.EnvironmentInterface.command_context>command_context</a> is active, with the expectation of providing the same guarantee.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="717 "></span><span class=k>def</span> <span class=nf>run_shell_command</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>command</span><span class=p>:</span> <span class=nb>str</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>):</span>
<span class=linenos data-linenos="718 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="719 "></span><span class=sd> This should return the standard library&#39;s</span>
<span class=linenos data-linenos="720 "></span><span class=sd> [subprocess.CompletedProcess](https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess)</span>
<span class=linenos data-linenos="721 "></span><span class=sd> and will always be called when the</span>
<span class=linenos data-linenos="722 "></span><span class=sd> [command_context](reference.md#hatch.env.plugin.interface.EnvironmentInterface.command_context)</span>
<span class=linenos data-linenos="723 "></span><span class=sd> is active, with the expectation of providing the same guarantee.</span>
<span class=linenos data-linenos="724 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="725 "></span> <span class=n>kwargs</span><span class=o>.</span><span class=n>setdefault</span><span class=p>(</span><span class=s1>&#39;shell&#39;</span><span class=p>,</span> <span class=kc>True</span><span class=p>)</span>
<span class=linenos data-linenos="726 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>platform</span><span class=o>.</span><span class=n>run_command</span><span class=p>(</span><span class=n>command</span><span class=p>,</span> <span class=o>**</span><span class=n>kwargs</span><span class=p>)</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.resolve_commands class="doc doc-heading"> <code class="highlight language-python"><span class=n>resolve_commands</span><span class=p>(</span><span class=n>commands</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>])</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.resolve_commands class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>This expands each command into one or more commands based on any <a href=../../../config/environment/overview/#scripts>scripts</a> that the user defined.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="741 "></span><span class=k>def</span> <span class=nf>resolve_commands</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>commands</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]):</span>
<span class=linenos data-linenos="742 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="743 "></span><span class=sd> This expands each command into one or more commands based on any</span>
<span class=linenos data-linenos="744 "></span><span class=sd> [scripts](../../config/environment/overview.md#scripts) that the user defined.</span>
<span class=linenos data-linenos="745 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="746 "></span> <span class=k>for</span> <span class=n>command</span> <span class=ow>in</span> <span class=n>commands</span><span class=p>:</span>
<span class=linenos data-linenos="747 "></span> <span class=k>yield from</span> <span class=bp>self</span><span class=o>.</span><span class=n>expand_command</span><span class=p>(</span><span class=n>command</span><span class=p>)</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.get_env_vars class="doc doc-heading"> <code class="highlight language-python"><span class=n>get_env_vars</span><span class=p>()</span> <span class=o>-&gt;</span> <span class=n>EnvVars</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.get_env_vars class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>Returns a mapping of environment variables that should be available to the environment. The object can be used as a context manager to temporarily apply the environment variables to the current process.</p> <div class="admonition note"> <p class=admonition-title>Note</p> <p>The environment variable <code>HATCH_ENV_ACTIVE</code> will always be set to the name of the environment.</p> </div> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="810 "></span><span class=k>def</span> <span class=nf>get_env_vars</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=n>EnvVars</span><span class=p>:</span>
<span class=linenos data-linenos="811 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="812 "></span><span class=sd> Returns a mapping of environment variables that should be available to the environment. The object can</span>
<span class=linenos data-linenos="813 "></span><span class=sd> be used as a context manager to temporarily apply the environment variables to the current process.</span>
<span class=linenos data-linenos="814 "></span>
<span class=linenos data-linenos="815 "></span><span class=sd> !!! note</span>
<span class=linenos data-linenos="816 "></span><span class=sd> The environment variable `HATCH_ENV_ACTIVE` will always be set to the name of the environment.</span>
<span class=linenos data-linenos="817 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="818 "></span> <span class=k>return</span> <span class=n>EnvVars</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>env_vars</span><span class=p>,</span> <span class=bp>self</span><span class=o>.</span><span class=n>env_include</span><span class=p>,</span> <span class=bp>self</span><span class=o>.</span><span class=n>env_exclude</span><span class=p>)</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.apply_features class="doc doc-heading"> <code class="highlight language-python"><span class=n>apply_features</span><span class=p>(</span><span class=n>requirement</span><span class=p>:</span> <span class=nb>str</span><span class=p>)</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.apply_features class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>A convenience method that applies any user defined <a href=../../../config/environment/overview/#features>features</a> to the given requirement.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="786 "></span><span class=k>def</span> <span class=nf>apply_features</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>requirement</span><span class=p>:</span> <span class=nb>str</span><span class=p>):</span>
<span class=linenos data-linenos="787 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="788 "></span><span class=sd> A convenience method that applies any user defined [features](../../config/environment/overview.md#features)</span>
<span class=linenos data-linenos="789 "></span><span class=sd> to the given requirement.</span>
<span class=linenos data-linenos="790 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="791 "></span> <span class=k>if</span> <span class=bp>self</span><span class=o>.</span><span class=n>features</span><span class=p>:</span>
<span class=linenos data-linenos="792 "></span> <span class=n>features</span> <span class=o>=</span> <span class=s1>&#39;,&#39;</span><span class=o>.</span><span class=n>join</span><span class=p>(</span><span class=bp>self</span><span class=o>.</span><span class=n>features</span><span class=p>)</span>
<span class=linenos data-linenos="793 "></span> <span class=k>return</span> <span class=sa>f</span><span class=s1>&#39;</span><span class=si>{</span><span class=n>requirement</span><span class=si>}</span><span class=s1>[</span><span class=si>{</span><span class=n>features</span><span class=si>}</span><span class=s1>]&#39;</span>
<span class=linenos data-linenos="794 "></span>
<span class=linenos data-linenos="795 "></span> <span class=k>return</span> <span class=n>requirement</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.construct_pip_install_command class="doc doc-heading"> <code class="highlight language-python"><span class=n>construct_pip_install_command</span><span class=p>(</span><span class=n>args</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>])</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.construct_pip_install_command class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>A convenience method for constructing a <a href=https://pip.pypa.io/en/stable/cli/pip_install/ ><code>pip install</code></a> command with the given verbosity. The default verbosity is set to one less than Hatch's verbosity.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="766 "></span><span class=k>def</span> <span class=nf>construct_pip_install_command</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>args</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]):</span>
<span class=linenos data-linenos="767 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="768 "></span><span class=sd> A convenience method for constructing a [`pip install`](https://pip.pypa.io/en/stable/cli/pip_install/)</span>
<span class=linenos data-linenos="769 "></span><span class=sd> command with the given verbosity. The default verbosity is set to one less than Hatch&#39;s verbosity.</span>
<span class=linenos data-linenos="770 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="771 "></span> <span class=n>command</span> <span class=o>=</span> <span class=p>[</span><span class=s1>&#39;python&#39;</span><span class=p>,</span> <span class=s1>&#39;-u&#39;</span><span class=p>,</span> <span class=s1>&#39;-m&#39;</span><span class=p>,</span> <span class=s1>&#39;pip&#39;</span><span class=p>,</span> <span class=s1>&#39;install&#39;</span><span class=p>,</span> <span class=s1>&#39;--disable-pip-version-check&#39;</span><span class=p>,</span> <span class=s1>&#39;--no-python-version-warning&#39;</span><span class=p>]</span>
<span class=linenos data-linenos="772 "></span>
<span class=linenos data-linenos="773 "></span> <span class=c1># Default to -1 verbosity</span>
<span class=linenos data-linenos="774 "></span> <span class=n>add_verbosity_flag</span><span class=p>(</span><span class=n>command</span><span class=p>,</span> <span class=bp>self</span><span class=o>.</span><span class=n>verbosity</span><span class=p>,</span> <span class=n>adjustment</span><span class=o>=-</span><span class=mi>1</span><span class=p>)</span>
<span class=linenos data-linenos="775 "></span>
<span class=linenos data-linenos="776 "></span> <span class=n>command</span><span class=o>.</span><span class=n>extend</span><span class=p>(</span><span class=n>args</span><span class=p>)</span>
<span class=linenos data-linenos="777 "></span> <span class=k>return</span> <span class=n>command</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.join_command_args class="doc doc-heading"> <code class="highlight language-python"><span class=n>join_command_args</span><span class=p>(</span><span class=n>args</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>])</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.join_command_args class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>This is used by the <a href=../../../cli/reference/#hatch-run><code>run</code></a> command to construct the root command string from the received arguments.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="779 "></span><span class=k>def</span> <span class=nf>join_command_args</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>args</span><span class=p>:</span> <span class=nb>list</span><span class=p>[</span><span class=nb>str</span><span class=p>]):</span>
<span class=linenos data-linenos="780 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="781 "></span><span class=sd> This is used by the [`run`](../../cli/reference.md#hatch-run) command to construct the root command string</span>
<span class=linenos data-linenos="782 "></span><span class=sd> from the received arguments.</span>
<span class=linenos data-linenos="783 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="784 "></span> <span class=k>return</span> <span class=bp>self</span><span class=o>.</span><span class=n>platform</span><span class=o>.</span><span class=n>join_command_args</span><span class=p>(</span><span class=n>args</span><span class=p>)</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.check_compatibility class="doc doc-heading"> <code class="highlight language-python"><span class=n>check_compatibility</span><span class=p>()</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.check_compatibility class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>This raises an exception if the environment is not compatible with the user's setup. The default behavior checks for <a href=../../../config/environment/overview/#supported-platforms>platform compatibility</a> and any method override should keep this check.</p> <p>This check is never performed if the environment has been <a href=./#hatch.env.plugin.interface.EnvironmentInterface.create>created</a>.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="797 "></span><span class=k>def</span> <span class=nf>check_compatibility</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="798 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="799 "></span><span class=sd> This raises an exception if the environment is not compatible with the user&#39;s setup. The default behavior</span>
<span class=linenos data-linenos="800 "></span><span class=sd> checks for [platform compatibility](../../config/environment/overview.md#supported-platforms)</span>
<span class=linenos data-linenos="801 "></span><span class=sd> and any method override should keep this check.</span>
<span class=linenos data-linenos="802 "></span>
<span class=linenos data-linenos="803 "></span><span class=sd> This check is never performed if the environment has been</span>
<span class=linenos data-linenos="804 "></span><span class=sd> [created](reference.md#hatch.env.plugin.interface.EnvironmentInterface.create).</span>
<span class=linenos data-linenos="805 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="806 "></span> <span class=k>if</span> <span class=bp>self</span><span class=o>.</span><span class=n>platforms</span> <span class=ow>and</span> <span class=bp>self</span><span class=o>.</span><span class=n>platform</span><span class=o>.</span><span class=n>name</span> <span class=ow>not</span> <span class=ow>in</span> <span class=bp>self</span><span class=o>.</span><span class=n>platforms</span><span class=p>:</span>
<span class=linenos data-linenos="807 "></span> <span class=n>message</span> <span class=o>=</span> <span class=s1>&#39;unsupported platform&#39;</span>
<span class=linenos data-linenos="808 "></span> <span class=k>raise</span> <span class=ne>OSError</span><span class=p>(</span><span class=n>message</span><span class=p>)</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.get_option_types class="doc doc-heading"> <code class="highlight language-python"><span class=n>get_option_types</span><span class=p>()</span> <span class=o>-&gt;</span> <span class=nb>dict</span></code> <span class="doc doc-labels"> <small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small> </span> <a href=#hatch.env.plugin.interface.EnvironmentInterface.get_option_types class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>Returns a mapping of supported options to their respective types so that they can be used by <a href=../../../config/environment/advanced/#option-overrides>overrides</a>.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="835 "></span><span class=nd>@staticmethod</span>
<span class=linenos data-linenos="836 "></span><span class=k>def</span> <span class=nf>get_option_types</span><span class=p>()</span> <span class=o>-&gt;</span> <span class=nb>dict</span><span class=p>:</span>
<span class=linenos data-linenos="837 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="838 "></span><span class=sd> Returns a mapping of supported options to their respective types so that they can be used by</span>
<span class=linenos data-linenos="839 "></span><span class=sd> [overrides](../../config/environment/advanced.md#option-overrides).</span>
<span class=linenos data-linenos="840 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="841 "></span> <span class=k>return</span> <span class=p>{}</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.get_env_var_option class="doc doc-heading"> <code class="highlight language-python"><span class=n>get_env_var_option</span><span class=p>(</span><span class=n>option</span><span class=p>:</span> <span class=nb>str</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>str</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.get_env_var_option class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>Returns the value of the upper-cased environment variable <code>HATCH_ENV_TYPE_&lt;PLUGIN_NAME&gt;_&lt;option&gt;</code>.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="820 "></span><span class=k>def</span> <span class=nf>get_env_var_option</span><span class=p>(</span><span class=bp>self</span><span class=p>,</span> <span class=n>option</span><span class=p>:</span> <span class=nb>str</span><span class=p>)</span> <span class=o>-&gt;</span> <span class=nb>str</span><span class=p>:</span>
<span class=linenos data-linenos="821 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="822 "></span><span class=sd> Returns the value of the upper-cased environment variable `HATCH_ENV_TYPE_&lt;PLUGIN_NAME&gt;_&lt;option&gt;`.</span>
<span class=linenos data-linenos="823 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="824 "></span> <span class=k>return</span> <span class=n>get_env_var_option</span><span class=p>(</span><span class=n>plugin_name</span><span class=o>=</span><span class=bp>self</span><span class=o>.</span><span class=n>PLUGIN_NAME</span><span class=p>,</span> <span class=n>option</span><span class=o>=</span><span class=n>option</span><span class=p>)</span>
</code></pre></div> </details> </div> </div> <div class="doc doc-object doc-function"> <h3 id=hatch.env.plugin.interface.EnvironmentInterface.get_context class="doc doc-heading"> <code class="highlight language-python"><span class=n>get_context</span><span class=p>()</span></code> <a href=#hatch.env.plugin.interface.EnvironmentInterface.get_context class=headerlink title="Permanent link">&para;</a></h3> <div class="doc doc-contents "> <p>Returns a subclass of <a href=../../utilities/#hatch.env.context.EnvironmentContextFormatter>EnvironmentContextFormatter</a>.</p> <details class=quote> <summary>Source code in <code>src/hatch/env/plugin/interface.py</code></summary> <div class=highlight><pre><span></span><code><span class=linenos data-linenos="826 "></span><span class=k>def</span> <span class=nf>get_context</span><span class=p>(</span><span class=bp>self</span><span class=p>):</span>
<span class=linenos data-linenos="827 "></span><span class=w> </span><span class=sd>&quot;&quot;&quot;</span>
<span class=linenos data-linenos="828 "></span><span class=sd> Returns a subclass of</span>
<span class=linenos data-linenos="829 "></span><span class=sd> [EnvironmentContextFormatter](../utilities.md#hatch.env.context.EnvironmentContextFormatter).</span>
<span class=linenos data-linenos="830 "></span><span class=sd> &quot;&quot;&quot;</span>
<span class=linenos data-linenos="831 "></span> <span class=kn>from</span> <span class=nn>hatch.env.context</span> <span class=kn>import</span> <span class=n>EnvironmentContextFormatter</span>
<span class=linenos data-linenos="832 "></span>
<span class=linenos data-linenos="833 "></span> <span class=k>return</span> <span class=n>EnvironmentContextFormatter</span><span class=p>(</span><span class=bp>self</span><span class=p>)</span>
</code></pre></div> </details> </div> </div> </div> </div> </div> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 7, 2024</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Contributors> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg> </span> <span>GitHub</span> <nav> <a href=https://github.com/ofek class=md-author title=@ofek> <img src="https://avatars.githubusercontent.com/u/9677399?v=4&size=72" alt=ofek> </a> <a href=https://github.com/oprypin class=md-author title=@oprypin> <img src="https://avatars.githubusercontent.com/u/371383?v=4&size=72" alt=oprypin> </a> </nav> </span> </aside> </article> </div> <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../../metadata-hook/custom/ class="md-footer__link md-footer__link--prev" aria-label="Previous: Custom"> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </div> <div class=md-footer__title> <span class=md-footer__direction> Previous </span> <div class=md-ellipsis> Custom </div> </div> </a> <a href=../virtual/ class="md-footer__link md-footer__link--next" aria-label="Next: Virtual"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> Virtual </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> Copyright &copy; Ofek Lev 2017-present </div> <div> Logo by <a href=https://openai.com/dall-e-2/ target=_blank rel=noopener> DALL·E </a> and <a href=https://boriscrowther.com/ target=_blank rel=noopener> Boris Crowther </a> </div> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> <div class=md-social> <a href=https://github.com/ofek target=_blank rel=noopener title=github.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 480 512"><!-- Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg> </a> <a href=https://ofek.dev/words/ target=_blank rel=noopener title=ofek.dev class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M192 32c0 17.7 14.3 32 32 32 123.7 0 224 100.3 224 224 0 17.7 14.3 32 32 32s32-14.3 32-32C512 128.9 383.1 0 224 0c-17.7 0-32 14.3-32 32zm0 96c0 17.7 14.3 32 32 32 70.7 0 128 57.3 128 128 0 17.7 14.3 32 32 32s32-14.3 32-32c0-106-86-192-192-192-17.7 0-32 14.3-32 32zm-96 16c0-26.5-21.5-48-48-48S0 117.5 0 144v224c0 79.5 64.5 144 144 144s144-64.5 144-144-64.5-144-144-144h-16v96h16c26.5 0 48 21.5 48 48s-21.5 48-48 48-48-21.5-48-48V144z"/></svg> </a> <a href=https://twitter.com/Ofekmeister target=_blank rel=noopener title=twitter.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg> </a> <a href=https://www.linkedin.com/in/ofeklev/ target=_blank rel=noopener title=www.linkedin.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3zM135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5zm282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9V416z"/></svg> </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../../..", "features": ["content.action.edit", "content.code.copy", "content.tabs.link", "content.tooltips", "navigation.expand", "navigation.footer", "navigation.instant", "navigation.sections", "navigation.tabs", "navigation.tabs.sticky"], "search": "../../../assets/javascripts/workers/search.1e90e0fb.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script> <script src=../../../assets/javascripts/bundle.e3055991.min.js></script> <script id=init-glightbox>const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});
document$.subscribe(() => { lightbox.reload() });
</script></body> </html>