mirror of https://github.com/pypa/hatch.git
237 lines
133 KiB
HTML
237 lines
133 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.7/config/environment/advanced/ rel=canonical><link href=../overview/ rel=prev><link href=../../static-analysis/ rel=next><link rel=icon href=../../../assets/images/logo.svg><meta name=generator content="mkdocs-1.5.3, mkdocs-material-9.5.1+insiders-4.47.0"><title>Advanced - Hatch</title><link rel=stylesheet href=../../../assets/stylesheets/main.08b157ab.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="Advanced - Hatch"><meta property=og:description content="Modern, extensible Python project management"><meta property=og:image content=https://hatch.pypa.io/1.7/assets/images/social/config/environment/advanced.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.7/config/environment/advanced/ property=og:url><meta property=twitter:card content=summary_large_image><meta property=twitter:title content="Advanced - Hatch"><meta property=twitter:description content="Modern, extensible Python project management"><meta property=twitter:image content=https://hatch.pypa.io/1.7/assets/images/social/config/environment/advanced.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=#advanced-environment-configuration 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> Advanced </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.4.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 2023 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 md-tabs__item--active"> <a href=../../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> <a href=../../../plugins/about/ class=md-tabs__link> Plugins </a> </li> <li class=md-tabs__item> <a href=../../../how-to/environment/package-indices/ class=md-tabs__link> How-to </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.4.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 2023 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--section 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> <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--section 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> <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--section 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> <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--section 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> <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--section 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> <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--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_2 checked> <label class=md-nav__link for=__nav_2 id=__nav_2_label tabindex> <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=true> <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=../../metadata/ class=md-nav__link> <span class=md-ellipsis> Metadata </span> </a> </li> <li class=md-nav__item> <a href=../../dependency/ class=md-nav__link> <span class=md-ellipsis> Dependencies </span> </a> </li> <li class=md-nav__item> <a href=../../build/ class=md-nav__link> <span class=md-ellipsis> Build </span> </a> </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_2_4 checked> <label class=md-nav__link for=__nav_2_4 id=__nav_2_4_label tabindex> <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=true> <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=../overview/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> <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> Advanced </span> <span class="md-nav__icon md-icon"></span> </label> <a href=./ class="md-nav__link md-nav__link--active"> <span class=md-ellipsis> Advanced </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=#context-formatting class=md-nav__link> <span class=md-ellipsis> Context formatting </span> </a> </li> <li class=md-nav__item> <a href=#matrix class=md-nav__link> <span class=md-ellipsis> Matrix </span> </a> <nav class=md-nav aria-label=Matrix> <ul class=md-nav__list> <li class=md-nav__item> <a href=#naming class=md-nav__link> <span class=md-ellipsis> Naming </span> </a> <nav class=md-nav aria-label=Naming> <ul class=md-nav__list> <li class=md-nav__item> <a href=#python-variables class=md-nav__link> <span class=md-ellipsis> Python variables </span> </a> </li> <li class=md-nav__item> <a href=#name-formatting class=md-nav__link> <span class=md-ellipsis> Name formatting </span> </a> </li> <li class=md-nav__item> <a href=#default-environment class=md-nav__link> <span class=md-ellipsis> Default environment </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#selection class=md-nav__link> <span class=md-ellipsis> Selection </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#option-overrides class=md-nav__link> <span class=md-ellipsis> Option overrides </span> </a> <nav class=md-nav aria-label="Option overrides"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#platform-overrides class=md-nav__link> <span class=md-ellipsis> Platform overrides </span> </a> </li> <li class=md-nav__item> <a href=#environment-variable-overrides class=md-nav__link> <span class=md-ellipsis> Environment variable overrides </span> </a> </li> <li class=md-nav__item> <a href=#matrix-variable-overrides class=md-nav__link> <span class=md-ellipsis> Matrix variable overrides </span> </a> </li> <li class=md-nav__item> <a href=#name-overrides class=md-nav__link> <span class=md-ellipsis> Name overrides </span> </a> </li> <li class=md-nav__item> <a href=#types class=md-nav__link> <span class=md-ellipsis> Types </span> </a> </li> <li class=md-nav__item> <a href=#overwriting class=md-nav__link> <span class=md-ellipsis> Overwriting </span> </a> </li> <li class=md-nav__item> <a href=#conditions class=md-nav__link> <span class=md-ellipsis> Conditions </span> </a> <nav class=md-nav aria-label=Conditions> <ul class=md-nav__list> <li class=md-nav__item> <a href=#allowed-values class=md-nav__link> <span class=md-ellipsis> Allowed values </span> </a> </li> <li class=md-nav__item> <a href=#specific-platforms class=md-nav__link> <span class=md-ellipsis> Specific platforms </span> </a> </li> <li class=md-nav__item> <a href=#required-environment-variables class=md-nav__link> <span class=md-ellipsis> Required environment variables </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../static-analysis/ class=md-nav__link> <span class=md-ellipsis> Static analysis </span> </a> </li> <li class=md-nav__item> <a href=../../context/ class=md-nav__link> <span class=md-ellipsis> Context formatting </span> </a> </li> <li class=md-nav__item> <a href=../../project-templates/ class=md-nav__link> <span class=md-ellipsis> Project templates </span> </a> </li> <li class=md-nav__item> <a href=../../hatch/ class=md-nav__link> <span class=md-ellipsis> Hatch </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_3> <label class=md-nav__link for=__nav_3 id=__nav_3_label tabindex> <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--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4> <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=false> <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=../../../plugins/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=../../../plugins/builder/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../../plugins/builder/wheel/ class=md-nav__link> <span class=md-ellipsis> Wheel </span> </a> </li> <li class=md-nav__item> <a href=../../../plugins/builder/sdist/ class=md-nav__link> <span class=md-ellipsis> Source distribution </span> </a> </li> <li class=md-nav__item> <a href=../../../plugins/builder/app/ class=md-nav__link> <span class=md-ellipsis> Application </span> </a> </li> <li class=md-nav__item> <a href=../../../plugins/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=../../../plugins/build-hook/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../../plugins/build-hook/version/ class=md-nav__link> <span class=md-ellipsis> Version </span> </a> </li> <li class=md-nav__item> <a href=../../../plugins/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=../../../plugins/metadata-hook/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../../plugins/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--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_5> <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=false> <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> <a href=../../../plugins/environment/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../../plugins/environment/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=../../../plugins/environment-collector/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../../plugins/environment-collector/custom/ class=md-nav__link> <span class=md-ellipsis> Custom </span> </a> </li> <li class=md-nav__item> <a href=../../../plugins/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=../../../plugins/publisher/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../../plugins/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=../../../plugins/version-source/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../../plugins/version-source/regex/ class=md-nav__link> <span class=md-ellipsis> Regex </span> </a> </li> <li class=md-nav__item> <a href=../../../plugins/version-source/code/ class=md-nav__link> <span class=md-ellipsis> Code </span> </a> </li> <li class=md-nav__item> <a href=../../../plugins/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=../../../plugins/version-scheme/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../../plugins/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=../../../plugins/utilities/ class=md-nav__link> <span class=md-ellipsis> Utilities </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_5> <label class=md-nav__link for=__nav_5 id=__nav_5_label tabindex> <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--section 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> <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_1_label aria-expanded=false> <label class=md-nav__title for=__nav_5_1> <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/package-indices/ class=md-nav__link> <span class=md-ellipsis> Package indices </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_5_2> <label class=md-nav__link for=__nav_5_2 id=__nav_5_2_label tabindex> <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_2_label aria-expanded=false> <label class=md-nav__title for=__nav_5_2> <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--section 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> <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_6_label aria-expanded=false> <label class=md-nav__title for=__nav_6> <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--section 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> <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_7_label aria-expanded=false> <label class=md-nav__title for=__nav_7> <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--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_7_2> <label class=md-nav__link for=__nav_7_2 id=__nav_7_2_label tabindex> <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_7_2_label aria-expanded=false> <label class=md-nav__title for=__nav_7_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/2022/ class=md-nav__link> <span class=md-ellipsis> 2022 </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_7_3> <label class=md-nav__link for=__nav_7_3 id=__nav_7_3_label tabindex> <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_7_3_label aria-expanded=false> <label class=md-nav__title for=__nav_7_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=#context-formatting class=md-nav__link> <span class=md-ellipsis> Context formatting </span> </a> </li> <li class=md-nav__item> <a href=#matrix class=md-nav__link> <span class=md-ellipsis> Matrix </span> </a> <nav class=md-nav aria-label=Matrix> <ul class=md-nav__list> <li class=md-nav__item> <a href=#naming class=md-nav__link> <span class=md-ellipsis> Naming </span> </a> <nav class=md-nav aria-label=Naming> <ul class=md-nav__list> <li class=md-nav__item> <a href=#python-variables class=md-nav__link> <span class=md-ellipsis> Python variables </span> </a> </li> <li class=md-nav__item> <a href=#name-formatting class=md-nav__link> <span class=md-ellipsis> Name formatting </span> </a> </li> <li class=md-nav__item> <a href=#default-environment class=md-nav__link> <span class=md-ellipsis> Default environment </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#selection class=md-nav__link> <span class=md-ellipsis> Selection </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=#option-overrides class=md-nav__link> <span class=md-ellipsis> Option overrides </span> </a> <nav class=md-nav aria-label="Option overrides"> <ul class=md-nav__list> <li class=md-nav__item> <a href=#platform-overrides class=md-nav__link> <span class=md-ellipsis> Platform overrides </span> </a> </li> <li class=md-nav__item> <a href=#environment-variable-overrides class=md-nav__link> <span class=md-ellipsis> Environment variable overrides </span> </a> </li> <li class=md-nav__item> <a href=#matrix-variable-overrides class=md-nav__link> <span class=md-ellipsis> Matrix variable overrides </span> </a> </li> <li class=md-nav__item> <a href=#name-overrides class=md-nav__link> <span class=md-ellipsis> Name overrides </span> </a> </li> <li class=md-nav__item> <a href=#types class=md-nav__link> <span class=md-ellipsis> Types </span> </a> </li> <li class=md-nav__item> <a href=#overwriting class=md-nav__link> <span class=md-ellipsis> Overwriting </span> </a> </li> <li class=md-nav__item> <a href=#conditions class=md-nav__link> <span class=md-ellipsis> Conditions </span> </a> <nav class=md-nav aria-label=Conditions> <ul class=md-nav__list> <li class=md-nav__item> <a href=#allowed-values class=md-nav__link> <span class=md-ellipsis> Allowed values </span> </a> </li> <li class=md-nav__item> <a href=#specific-platforms class=md-nav__link> <span class=md-ellipsis> Specific platforms </span> </a> </li> <li class=md-nav__item> <a href=#required-environment-variables class=md-nav__link> <span class=md-ellipsis> Required environment variables </span> </a> </li> </ul> </nav> </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/config/environment/advanced.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=advanced-environment-configuration>Advanced environment configuration<a class=headerlink href=#advanced-environment-configuration title="Permanent link">¶</a></h1> <hr> <h2 id=context-formatting>Context formatting<a class=headerlink href=#context-formatting title="Permanent link">¶</a></h2> <p>All environments support the following extra <a href=../../context/ >context formatting</a> fields:</p> <table> <thead> <tr> <th>Field</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>env_name</code></td> <td>The name of the environment</td> </tr> <tr> <td><code>env_type</code></td> <td>The <a href=../overview/#type>type</a> of environment</td> </tr> <tr> <td><code>matrix</code></td> <td>Its modifier selects the value of that matrix variable. If the environment is not part of a matrix or was not generated with the variable, you must specify a default value as an additional modifier e.g. <code>{matrix:version:v1.0.0}</code>.</td> </tr> <tr> <td><code>verbosity</code></td> <td>The integer verbosity value of Hatch. A <code>flag</code> modifier is supported that will render the value as a CLI flag e.g. <code>-2</code> becomes <code>-qq</code>, <code>1</code> becomes <code>-v</code>, and <code>0</code> becomes an empty string. An additional flag integer modifier may be used to adjust the verbosity level. For example, if you wanted to make a command quiet by default, you could use <code>{verbosity:flag:-1}</code> within the command.</td> </tr> <tr> <td><code>args</code></td> <td>For <a href=../../../environment/#command-execution>executed commands</a> only, any extra command line arguments with an optional default modifier if none were provided</td> </tr> </tbody> </table> <h2 id=matrix>Matrix<a class=headerlink href=#matrix title="Permanent link">¶</a></h2> <p>Environments can define a series of matrices with the <code>matrix</code> option:</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.envs.test]</span>
|
|
<span class=n>dependencies</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=s2>"pytest"</span>
|
|
<span class=p>]</span>
|
|
|
|
<span class=k>[[tool.hatch.envs.test.matrix]]</span>
|
|
<span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"2.7"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.8"</span><span class=p>]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.14"</span><span class=p>]</span>
|
|
|
|
<span class=k>[[tool.hatch.envs.test.matrix]]</span>
|
|
<span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.8"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.9"</span><span class=p>]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"9000"</span><span class=p>]</span>
|
|
<span class=n>feature</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"foo"</span><span class=p>,</span><span class=w> </span><span class=s2>"bar"</span><span class=p>]</span>
|
|
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.test]</span>
|
|
<span class=n>dependencies</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=s2>"pytest"</span>
|
|
<span class=p>]</span>
|
|
|
|
<span class=k>[[envs.test.matrix]]</span>
|
|
<span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"2.7"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.8"</span><span class=p>]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.14"</span><span class=p>]</span>
|
|
|
|
<span class=k>[[envs.test.matrix]]</span>
|
|
<span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.8"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.9"</span><span class=p>]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"9000"</span><span class=p>]</span>
|
|
<span class=n>feature</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"foo"</span><span class=p>,</span><span class=w> </span><span class=s2>"bar"</span><span class=p>]</span>
|
|
</code></pre></div> </div> </div> </div> <p>Doing so will result in the product of each variable combination being its own environment.</p> <h3 id=naming>Naming<a class=headerlink href=#naming title="Permanent link">¶</a></h3> <p>The name of the generated environments will be the variable values of each combination separated by hyphens, altogether prefixed by <code><ENV_NAME>.</code>. For example, the following configuration:</p> <div class="tabbed-set tabbed-alternate" data-tabs=2:2><input checked=checked id=pyprojecttoml_1 name=__tabbed_2 type=radio><input id=hatchtoml_1 name=__tabbed_2 type=radio><div class=tabbed-labels><label for=pyprojecttoml_1><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_1><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.test.matrix]]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>]</span>
|
|
<span class=n>feature</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"foo"</span><span class=p>,</span><span class=w> </span><span class=s2>"bar"</span><span class=p>]</span>
|
|
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[[envs.test.matrix]]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>]</span>
|
|
<span class=n>feature</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"foo"</span><span class=p>,</span><span class=w> </span><span class=s2>"bar"</span><span class=p>]</span>
|
|
</code></pre></div> </div> </div> </div> <p>would indicate the following unique environments:</p> <div class=highlight><pre><span></span><code>test.42-foo
|
|
test.42-bar
|
|
</code></pre></div> <p>The exceptions to this format are described below.</p> <h4 id=python-variables>Python variables<a class=headerlink href=#python-variables title="Permanent link">¶</a></h4> <p>If the variables <code>py</code> or <code>python</code> are specified, then they will rank first in the product result and will be prefixed by <code>py</code> if the value is not. For example, the following configuration:</p> <div class="tabbed-set tabbed-alternate" data-tabs=3:2><input checked=checked id=pyprojecttoml_2 name=__tabbed_3 type=radio><input id=hatchtoml_2 name=__tabbed_3 type=radio><div class=tabbed-labels><label for=pyprojecttoml_2><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_2><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.test.matrix]]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>]</span>
|
|
<span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.9"</span><span class=p>,</span><span class=w> </span><span class=s2>"pypy3"</span><span class=p>]</span>
|
|
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[[envs.test.matrix]]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>]</span>
|
|
<span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.9"</span><span class=p>,</span><span class=w> </span><span class=s2>"pypy3"</span><span class=p>]</span>
|
|
</code></pre></div> </div> </div> </div> <p>would generate the following environments:</p> <div class=highlight><pre><span></span><code>test.py3.9-42
|
|
test.pypy3-42
|
|
</code></pre></div> <div class="admonition note"> <p class=admonition-title>Note</p> <p>The value of this variable sets the <a href=../overview/#python-version>Python version</a>.</p> </div> <h4 id=name-formatting>Name formatting<a class=headerlink href=#name-formatting title="Permanent link">¶</a></h4> <p>You can set the <code>matrix-name-format</code> option to modify how each variable part is formatted which recognizes the placeholders <code>{variable}</code> and <code>{value}</code>. For example, the following configuration:</p> <div class="tabbed-set tabbed-alternate" data-tabs=4:2><input checked=checked id=pyprojecttoml_3 name=__tabbed_4 type=radio><input id=hatchtoml_3 name=__tabbed_4 type=radio><div class=tabbed-labels><label for=pyprojecttoml_3><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_3><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.test]</span>
|
|
<span class=n>matrix-name-format</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s2>"{variable}_{value}"</span>
|
|
|
|
<span class=k>[[tool.hatch.envs.test.matrix]]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>]</span>
|
|
<span class=n>feature</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"foo"</span><span class=p>,</span><span class=w> </span><span class=s2>"bar"</span><span class=p>]</span>
|
|
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.test]</span>
|
|
<span class=n>matrix-name-format</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s2>"{variable}_{value}"</span>
|
|
|
|
<span class=k>[[envs.test.matrix]]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>]</span>
|
|
<span class=n>feature</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"foo"</span><span class=p>,</span><span class=w> </span><span class=s2>"bar"</span><span class=p>]</span>
|
|
</code></pre></div> </div> </div> </div> <p>would produce the following environments:</p> <div class=highlight><pre><span></span><code>test.version_42-feature_foo
|
|
test.version_42-feature_bar
|
|
</code></pre></div> <p>By default this option is set to <code>{value}</code>.</p> <h4 id=default-environment>Default environment<a class=headerlink href=#default-environment title="Permanent link">¶</a></h4> <p>If the <code>default</code> environment defines matrices, then the generated names will not be prefixed by the environment name. This can be useful for projects that only need a single series of matrices without any standalone environments.</p> <h3 id=selection>Selection<a class=headerlink href=#selection title="Permanent link">¶</a></h3> <p>Rather than <a href=../../../environment/#selection>selecting</a> a single generated environment, you can select the root environment to target all of them. For example, if you have the following configuration:</p> <div class="tabbed-set tabbed-alternate" data-tabs=5:2><input checked=checked id=pyprojecttoml_4 name=__tabbed_5 type=radio><input id=hatchtoml_4 name=__tabbed_5 type=radio><div class=tabbed-labels><label for=pyprojecttoml_4><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_4><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.test]</span>
|
|
<span class=n>dependencies</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=s2>"coverage[toml]"</span><span class=p>,</span>
|
|
<span class=w> </span><span class=s2>"pytest"</span><span class=p>,</span>
|
|
<span class=w> </span><span class=s2>"pytest-cov"</span><span class=p>,</span>
|
|
<span class=p>]</span>
|
|
|
|
<span class=k>[tool.hatch.envs.test.scripts]</span>
|
|
<span class=n>cov</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s1>'pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=pkg --cov=tests'</span>
|
|
|
|
<span class=k>[[tool.hatch.envs.test.matrix]]</span>
|
|
<span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"2.7"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.8"</span><span class=p>]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.14"</span><span class=p>]</span>
|
|
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.test]</span>
|
|
<span class=n>dependencies</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=s2>"coverage[toml]"</span><span class=p>,</span>
|
|
<span class=w> </span><span class=s2>"pytest"</span><span class=p>,</span>
|
|
<span class=w> </span><span class=s2>"pytest-cov"</span><span class=p>,</span>
|
|
<span class=p>]</span>
|
|
|
|
<span class=k>[envs.test.scripts]</span>
|
|
<span class=n>cov</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s1>'pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=pkg --cov=tests'</span>
|
|
|
|
<span class=k>[[envs.test.matrix]]</span>
|
|
<span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"2.7"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.8"</span><span class=p>]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.14"</span><span class=p>]</span>
|
|
</code></pre></div> </div> </div> </div> <p>you could then run your tests consecutively in all 4 environments with:</p> <div class=highlight><pre><span></span><code>hatch run test:cov
|
|
</code></pre></div> <h2 id=option-overrides>Option overrides<a class=headerlink href=#option-overrides title="Permanent link">¶</a></h2> <p>You can modify options based on the conditions of different sources like <a href=#matrix-variable-overrides>matrix variables</a> with the <code>overrides</code> table, using <a href=https://toml.io/en/v1.0.0#table>dotted key</a> syntax for each declaration:</p> <div class="tabbed-set tabbed-alternate" data-tabs=6:2><input checked=checked id=pyprojecttoml_5 name=__tabbed_6 type=radio><input id=hatchtoml_5 name=__tabbed_6 type=radio><div class=tabbed-labels><label for=pyprojecttoml_5><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_5><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><</span><span class=k>ENV_NAME</span><span class=err>></span><span class=k>.overrides]</span>
|
|
<span class=err><</span><span class=n>SOURCE</span><span class=err>></span><span class=p>.</span><span class=err><</span><span class=n>CONDITION</span><span class=err>></span><span class=p>.</span><span class=err><</span><span class=n>OPTION</span><span class=err>></span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=err><VALUE></span>
|
|
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.</span><span class=err><</span><span class=k>ENV_NAME</span><span class=err>></span><span class=k>.overrides]</span>
|
|
<span class=err><</span><span class=n>SOURCE</span><span class=err>></span><span class=p>.</span><span class=err><</span><span class=n>CONDITION</span><span class=err>></span><span class=p>.</span><span class=err><</span><span class=n>OPTION</span><span class=err>></span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=err><VALUE></span>
|
|
</code></pre></div> </div> </div> </div> <p>The <a href=#types>type</a> of the selected option determines the types of values.</p> <h3 id=platform-overrides>Platform overrides<a class=headerlink href=#platform-overrides title="Permanent link">¶</a></h3> <p>Options can be modified based on the current platform using the <code>platform</code> source.</p> <div class="tabbed-set tabbed-alternate" data-tabs=7:2><input checked=checked id=pyprojecttoml_6 name=__tabbed_7 type=radio><input id=hatchtoml_6 name=__tabbed_7 type=radio><div class=tabbed-labels><label for=pyprojecttoml_6><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_6><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.test.overrides]</span>
|
|
<span class=n>platform</span><span class=p>.</span><span class=n>windows</span><span class=p>.</span><span class=n>scripts</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=s1>'run=pytest -m "not io_uring"'</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>[envs.test.overrides]</span>
|
|
<span class=n>platform</span><span class=p>.</span><span class=n>windows</span><span class=p>.</span><span class=n>scripts</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=s1>'run=pytest -m "not io_uring"'</span><span class=p>,</span>
|
|
<span class=p>]</span>
|
|
</code></pre></div> </div> </div> </div> <p>The following platforms are supported:</p> <ul> <li><code>linux</code></li> <li><code>windows</code></li> <li><code>macos</code></li> </ul> <h3 id=environment-variable-overrides>Environment variable overrides<a class=headerlink href=#environment-variable-overrides title="Permanent link">¶</a></h3> <p>Environment variables can modify options using the <code>env</code> source.</p> <div class="tabbed-set tabbed-alternate" data-tabs=8:2><input checked=checked id=pyprojecttoml_7 name=__tabbed_8 type=radio><input id=hatchtoml_7 name=__tabbed_8 type=radio><div class=tabbed-labels><label for=pyprojecttoml_7><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_7><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.test.overrides]</span>
|
|
<span class=n>env</span><span class=p>.</span><span class=n>GITHUB_ACTIONS</span><span class=p>.</span><span class=n>dev-mode</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=kc>false</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"true"</span><span class=p>]</span><span class=w> </span><span class=p>}</span>
|
|
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.test.overrides]</span>
|
|
<span class=n>env</span><span class=p>.</span><span class=n>GITHUB_ACTIONS</span><span class=p>.</span><span class=n>dev-mode</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=kc>false</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"true"</span><span class=p>]</span><span class=w> </span><span class=p>}</span>
|
|
</code></pre></div> </div> </div> </div> <h3 id=matrix-variable-overrides>Matrix variable overrides<a class=headerlink href=#matrix-variable-overrides title="Permanent link">¶</a></h3> <p>The <a href=#matrix>matrix</a> variables used to generate each environment can be used to modify options within using the <code>matrix</code> source.</p> <div class="tabbed-set tabbed-alternate" data-tabs=9:2><input checked=checked id=pyprojecttoml_8 name=__tabbed_9 type=radio><input id=hatchtoml_8 name=__tabbed_9 type=radio><div class=tabbed-labels><label for=pyprojecttoml_8><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_8><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.test.overrides]</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>version</span><span class=p>.</span><span class=n>env-vars</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s2>"PRODUCT_VERSION"</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>auth</span><span class=p>.</span><span class=n>features</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"oauth"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"oauth2"</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"kerberos"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"kerberos"</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=p>]</span>
|
|
|
|
<span class=k>[[tool.hatch.envs.test.matrix]]</span>
|
|
<span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"2.7"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.8"</span><span class=p>]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"legacy"</span><span class=p>,</span><span class=w> </span><span class=s2>"latest"</span><span class=p>]</span>
|
|
<span class=n>auth</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"oauth2"</span><span class=p>,</span><span class=w> </span><span class=s2>"kerberos"</span><span class=p>,</span><span class=w> </span><span class=s2>"noauth"</span><span class=p>]</span>
|
|
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.test.overrides]</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>version</span><span class=p>.</span><span class=n>env-vars</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s2>"PRODUCT_VERSION"</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>auth</span><span class=p>.</span><span class=n>features</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"oauth"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"oauth2"</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"kerberos"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"kerberos"</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=p>]</span>
|
|
|
|
<span class=k>[[envs.test.matrix]]</span>
|
|
<span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"2.7"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.8"</span><span class=p>]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"legacy"</span><span class=p>,</span><span class=w> </span><span class=s2>"latest"</span><span class=p>]</span>
|
|
<span class=n>auth</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"oauth2"</span><span class=p>,</span><span class=w> </span><span class=s2>"kerberos"</span><span class=p>,</span><span class=w> </span><span class=s2>"noauth"</span><span class=p>]</span>
|
|
</code></pre></div> </div> </div> </div> <h3 id=name-overrides>Name overrides<a class=headerlink href=#name-overrides title="Permanent link">¶</a></h3> <p>When a <a href=#matrix>matrix</a> is defined, the <code>name</code> source can be used for regular expression matching on the generated name, minus the prefix for non-<a href=#default-environment>default</a> environments.</p> <div class="tabbed-set tabbed-alternate" data-tabs=10:2><input checked=checked id=pyprojecttoml_9 name=__tabbed_10 type=radio><input id=hatchtoml_9 name=__tabbed_10 type=radio><div class=tabbed-labels><label for=pyprojecttoml_9><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_9><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.test.overrides]</span>
|
|
<span class=n>name</span><span class=p>.</span><span class=s2>"^0"</span><span class=p>.</span><span class=n>env-vars</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s2>"TESTING_UNSTABLE=true"</span>
|
|
|
|
<span class=k>[[tool.hatch.envs.test.matrix]]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"0.1.0"</span><span class=p>,</span><span class=w> </span><span class=s2>"0.2.0"</span><span class=p>,</span><span class=w> </span><span class=s2>"1.0.0"</span><span class=p>]</span>
|
|
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.test.overrides]</span>
|
|
<span class=n>name</span><span class=p>.</span><span class=s2>"^0"</span><span class=p>.</span><span class=n>env-vars</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s2>"TESTING_UNSTABLE=true"</span>
|
|
|
|
<span class=k>[[envs.test.matrix]]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"0.1.0"</span><span class=p>,</span><span class=w> </span><span class=s2>"0.2.0"</span><span class=p>,</span><span class=w> </span><span class=s2>"1.0.0"</span><span class=p>]</span>
|
|
</code></pre></div> </div> </div> </div> <h3 id=types>Types<a class=headerlink href=#types title="Permanent link">¶</a></h3> <ul> <li> <p>Literal types like strings for the <a href=../overview/#python-version>Python version</a> or booleans for <a href=../overview/#skip-install>skipping installation</a> can be set using the value itself, an inline table, or an array. For example:</p> <div class="tabbed-set tabbed-alternate" data-tabs=11:2><input checked=checked id=pyprojecttoml_10 name=__tabbed_11 type=radio><input id=hatchtoml_10 name=__tabbed_11 type=radio><div class=tabbed-labels><label for=pyprojecttoml_10><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_10><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.test.overrides]</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>foo</span><span class=p>.</span><span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s2>"3.10"</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>bar</span><span class=p>.</span><span class=n>skip-install</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=kc>true</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"..."</span><span class=p>]</span><span class=w> </span><span class=p>}</span>
|
|
<span class=n>env</span><span class=p>.</span><span class=n>CI</span><span class=p>.</span><span class=n>dev-mode</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=kc>false</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"..."</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=w> </span><span class=kc>true</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>[envs.test.overrides]</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>foo</span><span class=p>.</span><span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s2>"3.10"</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>bar</span><span class=p>.</span><span class=n>skip-install</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=kc>true</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"..."</span><span class=p>]</span><span class=w> </span><span class=p>}</span>
|
|
<span class=n>env</span><span class=p>.</span><span class=n>CI</span><span class=p>.</span><span class=n>dev-mode</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=kc>false</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"..."</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=w> </span><span class=kc>true</span><span class=p>,</span>
|
|
<span class=p>]</span>
|
|
</code></pre></div> </div> </div> </div> <p>For arrays, the first allowed value will be used.</p> </li> <li> <p>Array types like <a href=../overview/#dependencies>dependencies</a> or <a href=../overview/#commands>commands</a> can be appended to using an array of strings or inline tables. For example:</p> <div class="tabbed-set tabbed-alternate" data-tabs=12:2><input checked=checked id=pyprojecttoml_11 name=__tabbed_12 type=radio><input id=hatchtoml_11 name=__tabbed_12 type=radio><div class=tabbed-labels><label for=pyprojecttoml_11><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_11><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.test.overrides]</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>foo</span><span class=p>.</span><span class=n>dependencies</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=s2>"httpx"</span><span class=p>,</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"cryptography"</span><span class=w> </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>[envs.test.overrides]</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>foo</span><span class=p>.</span><span class=n>dependencies</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=s2>"httpx"</span><span class=p>,</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"cryptography"</span><span class=w> </span><span class=p>},</span>
|
|
<span class=p>]</span>
|
|
</code></pre></div> </div> </div> </div> </li> <li> <p>Mapping types like <a href=../overview/#environment-variables>environment variables</a> or <a href=../overview/#scripts>scripts</a> can have keys set using a string, or an array of strings or inline tables. For example:</p> <div class="tabbed-set tabbed-alternate" data-tabs=13:2><input checked=checked id=pyprojecttoml_12 name=__tabbed_13 type=radio><input id=hatchtoml_12 name=__tabbed_13 type=radio><div class=tabbed-labels><label for=pyprojecttoml_12><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_12><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.test.overrides]</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>foo</span><span class=p>.</span><span class=n>env-vars</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s2>"KEY=VALUE"</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>bar</span><span class=p>.</span><span class=n>env-vars</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=s2>"KEY1=VALUE1"</span><span class=p>,</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>key</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"KEY2"</span><span class=p>,</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"VALUE2"</span><span class=w> </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>[envs.test.overrides]</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>foo</span><span class=p>.</span><span class=n>env-vars</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=s2>"KEY=VALUE"</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>bar</span><span class=p>.</span><span class=n>env-vars</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=s2>"KEY1=VALUE1"</span><span class=p>,</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>key</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"KEY2"</span><span class=p>,</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"VALUE2"</span><span class=w> </span><span class=p>},</span>
|
|
<span class=p>]</span>
|
|
</code></pre></div> </div> </div> </div> <p>If the value is missing (no <code>=</code> for strings, no <code>value</code> key for inline tables), then the value will be set to the value of the source condition.</p> </li> </ul> <h3 id=overwriting>Overwriting<a class=headerlink href=#overwriting title="Permanent link">¶</a></h3> <p>Rather than supplementing the values within mapping types or array types, you can overwrite the option as a whole by prefixing the name with <code>set-</code>:</p> <div class="tabbed-set tabbed-alternate" data-tabs=14:2><input checked=checked id=pyprojecttoml_13 name=__tabbed_14 type=radio><input id=hatchtoml_13 name=__tabbed_14 type=radio><div class=tabbed-labels><label for=pyprojecttoml_13><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_13><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.test.overrides]</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>foo</span><span class=p>.</span><span class=n>set-platforms</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"macos"</span><span class=p>,</span><span class=w> </span><span class=s2>"linux"</span><span class=p>]</span>
|
|
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.test.overrides]</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>foo</span><span class=p>.</span><span class=n>set-platforms</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"macos"</span><span class=p>,</span><span class=w> </span><span class=s2>"linux"</span><span class=p>]</span>
|
|
</code></pre></div> </div> </div> </div> <p>When overwriting entire options or keys within mappings, override sources are applied in the following order:</p> <ol> <li><a href=#platform-overrides>platform</a></li> <li><a href=#environment-variable-overrides>environment variables</a></li> <li><a href=#matrix-variable-overrides>matrix variables</a></li> <li><a href=#name-overrides>names</a></li> </ol> <h3 id=conditions>Conditions<a class=headerlink href=#conditions title="Permanent link">¶</a></h3> <p>You may specify certain extra keys for any inline table that will determine whether or not to apply that entry. These modifiers may be combined with others and any negative evaluation will immediately cause the entry to be skipped.</p> <h4 id=allowed-values>Allowed values<a class=headerlink href=#allowed-values title="Permanent link">¶</a></h4> <p>The <code>if</code> key represents the allowed values for that condition. If the value of the condition is not listed, then that entry will not be applied:</p> <div class="tabbed-set tabbed-alternate" data-tabs=15:2><input checked=checked id=pyprojecttoml_14 name=__tabbed_15 type=radio><input id=hatchtoml_14 name=__tabbed_15 type=radio><div class=tabbed-labels><label for=pyprojecttoml_14><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_14><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.test.overrides]</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>version</span><span class=p>.</span><span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"pypy"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.14"</span><span class=p>]</span><span class=w> </span><span class=p>}</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>version</span><span class=p>.</span><span class=n>env-vars</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>key</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"KEY1"</span><span class=p>,</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"VALUE1"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>key</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"KEY2"</span><span class=p>,</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"VALUE2"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.14"</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=p>]</span>
|
|
|
|
<span class=k>[[tool.hatch.envs.test.matrix]]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.14"</span><span class=p>]</span>
|
|
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.test.overrides]</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>version</span><span class=p>.</span><span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"pypy"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.14"</span><span class=p>]</span><span class=w> </span><span class=p>}</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>version</span><span class=p>.</span><span class=n>env-vars</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>key</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"KEY1"</span><span class=p>,</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"VALUE1"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>key</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"KEY2"</span><span class=p>,</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"VALUE2"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.14"</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=p>]</span>
|
|
|
|
<span class=k>[[envs.test.matrix]]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.14"</span><span class=p>]</span>
|
|
</code></pre></div> </div> </div> </div> <h4 id=specific-platforms>Specific platforms<a class=headerlink href=#specific-platforms title="Permanent link">¶</a></h4> <p>The <code>platform</code> key represents the desired platforms. If the current platform is not listed, then that entry will not be applied:</p> <div class="tabbed-set tabbed-alternate" data-tabs=16:2><input checked=checked id=pyprojecttoml_15 name=__tabbed_16 type=radio><input id=hatchtoml_15 name=__tabbed_16 type=radio><div class=tabbed-labels><label for=pyprojecttoml_15><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_15><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.test.overrides]</span>
|
|
<span class=n>env</span><span class=p>.</span><span class=n>EXPERIMENTAL</span><span class=p>.</span><span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"pypy"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"1"</span><span class=p>],</span><span class=w> </span><span class=n>platform</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"macos"</span><span class=p>]</span><span class=w> </span><span class=p>}</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>version</span><span class=p>.</span><span class=n>env-vars</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>key</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"KEY1"</span><span class=p>,</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"VALUE1"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>],</span><span class=w> </span><span class=n>platform</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"linux"</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>key</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"KEY2"</span><span class=p>,</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"VALUE2"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.14"</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=p>]</span>
|
|
|
|
<span class=k>[[tool.hatch.envs.test.matrix]]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.14"</span><span class=p>]</span>
|
|
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.test.overrides]</span>
|
|
<span class=n>env</span><span class=p>.</span><span class=n>EXPERIMENTAL</span><span class=p>.</span><span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"pypy"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"1"</span><span class=p>],</span><span class=w> </span><span class=n>platform</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"macos"</span><span class=p>]</span><span class=w> </span><span class=p>}</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>version</span><span class=p>.</span><span class=n>env-vars</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>key</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"KEY1"</span><span class=p>,</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"VALUE1"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>],</span><span class=w> </span><span class=n>platform</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"linux"</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>key</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"KEY2"</span><span class=p>,</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"VALUE2"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.14"</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=p>]</span>
|
|
|
|
<span class=k>[[envs.test.matrix]]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.14"</span><span class=p>]</span>
|
|
</code></pre></div> </div> </div> </div> <h4 id=required-environment-variables>Required environment variables<a class=headerlink href=#required-environment-variables title="Permanent link">¶</a></h4> <p>The <code>env</code> key represents the required environment variables. If any of the listed environment variables are not set or the defined value does not match, then that entry will not be applied:</p> <div class="tabbed-set tabbed-alternate" data-tabs=17:2><input checked=checked id=pyprojecttoml_16 name=__tabbed_17 type=radio><input id=hatchtoml_16 name=__tabbed_17 type=radio><div class=tabbed-labels><label for=pyprojecttoml_16><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_16><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.test.overrides]</span>
|
|
<span class=n>platform</span><span class=p>.</span><span class=n>windows</span><span class=p>.</span><span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"pypy"</span><span class=p>,</span><span class=w> </span><span class=n>env</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"EXPERIMENTAL"</span><span class=p>]</span><span class=w> </span><span class=p>}</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>version</span><span class=p>.</span><span class=n>env-vars</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>key</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"KEY1"</span><span class=p>,</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"VALUE1"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>],</span><span class=w> </span><span class=n>env</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"FOO"</span><span class=p>,</span><span class=w> </span><span class=s2>"BAR=BAZ"</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>key</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"KEY2"</span><span class=p>,</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"VALUE2"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.14"</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=p>]</span>
|
|
|
|
<span class=k>[[tool.hatch.envs.test.matrix]]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.14"</span><span class=p>]</span>
|
|
</code></pre></div> </div> <div class=tabbed-block> <div class=highlight><pre><span></span><code><span class=k>[envs.test.overrides]</span>
|
|
<span class=n>platform</span><span class=p>.</span><span class=n>windows</span><span class=p>.</span><span class=n>python</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"pypy"</span><span class=p>,</span><span class=w> </span><span class=n>env</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"EXPERIMENTAL"</span><span class=p>]</span><span class=w> </span><span class=p>}</span>
|
|
<span class=n>matrix</span><span class=p>.</span><span class=n>version</span><span class=p>.</span><span class=n>env-vars</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>key</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"KEY1"</span><span class=p>,</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"VALUE1"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>],</span><span class=w> </span><span class=n>env</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"FOO"</span><span class=p>,</span><span class=w> </span><span class=s2>"BAR=BAZ"</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=w> </span><span class=p>{</span><span class=w> </span><span class=n>key</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"KEY2"</span><span class=p>,</span><span class=w> </span><span class=n>value</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=s2>"VALUE2"</span><span class=p>,</span><span class=w> </span><span class=n>if</span><span class=w> </span><span class=p>=</span><span class=w> </span><span class=p>[</span><span class=s2>"3.14"</span><span class=p>]</span><span class=w> </span><span class=p>},</span>
|
|
<span class=p>]</span>
|
|
|
|
<span class=k>[[envs.test.matrix]]</span>
|
|
<span class=n>version</span><span class=w> </span><span class=o>=</span><span class=w> </span><span class=p>[</span><span class=s2>"42"</span><span class=p>,</span><span class=w> </span><span class=s2>"3.14"</span><span class=p>]</span>
|
|
</code></pre></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">October 8, 2023</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/oprypin class=md-author title=@oprypin> <img src="https://avatars.githubusercontent.com/u/371383?v=4&size=72" alt=oprypin> </a> <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> </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=../overview/ class="md-footer__link md-footer__link--prev" aria-label="Previous: Overview"> <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> Overview </div> </div> </a> <a href=../../static-analysis/ class="md-footer__link md-footer__link--next" aria-label="Next: Static analysis"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> Static analysis </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 © 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.4.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 2023 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.4.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 2023 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.4.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 2023 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.4.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 2023 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.8e8db93a.min.js></script> <script>document$.subscribe(() => {const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});})</script></body> </html> |