File size: 90,605 Bytes
71687cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 | # Copyright (C) 2012 Anaconda, Inc
# SPDX-License-Identifier: BSD-3-Clause
"""Conda's global configuration object.
The context aggregates all configuration files, environment variables, and command line arguments
into one global stateful object to be used across all of conda.
"""
from __future__ import annotations
import logging
import os
import platform
import struct
import sys
import warnings
from contextlib import contextmanager, suppress
from errno import ENOENT
from functools import cache, cached_property
from itertools import chain
from os.path import abspath, exists, expanduser, isdir, isfile, join
from os.path import split as path_split
from pathlib import Path
from typing import TYPE_CHECKING
from frozendict import frozendict
from .. import CONDA_SOURCE_ROOT
from .. import __version__ as CONDA_VERSION
from ..auxlib.decorators import memoizedproperty
from ..auxlib.ish import dals
from ..common._os.linux import linux_get_libc_version
from ..common._os.osx import mac_ver
from ..common.compat import NoneType, on_win
from ..common.configuration import (
DEFAULT_CONDARC_FILENAME,
Configuration,
ConfigurationLoadError,
MapParameter,
ParameterLoader,
PrimitiveParameter,
SequenceParameter,
ValidationError,
YamlRawParameter,
)
from ..common.constants import TRACE
from ..common.iterators import groupby_to_dict, unique
from ..common.path import BIN_DIRECTORY, expand, paths_equal
from ..common.url import has_scheme, path_to_url, split_scheme_auth_token
from ..deprecations import deprecated
from .constants import (
APP_NAME,
CMD_LINE_SOURCE,
CONDA_LIST_FIELDS,
DEFAULT_AGGRESSIVE_UPDATE_PACKAGES,
DEFAULT_CHANNEL_ALIAS,
DEFAULT_CHANNELS,
DEFAULT_CHANNELS_UNIX,
DEFAULT_CHANNELS_WIN,
DEFAULT_CONDA_LIST_FIELDS,
DEFAULT_CONSOLE_REPORTER_BACKEND,
DEFAULT_CUSTOM_CHANNELS,
DEFAULT_JSON_REPORTER_BACKEND,
DEFAULT_SOLVER,
DEFAULTS_CHANNEL_NAME,
ENV_VARS_SOURCE,
KNOWN_SUBDIRS,
NO_PLUGINS,
PREFIX_MAGIC_FILE,
PREFIX_NAME_DISALLOWED_CHARS,
REPODATA_FN,
RESERVED_ENV_NAMES,
ROOT_ENV_NAME,
SEARCH_PATH,
UNKNOWN_CHANNEL,
ChannelPriority,
DepsModifier,
PathConflict,
SafetyChecks,
SatSolverChoice,
UpdateModifier,
)
if TYPE_CHECKING:
from argparse import Namespace
from collections.abc import Iterable, Iterator
from typing import Any, Literal
from ..common.configuration import Parameter, RawParameter
from ..common.path import PathsType, PathType
from ..models.channel import Channel
from ..models.match_spec import MatchSpec
from ..plugins.config import PluginConfig
from ..plugins.manager import CondaPluginManager
try:
os.getcwd()
except OSError as e:
if e.errno == ENOENT:
# FileNotFoundError can occur when cwd has been deleted out from underneath the process.
# To resolve #6584, let's go with setting cwd to sys.prefix, and see how far we get.
os.chdir(sys.prefix)
else:
raise
log = logging.getLogger(__name__)
_platform_map = {
"freebsd13": "freebsd",
"linux2": "linux",
"linux": "linux",
"darwin": "osx",
"win32": "win",
"zos": "zos",
}
non_x86_machines = {
"armv6l",
"armv7l",
"aarch64",
"arm64",
"ppc64",
"ppc64le",
"riscv64",
"s390x",
}
_arch_names = {
32: "x86",
64: "x86_64",
}
user_rc_path: PathType = abspath(expanduser(f"~/{DEFAULT_CONDARC_FILENAME}"))
sys_rc_path: PathType = join(sys.prefix, DEFAULT_CONDARC_FILENAME)
def user_data_dir( # noqa: F811
appname: str | None = None,
appauthor: str | None | Literal[False] = None,
version: str | None = None,
roaming: bool = False,
) -> PathType:
# Defer platformdirs import to reduce import time for conda activate.
global user_data_dir
from platformdirs import user_data_dir
return user_data_dir(appname, appauthor=appauthor, version=version, roaming=roaming)
def mockable_context_envs_dirs(
root_writable: bool, root_prefix: PathType, _envs_dirs: PathsType
) -> tuple[PathType, ...]:
if root_writable:
fixed_dirs = [
join(root_prefix, "envs"),
join("~", ".conda", "envs"),
]
else:
fixed_dirs = [
join("~", ".conda", "envs"),
join(root_prefix, "envs"),
]
if on_win:
fixed_dirs.append(join(user_data_dir(APP_NAME, APP_NAME), "envs"))
return tuple(dict.fromkeys(expand(path) for path in (*_envs_dirs, *fixed_dirs)))
def channel_alias_validation(value: str) -> str | Literal[True]:
if value and not has_scheme(value):
return f"channel_alias value '{value}' must have scheme/protocol."
return True
def default_python_default() -> str:
ver = sys.version_info
return "%d.%d" % (ver.major, ver.minor)
def default_python_validation(value: str) -> str | Literal[True]:
if value:
if len(value) >= 3 and value[1] == ".":
try:
value = float(value)
if 2.0 <= value < 4.0:
return True
except ValueError: # pragma: no cover
pass
else:
# Set to None or '' meaning no python pinning
return True
return f"default_python value '{value}' not of the form '[23].[0-9][0-9]?' or ''"
def list_fields_validation(value: Iterable[str]) -> str | Literal[True]:
if invalid := set(value).difference(CONDA_LIST_FIELDS):
return (
f"Invalid value(s): {sorted(invalid)}. "
f"Valid values are: {sorted(CONDA_LIST_FIELDS)}"
)
return True
def ssl_verify_validation(value: str) -> str | Literal[True]:
if isinstance(value, str):
if sys.version_info < (3, 10) and value == "truststore":
return "`ssl_verify: truststore` is only supported on Python 3.10 or later"
elif value != "truststore" and not exists(value):
return (
f"ssl_verify value '{value}' must be a boolean, a path to a "
"certificate bundle file, a path to a directory containing "
"certificates of trusted CAs, or 'truststore' to use the "
"operating system certificate store."
)
return True
class Context(Configuration):
add_pip_as_python_dependency = ParameterLoader(PrimitiveParameter(True))
allow_conda_downgrades = ParameterLoader(PrimitiveParameter(False))
# allow cyclical dependencies, or raise
allow_cycles = ParameterLoader(PrimitiveParameter(True))
allow_softlinks = ParameterLoader(PrimitiveParameter(False))
auto_update_conda = ParameterLoader(
PrimitiveParameter(True), aliases=("self_update",)
)
auto_activate = ParameterLoader(
PrimitiveParameter(True), aliases=("auto_activate_base",)
)
_default_activation_env = ParameterLoader(
PrimitiveParameter(ROOT_ENV_NAME), aliases=("default_activation_env",)
)
auto_stack = ParameterLoader(PrimitiveParameter(0))
notify_outdated_conda = ParameterLoader(PrimitiveParameter(True))
clobber = ParameterLoader(PrimitiveParameter(False))
changeps1 = ParameterLoader(PrimitiveParameter(True))
env_prompt = ParameterLoader(PrimitiveParameter("({default_env}) "))
# environment_specifier is an EXPERIMENTAL config parameter
environment_specifier = ParameterLoader(
PrimitiveParameter(None, element_type=(str, NoneType)), aliases=("env_spec",)
)
_create_default_packages = ParameterLoader(
SequenceParameter(PrimitiveParameter("", element_type=str)),
aliases=("create_default_packages",),
)
register_envs = ParameterLoader(PrimitiveParameter(True))
protect_frozen_envs = ParameterLoader(PrimitiveParameter(True))
default_python = ParameterLoader(
PrimitiveParameter(
default_python_default(),
element_type=(str, NoneType),
validation=default_python_validation,
)
)
download_only = ParameterLoader(PrimitiveParameter(False))
enable_private_envs = ParameterLoader(PrimitiveParameter(False))
force_32bit = ParameterLoader(PrimitiveParameter(False))
non_admin_enabled = ParameterLoader(PrimitiveParameter(True))
prefix_data_interoperability = ParameterLoader(
PrimitiveParameter(False), aliases=("pip_interop_enabled",)
)
@property
@deprecated("25.9", "26.3", addendum="Use 'Context.prefix_data_interoperability'.")
def pip_interop_enabled(self):
return self.prefix_data_interoperability
# multithreading in various places
_default_threads = ParameterLoader(
PrimitiveParameter(0, element_type=int), aliases=("default_threads",)
)
# download repodata
_repodata_threads = ParameterLoader(
PrimitiveParameter(0, element_type=int), aliases=("repodata_threads",)
)
# download packages
_fetch_threads = ParameterLoader(
PrimitiveParameter(0, element_type=int), aliases=("fetch_threads",)
)
_verify_threads = ParameterLoader(
PrimitiveParameter(0, element_type=int), aliases=("verify_threads",)
)
# this one actually defaults to 1 - that is handled in the property below
_execute_threads = ParameterLoader(
PrimitiveParameter(0, element_type=int), aliases=("execute_threads",)
)
# Safety & Security
_aggressive_update_packages = ParameterLoader(
SequenceParameter(
PrimitiveParameter("", element_type=str), DEFAULT_AGGRESSIVE_UPDATE_PACKAGES
),
aliases=("aggressive_update_packages",),
)
safety_checks = ParameterLoader(PrimitiveParameter(SafetyChecks.warn))
extra_safety_checks = ParameterLoader(PrimitiveParameter(False))
_signing_metadata_url_base = ParameterLoader(
PrimitiveParameter(None, element_type=(str, NoneType)),
aliases=("signing_metadata_url_base",),
)
path_conflict = ParameterLoader(PrimitiveParameter(PathConflict.clobber))
pinned_packages = ParameterLoader(
SequenceParameter(
PrimitiveParameter("", element_type=str), string_delimiter="&"
)
) # TODO: consider a different string delimiter
disallowed_packages = ParameterLoader(
SequenceParameter(
PrimitiveParameter("", element_type=str), string_delimiter="&"
),
aliases=("disallow",),
)
rollback_enabled = ParameterLoader(PrimitiveParameter(True))
track_features = ParameterLoader(
SequenceParameter(PrimitiveParameter("", element_type=str))
)
use_index_cache = ParameterLoader(PrimitiveParameter(False))
separate_format_cache = ParameterLoader(PrimitiveParameter(False))
_root_prefix = ParameterLoader(
PrimitiveParameter(""), aliases=("root_dir", "root_prefix")
)
_envs_dirs = ParameterLoader(
SequenceParameter(
PrimitiveParameter("", element_type=str), string_delimiter=os.pathsep
),
aliases=("envs_dirs", "envs_path"),
expandvars=True,
)
_pkgs_dirs = ParameterLoader(
SequenceParameter(PrimitiveParameter("", str)),
aliases=("pkgs_dirs",),
expandvars=True,
)
_subdir = ParameterLoader(PrimitiveParameter(""), aliases=("subdir",))
_subdirs = ParameterLoader(
SequenceParameter(PrimitiveParameter("", str)), aliases=("subdirs",)
)
_export_platforms = ParameterLoader(
SequenceParameter(PrimitiveParameter("", str)),
aliases=("export_platforms", "extra_platforms"),
)
local_repodata_ttl = ParameterLoader(
PrimitiveParameter(1, element_type=(bool, int))
)
# number of seconds to cache repodata locally
# True/1: respect Cache-Control max-age header
# False/0: always fetch remote repodata (HTTP 304 responses respected)
# remote connection details
ssl_verify = ParameterLoader(
PrimitiveParameter(
True, element_type=(str, bool), validation=ssl_verify_validation
),
aliases=("verify_ssl",),
expandvars=True,
)
client_ssl_cert = ParameterLoader(
PrimitiveParameter(None, element_type=(str, NoneType)),
aliases=("client_cert",),
expandvars=True,
)
client_ssl_cert_key = ParameterLoader(
PrimitiveParameter(None, element_type=(str, NoneType)),
aliases=("client_cert_key",),
expandvars=True,
)
proxy_servers = ParameterLoader(
MapParameter(PrimitiveParameter(None, (str, NoneType))), expandvars=True
)
remote_connect_timeout_secs = ParameterLoader(PrimitiveParameter(9.15))
remote_read_timeout_secs = ParameterLoader(PrimitiveParameter(60.0))
remote_max_retries = ParameterLoader(PrimitiveParameter(3))
remote_backoff_factor = ParameterLoader(PrimitiveParameter(1))
add_anaconda_token = ParameterLoader(
PrimitiveParameter(True), aliases=("add_binstar_token",)
)
####################################################
# Channel Configuration #
####################################################
allow_non_channel_urls = ParameterLoader(PrimitiveParameter(False))
_channel_alias = ParameterLoader(
PrimitiveParameter(DEFAULT_CHANNEL_ALIAS, validation=channel_alias_validation),
aliases=("channel_alias",),
expandvars=True,
)
channel_priority = ParameterLoader(PrimitiveParameter(ChannelPriority.FLEXIBLE))
_channels = ParameterLoader(
SequenceParameter(PrimitiveParameter("", element_type=str), default=()),
aliases=(
"channels",
"channel",
),
expandvars=True,
) # channel for args.channel
channel_settings = ParameterLoader(
SequenceParameter(MapParameter(PrimitiveParameter("", element_type=str)))
)
_custom_channels = ParameterLoader(
MapParameter(PrimitiveParameter("", element_type=str), DEFAULT_CUSTOM_CHANNELS),
aliases=("custom_channels",),
expandvars=True,
)
_custom_multichannels = ParameterLoader(
MapParameter(SequenceParameter(PrimitiveParameter("", element_type=str))),
aliases=("custom_multichannels",),
expandvars=True,
)
_default_channels = ParameterLoader(
SequenceParameter(PrimitiveParameter("", element_type=str), DEFAULT_CHANNELS),
aliases=("default_channels",),
expandvars=True,
)
_migrated_channel_aliases = ParameterLoader(
SequenceParameter(PrimitiveParameter("", element_type=str)),
aliases=("migrated_channel_aliases",),
)
migrated_custom_channels = ParameterLoader(
MapParameter(PrimitiveParameter("", element_type=str)), expandvars=True
) # TODO: also take a list of strings
override_channels_enabled = ParameterLoader(PrimitiveParameter(True))
show_channel_urls = ParameterLoader(
PrimitiveParameter(None, element_type=(bool, NoneType))
)
use_local = ParameterLoader(PrimitiveParameter(False))
allowlist_channels = ParameterLoader(
SequenceParameter(PrimitiveParameter("", element_type=str)),
aliases=("whitelist_channels",),
expandvars=True,
)
denylist_channels = ParameterLoader(
SequenceParameter(PrimitiveParameter("", element_type=str)),
expandvars=True,
)
repodata_fns = ParameterLoader(
SequenceParameter(
PrimitiveParameter("", element_type=str),
("current_repodata.json", REPODATA_FN),
)
)
_use_only_tar_bz2 = ParameterLoader(
PrimitiveParameter(None, element_type=(bool, NoneType)),
aliases=("use_only_tar_bz2",),
)
always_softlink = ParameterLoader(PrimitiveParameter(False), aliases=("softlink",))
always_copy = ParameterLoader(PrimitiveParameter(False), aliases=("copy",))
always_yes = ParameterLoader(
PrimitiveParameter(None, element_type=(bool, NoneType)), aliases=("yes",)
)
_debug = ParameterLoader(PrimitiveParameter(False), aliases=["debug"])
_trace = ParameterLoader(PrimitiveParameter(False), aliases=["trace"])
dev = ParameterLoader(PrimitiveParameter(False))
dry_run = ParameterLoader(PrimitiveParameter(False))
_error_upload_url = ParameterLoader(
PrimitiveParameter("https://conda.io/conda-post/unexpected-error"),
aliases=("error_upload_url",),
)
force = ParameterLoader(PrimitiveParameter(False))
json = ParameterLoader(PrimitiveParameter(False))
_console = ParameterLoader(
PrimitiveParameter(DEFAULT_CONSOLE_REPORTER_BACKEND, element_type=str),
aliases=["console"],
)
list_fields = ParameterLoader(
SequenceParameter(
PrimitiveParameter("", element_type=str),
default=DEFAULT_CONDA_LIST_FIELDS,
validation=list_fields_validation,
)
)
offline = ParameterLoader(PrimitiveParameter(False))
quiet = ParameterLoader(PrimitiveParameter(False))
ignore_pinned = ParameterLoader(PrimitiveParameter(False))
_report_errors = ParameterLoader(
PrimitiveParameter(None, element_type=(bool, NoneType)),
aliases=("report_errors",),
)
shortcuts = ParameterLoader(PrimitiveParameter(True))
number_channel_notices = ParameterLoader(PrimitiveParameter(5, element_type=int))
shortcuts = ParameterLoader(PrimitiveParameter(True))
shortcuts_only = ParameterLoader(
SequenceParameter(PrimitiveParameter("", element_type=str)), expandvars=True
)
_verbosity = ParameterLoader(
PrimitiveParameter(0, element_type=int), aliases=("verbose", "verbosity")
)
experimental = ParameterLoader(SequenceParameter(PrimitiveParameter("", str)))
no_lock = ParameterLoader(PrimitiveParameter(False))
repodata_use_zst = ParameterLoader(PrimitiveParameter(True))
envvars_force_uppercase = ParameterLoader(PrimitiveParameter(True))
####################################################
# Solver Configuration #
####################################################
deps_modifier = ParameterLoader(PrimitiveParameter(DepsModifier.NOT_SET))
update_modifier = ParameterLoader(PrimitiveParameter(UpdateModifier.UPDATE_SPECS))
sat_solver = ParameterLoader(PrimitiveParameter(SatSolverChoice.PYCOSAT))
solver_ignore_timestamps = ParameterLoader(PrimitiveParameter(False))
solver = ParameterLoader(
PrimitiveParameter(DEFAULT_SOLVER),
aliases=("experimental_solver",),
)
# # CLI-only
# no_deps = ParameterLoader(PrimitiveParameter(NULL, element_type=(type(NULL), bool)))
# # CLI-only
# only_deps = ParameterLoader(PrimitiveParameter(NULL, element_type=(type(NULL), bool)))
#
# freeze_installed = ParameterLoader(PrimitiveParameter(False))
# update_deps = ParameterLoader(PrimitiveParameter(False), aliases=('update_dependencies',))
# update_specs = ParameterLoader(PrimitiveParameter(False))
# update_all = ParameterLoader(PrimitiveParameter(False))
force_remove = ParameterLoader(PrimitiveParameter(False))
force_reinstall = ParameterLoader(PrimitiveParameter(False))
target_prefix_override = ParameterLoader(PrimitiveParameter(""))
unsatisfiable_hints = ParameterLoader(PrimitiveParameter(True))
unsatisfiable_hints_check_depth = ParameterLoader(PrimitiveParameter(2))
# conda_build
bld_path = ParameterLoader(PrimitiveParameter(""))
anaconda_upload = ParameterLoader(
PrimitiveParameter(None, element_type=(bool, NoneType)),
aliases=("binstar_upload",),
)
_croot = ParameterLoader(PrimitiveParameter(""), aliases=("croot",))
_conda_build = ParameterLoader(
MapParameter(PrimitiveParameter("", element_type=str)),
aliases=("conda-build", "conda_build"),
)
_override_virtual_packages = ParameterLoader(
MapParameter(PrimitiveParameter(None, element_type=(str, NoneType))),
aliases=("virtual_packages", "override_virtual_packages"),
)
####################################################
# Plugin Configuration #
####################################################
no_plugins = ParameterLoader(PrimitiveParameter(NO_PLUGINS))
def __init__(
self,
search_path: PathsType | None = None,
argparse_args: Namespace | None = None,
**kwargs,
):
super().__init__(argparse_args=argparse_args)
self._set_search_path(
SEARCH_PATH if search_path is None else search_path,
# for proper search_path templating when --name/--prefix is used
CONDA_PREFIX=determine_target_prefix(self, argparse_args),
)
self._set_env_vars(APP_NAME)
self._set_argparse_args(argparse_args)
def post_build_validation(self) -> list[ValidationError]:
errors = []
if self.client_ssl_cert_key and not self.client_ssl_cert:
error = ValidationError(
"client_ssl_cert",
self.client_ssl_cert,
"<<merged>>",
"'client_ssl_cert' is required when 'client_ssl_cert_key' is defined",
)
errors.append(error)
if self.always_copy and self.always_softlink:
error = ValidationError(
"always_copy",
self.always_copy,
"<<merged>>",
"'always_copy' and 'always_softlink' are mutually exclusive. "
"Only one can be set to 'True'.",
)
errors.append(error)
return errors
@property
def plugin_manager(self) -> CondaPluginManager:
"""
This is the preferred way of accessing the ``PluginManager`` object for this application
and is located here to avoid problems with cyclical imports elsewhere in the code.
"""
from ..plugins.manager import get_plugin_manager
return get_plugin_manager()
@cached_property
def plugins(self) -> PluginConfig:
"""
Preferred way of accessing settings introduced by the settings plugin hook
"""
self.plugin_manager.load_settings()
return self.plugin_manager.get_config(self.raw_data)
@property
@deprecated(
"26.9",
"27.3",
)
def error_upload_url(self) -> str:
return self._error_upload_url
@property
@deprecated(
"26.9",
"27.3",
)
def report_errors(self) -> str:
return self._report_errors
@property
def conda_build_local_paths(self) -> tuple[PathType, ...]:
# does file system reads to make sure paths actually exist
return tuple(
unique(
full_path
for full_path in (
expand(d)
for d in (
self._croot,
self.bld_path,
self.conda_build.get("root-dir"),
join(self.root_prefix, "conda-bld"),
"~/conda-bld",
)
if d
)
if isdir(full_path)
)
)
@property
def conda_build_local_urls(self) -> tuple[str, ...]:
return tuple(path_to_url(p) for p in self.conda_build_local_paths)
@property
def croot(self) -> PathType:
"""This is where source caches and work folders live"""
if self._croot:
return abspath(expanduser(self._croot))
elif self.bld_path:
return abspath(expanduser(self.bld_path))
elif "root-dir" in self.conda_build:
return abspath(expanduser(self.conda_build["root-dir"]))
elif self.root_writable:
return join(self.root_prefix, "conda-bld")
else:
return expand("~/conda-bld")
@property
def local_build_root(self) -> PathType:
return self.croot
@property
def conda_build(self) -> dict[str, Any]:
# conda-build needs its config map to be mutable
try:
return self.__conda_build
except AttributeError:
self.__conda_build = __conda_build = dict(self._conda_build)
return __conda_build
@property
def arch_name(self) -> str:
m = platform.machine()
if m in non_x86_machines:
return m
else:
return _arch_names[self.bits]
@property
def platform(self) -> str:
return _platform_map.get(sys.platform, "unknown")
@property
def default_threads(self) -> int | None:
return self._default_threads or None
@property
def repodata_threads(self) -> int | None:
return self._repodata_threads or self.default_threads
@property
def fetch_threads(self) -> int | None:
"""
If both are not overriden (0), return experimentally-determined value of 5
"""
if self._fetch_threads == 0 and self._default_threads == 0:
return 5
return self._fetch_threads or self.default_threads
@property
def verify_threads(self) -> int | None:
if self._verify_threads:
threads = self._verify_threads
elif self.default_threads:
threads = self.default_threads
else:
threads = 1
return threads
@property
def execute_threads(self) -> int | None:
if self._execute_threads:
threads = self._execute_threads
elif self.default_threads:
threads = self.default_threads
else:
threads = 1
return threads
@property
def subdir(self) -> str: # TODO: Make KNOWN_SUBDIRS an Enum
if self._subdir:
return self._subdir
return self._native_subdir()
@cache
def _native_subdir(self) -> str:
m = platform.machine()
if m in non_x86_machines:
return f"{self.platform}-{m}"
elif self.platform == "zos":
return "zos-z"
else:
return "%s-%d" % (self.platform, self.bits)
@property
def subdirs(self) -> tuple[str, str]:
return self._subdirs or (self.subdir, "noarch")
@memoizedproperty
def known_subdirs(self) -> frozenset[str]:
return frozenset((*KNOWN_SUBDIRS, *self.subdirs))
@property
def export_platforms(self) -> tuple[str, ...]:
# detect if platforms are overridden by the user
argparse_args = dict(getattr(self, "_argparse_args", {}) or {})
if argparse_args.get("override_platforms"):
platforms = argparse_args.get("export_platforms") or ()
else:
platforms = self._export_platforms
# default to the current platform if no platforms are provided
return tuple(unique(platforms)) or (self.subdir,)
@property
def bits(self) -> int:
if self.force_32bit:
return 32
else:
return 8 * struct.calcsize("P")
@property
def root_writable(self) -> bool:
# rather than using conda.gateways.disk.test.prefix_is_writable
# let's shortcut and assume the root prefix exists
path = join(self.root_prefix, PREFIX_MAGIC_FILE)
if isfile(path):
try:
fh = open(path, "a+")
except OSError as e:
log.debug(e)
return False
else:
fh.close()
return True
return False
@property
def envs_dirs(self) -> tuple[PathType, ...]:
return mockable_context_envs_dirs(
self.root_writable, self.root_prefix, self._envs_dirs
)
@property
def pkgs_dirs(self) -> tuple[PathType, ...]:
if self._pkgs_dirs:
return tuple(dict.fromkeys(expand(p) for p in self._pkgs_dirs))
else:
cache_dir_name = "pkgs32" if context.force_32bit else "pkgs"
fixed_dirs = (
self.root_prefix,
join("~", ".conda"),
)
if on_win:
fixed_dirs += (user_data_dir(APP_NAME, APP_NAME),)
return tuple(
dict.fromkeys(expand(join(p, cache_dir_name)) for p in (fixed_dirs))
)
@memoizedproperty
def trash_dir(self) -> PathType:
# TODO: this inline import can be cleaned up by moving pkgs_dir write detection logic
from ..core.package_cache_data import PackageCacheData
pkgs_dir = PackageCacheData.first_writable().pkgs_dir
trash_dir = join(pkgs_dir, ".trash")
from ..gateways.disk.create import mkdir_p
mkdir_p(trash_dir)
return trash_dir
@property
def default_prefix(self) -> PathType:
if self.active_prefix:
return self.active_prefix
_default_env = os.getenv("CONDA_DEFAULT_ENV")
if _default_env in (None, *RESERVED_ENV_NAMES):
return self.root_prefix
elif os.sep in _default_env:
return abspath(_default_env)
else:
for envs_dir in self.envs_dirs:
default_prefix = join(envs_dir, _default_env)
if isdir(default_prefix):
return default_prefix
return join(self.envs_dirs[0], _default_env)
@property
def active_prefix(self) -> PathType:
return os.getenv("CONDA_PREFIX")
@property
def shlvl(self) -> int:
return int(os.getenv("CONDA_SHLVL", -1))
@property
def aggressive_update_packages(self) -> tuple[MatchSpec, ...]:
from ..models.match_spec import MatchSpec
return tuple(MatchSpec(s) for s in self._aggressive_update_packages)
@property
def target_prefix(self) -> PathType:
# used for the prefix that is the target of the command currently being executed
# different from the active prefix, which is sometimes given by -p or -n command line flags
return determine_target_prefix(self)
@memoizedproperty
def root_prefix(self) -> PathType:
if self._root_prefix:
return abspath(expanduser(self._root_prefix))
else:
return self.conda_prefix
@property
def conda_prefix(self) -> PathType:
return abspath(sys.prefix)
@property
@deprecated(
"23.9",
"26.3",
addendum="Please use `conda.base.context.context.conda_exe_vars_dict` instead",
)
def conda_exe(self) -> PathType:
exe = "conda.exe" if on_win else "conda"
return join(self.conda_prefix, BIN_DIRECTORY, exe)
@property
def av_data_dir(self) -> PathType:
"""Where critical artifact verification data (e.g., various public keys) can be found."""
# TODO (AV): Find ways to make this user configurable?
return join(self.conda_prefix, "etc", "conda")
@property
def signing_metadata_url_base(self) -> str | None:
"""Base URL for artifact verification signing metadata (*.root.json, key_mgr.json)."""
if self._signing_metadata_url_base:
return self._signing_metadata_url_base
else:
return None
@property
def conda_exe_vars_dict(self) -> dict[str, str | None]:
"""
The vars can refer to each other if necessary since the dict is ordered.
None means unset it.
"""
if context.dev:
if pythonpath := os.environ.get("PYTHONPATH", ""):
pythonpath = os.pathsep.join((CONDA_SOURCE_ROOT, pythonpath))
else:
pythonpath = CONDA_SOURCE_ROOT
return {
"CONDA_EXE": sys.executable,
"_CONDA_EXE": sys.executable,
# do not confuse with os.path.join, we are joining paths with ; or : delimiters
"PYTHONPATH": pythonpath,
"_CE_M": "-m",
"_CE_CONDA": "conda",
"CONDA_PYTHON_EXE": sys.executable,
"_CONDA_ROOT": self.conda_prefix,
}
else:
exe = os.path.join(
self.conda_prefix,
BIN_DIRECTORY,
"conda.exe" if on_win else "conda",
)
return {
"CONDA_EXE": exe,
"_CONDA_EXE": exe,
"_CE_M": None,
"_CE_CONDA": None,
"CONDA_PYTHON_EXE": sys.executable,
"_CONDA_ROOT": self.conda_prefix,
}
@memoizedproperty
def channel_alias(self) -> Channel:
from ..models.channel import Channel
location, scheme, auth, token = split_scheme_auth_token(self._channel_alias)
return Channel(scheme=scheme, auth=auth, location=location, token=token)
@property
def migrated_channel_aliases(self) -> tuple[Channel, ...]:
from ..models.channel import Channel
return tuple(
Channel(scheme=scheme, auth=auth, location=location, token=token)
for location, scheme, auth, token in (
split_scheme_auth_token(c) for c in self._migrated_channel_aliases
)
)
@property
def prefix_specified(self) -> bool:
return (
self._argparse_args.get("prefix") is not None
or self._argparse_args.get("name") is not None
)
@memoizedproperty
def default_channels(self) -> list[Channel]:
# the format for 'default_channels' is a list of strings that either
# - start with a scheme
# - are meant to be prepended with channel_alias
return self.custom_multichannels[DEFAULTS_CHANNEL_NAME]
@memoizedproperty
def custom_multichannels(self) -> dict[str, tuple[Channel, ...]]:
from ..models.channel import Channel
if (
not on_win
and self.subdir.startswith("win-")
and self._default_channels == DEFAULT_CHANNELS_UNIX
):
default_channels = list(DEFAULT_CHANNELS_WIN)
else:
default_channels = list(self._default_channels)
return {
name: tuple(
Channel.make_simple_channel(self.channel_alias, url) for url in urls
)
for name, urls in {
# order matters
DEFAULTS_CHANNEL_NAME: default_channels, # default_channels is a legacy keyword
**self._custom_multichannels, # custom_multichannels.defaults overrides default_channels
"local": self.conda_build_local_urls, # always last, local is a reserved name and cannot be overridden
}.items()
}
@memoizedproperty
def custom_channels(self) -> dict[str, Channel]:
from ..models.channel import Channel
return {
channel.name: channel
for channel in (
*chain.from_iterable(
channel for channel in self.custom_multichannels.values()
),
*(
Channel.make_simple_channel(self.channel_alias, url, name)
for name, url in self._custom_channels.items()
),
)
}
@property
def channels(self) -> tuple[str, ...]:
local_channels = ("local",) if self.use_local else ()
argparse_args = dict(getattr(self, "_argparse_args", {}) or {})
# TODO: it's args.channel right now, not channels
cli_channels = argparse_args.get("channel") or ()
if argparse_args.get("override_channels"):
if not self.override_channels_enabled:
from ..exceptions import OperationNotAllowed
raise OperationNotAllowed("Overriding channels has been disabled.")
if cli_channels:
return validate_channels((*local_channels, *cli_channels))
else:
from ..exceptions import ArgumentError
raise ArgumentError(
"At least one -c / --channel flag must be supplied when using "
"--override-channels."
)
return validate_channels((*local_channels, *self._channels))
@property
def config_files(self) -> tuple[PathType, ...]:
return tuple(
path
for path in context.collect_all()
if path not in (ENV_VARS_SOURCE, CMD_LINE_SOURCE)
)
@property
def use_only_tar_bz2(self) -> bool:
# we avoid importing this at the top to avoid PATH issues. Ensure that this
# is only called when use_only_tar_bz2 is first called.
import conda_package_handling.api
return (
not conda_package_handling.api.libarchive_enabled
) or self._use_only_tar_bz2
@property
def binstar_upload(self) -> bool | None:
# backward compatibility for conda-build
return self.anaconda_upload
@property
def trace(self) -> bool:
"""Alias for context.verbosity >=4."""
return self.verbosity >= 4
@property
def debug(self) -> bool:
"""Alias for context.verbosity >=3."""
return self.verbosity >= 3
@property
def info(self) -> bool:
"""Alias for context.verbosity >=2."""
return self.verbosity >= 2
@property
def verbose(self) -> bool:
"""Alias for context.verbosity >=1."""
return self.verbosity >= 1
@property
def verbosity(self) -> int:
"""Verbosity level.
For cleaner and readable code it is preferable to use the following alias properties:
context.trace
context.debug
context.info
context.verbose
context.log_level
"""
# 0 → logging.WARNING, standard output
# -v = 1 → logging.WARNING, detailed output
# -vv = 2 → logging.INFO
# --debug = -vvv = 3 → logging.DEBUG
# --trace = -vvvv = 4 → conda.gateways.logging.TRACE
if self._trace:
return 4
elif self._debug:
return 3
else:
return self._verbosity
@property
def log_level(self) -> int:
"""Map context.verbosity to logging level."""
if 4 < self.verbosity:
return logging.NOTSET # 0
elif 3 < self.verbosity <= 4:
return TRACE # 5
elif 2 < self.verbosity <= 3:
return logging.DEBUG # 10
elif 1 < self.verbosity <= 2:
return logging.INFO # 20
else:
return logging.WARNING # 30
@property
def override_virtual_packages(self) -> dict[str, str | None]:
"""Remove any dunders in the virtual_package name keys"""
return {
name.removeprefix("__"): value
for name, value in self._override_virtual_packages.items()
}
def solver_user_agent(self) -> str:
user_agent = f"solver/{self.solver}"
try:
solver_backend = self.plugin_manager.get_cached_solver_backend()
# Solver.user_agent has to be a static or class method
user_agent += f" {solver_backend.user_agent()}"
except Exception as exc:
log.debug(
"User agent could not be fetched from solver class '%s'.",
self.solver,
exc_info=exc,
)
return user_agent
@memoizedproperty
def user_agent(self) -> str:
builder = [f"conda/{CONDA_VERSION} requests/{self.requests_version}"]
builder.append("{}/{}".format(*self.python_implementation_name_version))
builder.append("{}/{}".format(*self.platform_system_release))
builder.append("{}/{}".format(*self.os_distribution_name_version))
if self.libc_family_version[0]:
builder.append("{}/{}".format(*self.libc_family_version))
if self.solver != "classic":
builder.append(self.solver_user_agent())
return " ".join(builder)
@contextmanager
def _override(self, key: str, value: Any) -> Iterator[None]:
"""
TODO: This might be broken in some ways. Unsure what happens if the `old`
value is a property and gets set to a new value. Or if the new value
overrides the validation logic on the underlying ParameterLoader instance.
Investigate and implement in a safer way.
"""
old = getattr(self, key)
setattr(self, key, value)
try:
yield
finally:
setattr(self, key, old)
@memoizedproperty
def requests_version(self) -> str:
# used in User-Agent as "requests/<version>"
# if unable to detect a version we expect "requests/unknown"
try:
from requests import __version__ as requests_version
except ImportError as err:
# ImportError: requests is not installed
log.error("Unable to import requests: %s", err)
requests_version = "unknown"
except Exception as err:
log.error("Error importing requests: %s", err)
requests_version = "unknown"
return requests_version
@memoizedproperty
def python_implementation_name_version(self) -> tuple[str, str]:
# CPython, Jython
# '2.7.14'
return platform.python_implementation(), platform.python_version()
@memoizedproperty
def platform_system_release(self) -> tuple[str, str]:
# tuple of system name and release version
#
# `uname -s` Linux, Windows, Darwin, Java
#
# `uname -r`
# '17.4.0' for macOS
# '10' or 'NT' for Windows
return platform.system(), platform.release()
@memoizedproperty
def os_distribution_name_version(self) -> tuple[str, str]:
# tuple of os distribution name and version
# e.g.
# 'debian', '9'
# 'OSX', '10.13.6'
# 'Windows', '10.0.17134'
platform_name = self.platform_system_release[0]
if platform_name == "Linux":
try:
import distro
distinfo = distro.id(), distro.version(best=True)
except Exception as e:
log.debug("%r", e, exc_info=True)
distinfo = ("Linux", "unknown")
distribution_name, distribution_version = distinfo[0], distinfo[1]
elif platform_name == "Darwin":
distribution_name = "OSX"
distribution_version = mac_ver()
else:
distribution_name = platform_name
distribution_version = platform.version()
return distribution_name, distribution_version
@memoizedproperty
def libc_family_version(self) -> tuple[str | None, str | None]:
# tuple of lic_family and libc_version
# None, None if not on Linux
libc_family, libc_version = linux_get_libc_version()
return libc_family, libc_version
@property
def console(self) -> str:
if self.json:
return DEFAULT_JSON_REPORTER_BACKEND
return self._console
@property
@deprecated(
"25.9",
"26.3",
addendum="Please use `conda.base.context.context.auto_activate` instead",
)
def auto_activate_base(self) -> bool:
return self.auto_activate
@property
def default_activation_env(self) -> str:
return self._default_activation_env or ROOT_ENV_NAME
@property
def create_default_packages(self) -> tuple[str, ...]:
"""Returns a list of `create_default_packages`, removing any explicit packages."""
from ..common.io import dashlist
grouped_packages = groupby_to_dict(
lambda x: "explicit"
if context.plugin_manager.has_package_extension(x)
else "spec",
sequence=self._create_default_packages,
)
if grouped_packages.get("explicit", None):
warnings.warn(
f"Ignoring invalid packages in `create_default_packages`: {dashlist(grouped_packages.get('explicit'))}\n"
f"\n"
f"Explicit package are not allowed, use package names like 'numpy' or specs like 'numpy>=1.20' instead.\n"
f"Try using the command `conda config --show-sources` to verify your conda configuration.\n",
UserWarning,
)
return tuple(grouped_packages.get("spec", []))
@property
def default_activation_prefix(self) -> Path:
"""Return the prefix of the default_activation_env.
If the default_activation_env is an environment name, get the corresponding
prefix; otherwise it is already a prefix, so just return it.
:return: Prefix of the default_activation_env
"""
from ..exceptions import EnvironmentNameNotFound
try:
return Path(locate_prefix_by_name(self.default_activation_env))
except EnvironmentNameNotFound:
return Path(self.default_activation_env)
@property
def environment_context_keys(self) -> list[str]:
return [
"aggressive_update_packages",
"channel_priority",
"channels",
"channel_settings",
"custom_channels",
"custom_multichannels",
"deps_modifier",
"disallowed_packages",
"pinned_packages",
"repodata_fns",
"sat_solver",
"solver",
"track_features",
"update_modifier",
"use_only_tar_bz2",
]
@property
def environment_settings(self) -> dict[str, Any]:
"""Returns a dict of environment related settings"""
return {key: getattr(self, key) for key in self.environment_context_keys}
@property
def category_map(self) -> dict[str, tuple[str, ...]]:
return {
"Channel Configuration": (
"channels",
"channel_alias",
"channel_settings",
"default_channels",
"override_channels_enabled",
"allowlist_channels",
"denylist_channels",
"custom_channels",
"custom_multichannels",
"migrated_channel_aliases",
"migrated_custom_channels",
"add_anaconda_token",
"allow_non_channel_urls",
"repodata_fns",
"use_only_tar_bz2",
"repodata_threads",
"fetch_threads",
"experimental",
"no_lock",
"repodata_use_zst",
),
"Basic Conda Configuration": ( # TODO: Is there a better category name here?
"envs_dirs",
"pkgs_dirs",
"default_threads",
),
"Network Configuration": (
"client_ssl_cert",
"client_ssl_cert_key",
"local_repodata_ttl",
"offline",
"proxy_servers",
"remote_connect_timeout_secs",
"remote_max_retries",
"remote_backoff_factor",
"remote_read_timeout_secs",
"ssl_verify",
),
"Solver Configuration": (
"aggressive_update_packages",
"auto_update_conda",
"channel_priority",
"create_default_packages",
"disallowed_packages",
"force_reinstall",
"pinned_packages",
"prefix_data_interoperability",
"track_features",
"solver",
),
"Package Linking and Install-time Configuration": (
"allow_softlinks",
"always_copy",
"always_softlink",
"path_conflict",
"rollback_enabled",
"safety_checks",
"extra_safety_checks",
"signing_metadata_url_base",
"shortcuts",
"shortcuts_only",
"non_admin_enabled",
"separate_format_cache",
"verify_threads",
"execute_threads",
),
"Conda-build Configuration": (
"bld_path",
"croot",
"anaconda_upload",
"conda_build",
),
"Output, Prompt, and Flow Control Configuration": (
"always_yes",
"auto_activate",
"default_activation_env",
"auto_stack",
"changeps1",
"env_prompt",
"json",
"console",
"notify_outdated_conda",
"quiet",
"report_errors",
"show_channel_urls",
"list_fields",
"verbosity",
"unsatisfiable_hints",
"unsatisfiable_hints_check_depth",
"number_channel_notices",
"envvars_force_uppercase",
"export_platforms",
"override_virtual_packages",
),
"CLI-only": (
"deps_modifier",
"update_modifier",
"force",
"force_remove",
"clobber",
"dry_run",
"download_only",
"ignore_pinned",
"use_index_cache",
"use_local",
),
"Hidden and Undocumented": (
"allow_cycles", # allow cyclical dependencies, or raise
"allow_conda_downgrades",
"add_pip_as_python_dependency",
"debug",
"trace",
"dev",
"default_python",
"enable_private_envs",
"error_upload_url", # TODO: Remove after deprecation ended
"force_32bit",
"root_prefix",
"sat_solver",
"solver_ignore_timestamps",
"subdir",
"subdirs",
# https://conda.io/docs/config.html#disable-updating-of-dependencies-update-dependencies
# I don't think this documentation is correct any longer.
"target_prefix_override",
# used to override prefix rewriting, for e.g. building docker containers or RPMs
"register_envs",
# whether to add the newly created prefix to ~/.conda/environments.txt
"protect_frozen_envs",
# prevent modifications to envs marked with conda-meta/frozen
),
"Plugin Configuration": ("no_plugins",),
"Experimental": ("environment_specifier",),
}
def get_descriptions(self) -> dict[str, str]:
return self.description_map
@memoizedproperty
def description_map(self) -> dict[str, str]:
return frozendict(
add_anaconda_token=dals(
"""
In conjunction with the anaconda command-line client (installed with
`conda install anaconda-client`), and following logging into an Anaconda
Server API site using `anaconda login`, automatically apply a matching
private token to enable access to private packages and channels.
"""
),
# add_pip_as_python_dependency=dals(
# """
# Add pip, wheel and setuptools as dependencies of python. This ensures pip,
# wheel and setuptools will always be installed any time python is installed.
# """
# ),
aggressive_update_packages=dals(
"""
A list of packages that, if installed, are always updated to the latest possible
version.
"""
),
allow_non_channel_urls=dals(
"""
Warn, but do not fail, when conda detects a channel url is not a valid channel.
"""
),
allow_softlinks=dals(
"""
When allow_softlinks is True, conda uses hard-links when possible, and soft-links
(symlinks) when hard-links are not possible, such as when installing on a
different filesystem than the one that the package cache is on. When
allow_softlinks is False, conda still uses hard-links when possible, but when it
is not possible, conda copies files. Individual packages can override
this setting, specifying that certain files should never be soft-linked (see the
no_link option in the build recipe documentation).
"""
),
always_copy=dals(
"""
Register a preference that files be copied into a prefix during install rather
than hard-linked.
"""
),
always_softlink=dals(
"""
Register a preference that files be soft-linked (symlinked) into a prefix during
install rather than hard-linked. The link source is the 'pkgs_dir' package cache
from where the package is being linked. WARNING: Using this option can result in
corruption of long-lived conda environments. Package caches are *caches*, which
means there is some churn and invalidation. With this option, the contents of
environments can be switched out (or erased) via operations on other environments.
"""
),
always_yes=dals(
"""
Automatically choose the 'yes' option whenever asked to proceed with a conda
operation, such as when running `conda install`.
"""
),
anaconda_upload=dals(
"""
Automatically upload packages built with conda build to anaconda.org.
"""
),
auto_activate=dals(
"""
Automatically activate the environment given at 'default_activation_env'
during shell initialization.
"""
),
auto_update_conda=dals(
"""
Automatically update conda when a newer or higher priority version is detected.
"""
),
auto_stack=dals(
"""
Implicitly use --stack when using activate if current level of nesting
(as indicated by CONDA_SHLVL environment variable) is less than or equal to
specified value. 0 or false disables automatic stacking, 1 or true enables
it for one level.
"""
),
bld_path=dals(
"""
The location where conda-build will put built packages. Same as 'croot', but
'croot' takes precedence when both are defined. Also used in construction of the
'local' multichannel.
"""
),
changeps1=dals(
"""
When using activate, change the command prompt ($PS1) to include the
activated environment.
"""
),
channel_alias=dals(
"""
The prepended url location to associate with channel names.
"""
),
channel_priority=dals(
"""
Accepts values of 'strict', 'flexible', and 'disabled'. The default value
is 'flexible'. With strict channel priority, packages in lower priority channels
are not considered if a package with the same name appears in a higher
priority channel. With flexible channel priority, the solver may reach into
lower priority channels to fulfill dependencies, rather than raising an
unsatisfiable error. With channel priority disabled, package version takes
precedence, and the configured priority of channels is used only to break ties.
In previous versions of conda, this parameter was configured as either True or
False. True is now an alias to 'flexible'.
"""
),
channels=dals(
"""
The list of conda channels to include for relevant operations.
"""
),
channel_settings=dals(
"""
A list of mappings that allows overriding certain settings for a single channel.
Each list item should include at least the "channel" key and the setting you would
like to override.
"""
),
client_ssl_cert=dals(
"""
A path to a single file containing a private key and certificate (e.g. .pem
file). Alternately, use client_ssl_cert_key in conjunction with client_ssl_cert
for individual files.
"""
),
client_ssl_cert_key=dals(
"""
Used in conjunction with client_ssl_cert for a matching key file.
"""
),
# clobber=dals(
# """
# Allow clobbering of overlapping file paths within packages, and suppress
# related warnings. Overrides the path_conflict configuration value when
# set to 'warn' or 'prevent'.
# """
# ),
# TODO: add shortened link to docs for conda_build at See https://conda.io/docs/user-guide/configuration/use-condarc.html#conda-build-configuration
conda_build=dals(
"""
General configuration parameters for conda-build.
"""
),
# TODO: This is a bad parameter name. Consider an alternate.
create_default_packages=dals(
"""
Packages that are by default added to a newly created environments.
"""
),
croot=dals(
"""
The location where conda-build will put built packages. Same as 'bld_path', but
'croot' takes precedence when both are defined. Also used in construction of the
'local' multichannel.
"""
),
custom_channels=dals(
"""
A map of key-value pairs where the key is a channel name and the value is
a channel location. Channels defined here override the default
'channel_alias' value. The channel name (key) is not included in the channel
location (value). For example, to override the location of the 'conda-forge'
channel where the url to repodata is
https://anaconda-repo.dev/packages/conda-forge/linux-64/repodata.json, add an
entry 'conda-forge: https://anaconda-repo.dev/packages'.
"""
),
custom_multichannels=dals(
"""
A multichannel is a metachannel composed of multiple channels. The only reserved
multichannel is 'local', which is a list of file:// channel locations where
conda-build stashes successfully-built packages and cannot be overridden.
Other multichannels, including 'defaults', can be defined or customized with
custom_multichannels, where the key is the multichannel name and the value is
a list of channel names and/or channel urls. The 'defaults' multichannel can
also be customized using the 'default_channels' parameter (a historical setting
from when 'defaults' was reserved). If both are defined,
'custom_multichannels.defaults' takes precedence.
"""
),
default_activation_env=dals(
"""
The environment to be automatically activated on startup if 'auto_activate'
is True. Also sets the default environment to activate when 'conda activate'
receives no arguments.
"""
),
default_channels=dals(
"""
The list of channel names and/or urls used for the 'defaults' multichannel.
Can be overridden by 'custom_multichannels.defaults'.
"""
),
# default_python=dals(
# """
# specifies the default major & minor version of Python to be used when
# building packages with conda-build. Also used to determine the major
# version of Python (2/3) to be used in new environments. Defaults to
# the version used by conda itself.
# """
# ),
default_threads=dals(
"""
Threads to use by default for parallel operations. Default is None,
which allows operations to choose themselves. For more specific
control, see the other *_threads parameters:
* repodata_threads - for fetching/loading repodata
* verify_threads - for verifying package contents in transactions
* execute_threads - for carrying out the unlinking and linking steps
"""
),
disallowed_packages=dals(
"""
Package specifications to disallow installing. The default is to allow
all packages.
"""
),
download_only=dals(
"""
Solve an environment and ensure package caches are populated, but exit
prior to unlinking and linking packages into the prefix
"""
),
envs_dirs=dals(
"""
The list of directories to search for named environments. When creating a new
named environment, the environment will be placed in the first writable
location.
"""
),
env_prompt=dals(
"""
Template for prompt modification based on the active environment. Currently
supported template variables are '{prefix}', '{name}', and '{default_env}'.
'{prefix}' is the absolute path to the active environment. '{name}' is the
basename of the active environment prefix. '{default_env}' holds the value
of '{name}' if the active environment is a conda named environment ('-n'
flag), or otherwise holds the value of '{prefix}'. Templating uses python's
str.format() method.
"""
),
environment_specifier=dals(
"""
**EXPERIMENTAL** While experimental, expect both major and minor changes across minor releases.
The name of the environment specifier plugin that should be used for this context.
If not specified, the plugin manager will try to detect the plugin to use.
"""
),
execute_threads=dals(
"""
Threads to use when performing the unlink/link transaction. When not set,
defaults to 1. This step is pretty strongly I/O limited, and you may not
see much benefit here.
"""
),
export_platforms=dals(
"""
Additional platform(s)/subdir(s) for export (e.g., linux-64, osx-64, win-64), current
platform is always included.
"""
),
fetch_threads=dals(
"""
Threads to use when downloading packages. When not set,
defaults to None, which uses the default ThreadPoolExecutor behavior.
"""
),
force_reinstall=dals(
"""
Ensure that any user-requested package for the current operation is uninstalled
and reinstalled, even if that package already exists in the environment.
"""
),
# force=dals(
# """
# Override any of conda's objections and safeguards for installing packages and
# potentially breaking environments. Also re-installs the package, even if the
# package is already installed. Implies --no-deps.
# """
# ),
# force_32bit=dals(
# """
# CONDA_FORCE_32BIT should only be used when running conda-build (in order
# to build 32-bit packages on a 64-bit system). We don't want to mention it
# in the documentation, because it can mess up a lot of things.
# """
# ),
json=dals(
"""
Ensure all output written to stdout is structured json.
"""
),
list_fields=dals(
"""
Default fields to report as columns in the output of `conda list`.
"""
),
local_repodata_ttl=dals(
"""
For a value of False or 0, always fetch remote repodata (HTTP 304 responses
respected). For a value of True or 1, respect the HTTP Cache-Control max-age
header. Any other positive integer values is the number of seconds to locally
cache repodata before checking the remote server for an update.
"""
),
migrated_channel_aliases=dals(
"""
A list of previously-used channel_alias values. Useful when switching between
different Anaconda Repository instances.
"""
),
migrated_custom_channels=dals(
"""
A map of key-value pairs where the key is a channel name and the value is
the previous location of the channel.
"""
),
# no_deps=dals(
# """
# Do not install, update, remove, or change dependencies. This WILL lead to broken
# environments and inconsistent behavior. Use at your own risk.
# """
# ),
no_plugins=dals(
"""
Disable all currently-registered plugins, except built-in conda plugins.
"""
),
non_admin_enabled=dals(
"""
Allows completion of conda's create, install, update, and remove operations, for
non-privileged (non-root or non-administrator) users.
"""
),
notify_outdated_conda=dals(
"""
Notify if a newer version of conda is detected during a create, install, update,
or remove operation.
"""
),
offline=dals(
"""
Restrict conda to cached download content and file:// based urls.
"""
),
override_channels_enabled=dals(
"""
Permit use of the --override-channels command-line flag.
"""
),
path_conflict=dals(
"""
The method by which conda handle's conflicting/overlapping paths during a
create, install, or update operation. The value must be one of 'clobber',
'warn', or 'prevent'. The '--clobber' command-line flag or clobber
configuration parameter overrides path_conflict set to 'prevent'.
"""
),
pinned_packages=dals(
"""
A list of package specs to pin for every environment resolution.
This parameter is in BETA, and its behavior may change in a future release.
"""
),
prefix_data_interoperability=dals(
"""
Enable plugins to allow conda to interact with non-conda-installed packages.
"""
),
pkgs_dirs=dals(
"""
The list of directories where locally-available packages are linked from at
install time. Packages not locally available are downloaded and extracted
into the first writable directory.
"""
),
proxy_servers=dals(
"""
A mapping to enable proxy settings. Keys can be either (1) a scheme://hostname
form, which will match any request to the given scheme and exact hostname, or
(2) just a scheme, which will match requests to that scheme. Values are are
the actual proxy server, and are of the form
'scheme://[user:password@]host[:port]'. The optional 'user:password' inclusion
enables HTTP Basic Auth with your proxy.
"""
),
quiet=dals(
"""
Disable progress bar display and other output.
"""
),
remote_connect_timeout_secs=dals(
"""
The number seconds conda will wait for your client to establish a connection
to a remote url resource.
"""
),
remote_max_retries=dals(
"""
The maximum number of retries each HTTP connection should attempt.
"""
),
remote_backoff_factor=dals(
"""
The factor determines the time HTTP connection should wait for attempt.
"""
),
remote_read_timeout_secs=dals(
"""
Once conda has connected to a remote resource and sent an HTTP request, the
read timeout is the number of seconds conda will wait for the server to send
a response.
"""
),
repodata_threads=dals(
"""
Threads to use when downloading and reading repodata. When not set,
defaults to None, which uses the default ThreadPoolExecutor behavior.
"""
),
report_errors=dals(
"""
Opt in, or opt out, of automatic error reporting to core maintainers. Error
reports are anonymous, with only the error stack trace and information given
by `conda info` being sent.
"""
),
rollback_enabled=dals(
"""
Should any error occur during an unlink/link transaction, revert any disk
mutations made to that point in the transaction.
"""
),
safety_checks=dals(
"""
Enforce available safety guarantees during package installation.
The value must be one of 'enabled', 'warn', or 'disabled'.
"""
),
separate_format_cache=dals(
"""
Treat .tar.bz2 files as different from .conda packages when
filenames are otherwise similar. This defaults to False, so
that your package cache doesn't churn when rolling out the new
package format. If you'd rather not assume that a .tar.bz2 and
.conda from the same place represent the same content, set this
to True.
"""
),
extra_safety_checks=dals(
"""
Spend extra time validating package contents. Currently, runs sha256 verification
on every file within each package during installation.
"""
),
signing_metadata_url_base=dals(
"""
Base URL for obtaining trust metadata updates (i.e., the `*.root.json` and
`key_mgr.json` files) used to verify metadata and (eventually) package signatures.
"""
),
shortcuts=dals(
"""
Allow packages to create OS-specific shortcuts (e.g. in the Windows Start
Menu) at install time.
"""
),
shortcuts_only=dals(
"""
Create shortcuts only for the specified package names.
"""
),
show_channel_urls=dals(
"""
Show channel URLs when displaying what is going to be downloaded.
"""
),
ssl_verify=dals(
"""
Conda verifies SSL certificates for HTTPS requests, just like a web
browser. By default, SSL verification is enabled, and conda operations will
fail if a required url's certificate cannot be verified. Setting ssl_verify to
False disables certification verification. The value for ssl_verify can also
be (1) a path to a CA bundle file, (2) a path to a directory containing
certificates of trusted CA, or (3) 'truststore' to use the
operating system certificate store.
"""
),
track_features=dals(
"""
A list of features that are tracked by default. An entry here is similar to
adding an entry to the create_default_packages list.
"""
),
repodata_fns=dals(
"""
Specify filenames for repodata fetching. The default is ('current_repodata.json',
'repodata.json'), which tries a subset of the full index containing only the
latest version for each package, then falls back to repodata.json. You may
want to specify something else to use an alternate index that has been reduced
somehow.
"""
),
use_index_cache=dals(
"""
Use cache of channel index files, even if it has expired.
"""
),
use_only_tar_bz2=dals(
"""
A boolean indicating that only .tar.bz2 conda packages should be downloaded.
This is forced to True if conda-build is installed and older than 3.18.3,
because older versions of conda break when conda feeds it the new file format.
"""
),
verbosity=dals(
"""
Sets output log level. 0 is warn. 1 is info. 2 is debug. 3 is trace.
"""
),
verify_threads=dals(
"""
Threads to use when performing the transaction verification step. When not set,
defaults to 1.
"""
),
allowlist_channels=dals(
"""
The exclusive list of channels allowed to be used on the system. Use of any
other channels will result in an error. If conda-build channels are to be
allowed, along with the --use-local command line flag, be sure to include the
'local' channel in the list. If the list is empty or left undefined, no
channel exclusions will be enforced.
"""
),
denylist_channels=dals(
"""
The list of channels that are denied to be used on the system. Use of any
of these channels will result in an error. If conda-build channels are to be
allowed, along with the --use-local command line flag, be sure to not include
the 'local' channel in the list. If the list is empty or left undefined, no
channel exclusions will be enforced.
"""
),
unsatisfiable_hints=dals(
"""
A boolean to determine if conda should find conflicting packages in the case
of a failed install.
"""
),
unsatisfiable_hints_check_depth=dals(
"""
An integer that specifies how many levels deep to search for unsatisfiable
dependencies. If this number is 1 it will complete the unsatisfiable hints
fastest (but perhaps not the most complete). The higher this number, the
longer the generation of the unsat hint will take. Defaults to 3.
"""
),
solver=dals(
"""
A string to choose between the different solver logics implemented in
conda. A solver logic takes care of turning your requested packages into a
list of specs to add and/or remove from a given environment, based on their
dependencies and specified constraints.
"""
),
number_channel_notices=dals(
"""
Sets the number of channel notices to be displayed when running commands
the "install", "create", "update", "env create", and "env update" . Defaults
to 5. In order to completely suppress channel notices, set this to 0.
"""
),
experimental=dals(
"""
List of experimental features to enable.
"""
),
no_lock=dals(
"""
Disable index cache lock (defaults to enabled).
"""
),
repodata_use_zst=dals(
"""
Disable check for `repodata.json.zst`; use `repodata.json` only.
"""
),
envvars_force_uppercase=dals(
"""
Force uppercase for new environment variable names. Defaults to True.
"""
),
console=dals(
f"""
Configure different backends to be used while rendering normal console output.
Defaults to "{DEFAULT_CONSOLE_REPORTER_BACKEND}".
"""
),
override_virtual_packages=dals(
"""
Set override values for virtual packages.
"""
),
)
def reset_context(
search_path: PathsType = SEARCH_PATH,
argparse_args: Namespace | None = None,
) -> Context:
global context
# remove plugin config params
from ..plugins.config import PluginConfig
PluginConfig.remove_all_plugin_settings()
YamlRawParameter.cache_clear()
context.__init__(search_path, argparse_args)
context.__dict__.pop("_Context__conda_build", None)
from ..models.channel import Channel
Channel._reset_state()
# need to import here to avoid circular dependency
# clear function cache
from ..reporters import _get_render_func
# reload plugin config params
with suppress(AttributeError):
del context.plugins
_get_render_func.cache_clear()
return context
@contextmanager
def fresh_context(
env: dict[str, str] | None = None,
search_path: PathsType = SEARCH_PATH,
argparse_args: Namespace | None = None,
**kwargs,
) -> Iterator[Context]:
if env or kwargs:
old_env = os.environ.copy()
os.environ.update(env or {})
os.environ.update(kwargs)
yield reset_context(search_path=search_path, argparse_args=argparse_args)
if env or kwargs:
os.environ.clear()
os.environ.update(old_env)
reset_context()
class ContextStackObject:
def __init__(
self,
search_path: PathsType = SEARCH_PATH,
argparse_args: Namespace | None = None,
):
self.set_value(search_path, argparse_args)
def set_value(
self,
search_path: PathsType = SEARCH_PATH,
argparse_args: Namespace | None = None,
) -> None:
self.search_path = search_path
self.argparse_args = argparse_args
def apply(self):
reset_context(self.search_path, self.argparse_args)
class ContextStack:
def __init__(self):
self._stack = [ContextStackObject() for _ in range(3)]
self._stack_idx = 0
self._last_search_path = None
self._last_argparse_args = None
def push(self, search_path: PathsType, argparse_args: Namespace | None) -> None:
self._stack_idx += 1
old_len = len(self._stack)
if self._stack_idx >= old_len:
self._stack.extend([ContextStackObject() for _ in range(old_len)])
self._stack[self._stack_idx].set_value(search_path, argparse_args)
self.apply()
def apply(self):
if (
self._last_search_path != self._stack[self._stack_idx].search_path
or self._last_argparse_args != self._stack[self._stack_idx].argparse_args
):
# Expensive:
self._stack[self._stack_idx].apply()
self._last_search_path = self._stack[self._stack_idx].search_path
self._last_argparse_args = self._stack[self._stack_idx].argparse_args
def pop(self):
self._stack_idx -= 1
self._stack[self._stack_idx].apply()
def replace(self, search_path: PathsType, argparse_args: Namespace | None) -> None:
self._stack[self._stack_idx].set_value(search_path, argparse_args)
self._stack[self._stack_idx].apply()
context_stack = ContextStack()
def stack_context(
pushing: bool,
search_path: PathsType = SEARCH_PATH,
argparse_args: Namespace | None = None,
) -> None:
if pushing:
# Fast
context_stack.push(search_path, argparse_args)
else:
# Slow
context_stack.pop()
# Default means "The configuration when there are no condarc files present". It is
# all the settings and defaults that are built in to the code and *not* the default
# value of search_path=SEARCH_PATH. It means search_path=().
def stack_context_default(
pushing: bool,
argparse_args: Namespace | None = None,
) -> None:
return stack_context(pushing, search_path=(), argparse_args=argparse_args)
def replace_context(
pushing: bool | None = None,
search_path: Iterable[str] = SEARCH_PATH,
argparse_args: Namespace | None = None,
) -> None:
# pushing arg intentionally not used here, but kept for API compatibility
return context_stack.replace(search_path, argparse_args)
def replace_context_default(
pushing: bool | None = None,
argparse_args: Namespace | None = None,
) -> None:
# pushing arg intentionally not used here, but kept for API compatibility
return context_stack.replace(search_path=(), argparse_args=argparse_args)
# Tests that want to only declare 'I support the project-wide default for how to
# manage stacking of contexts'. Tests that are known to be careful with context
# can use `replace_context_default` which might be faster, though it should
# be a stated goal to set conda_tests_ctxt_mgmt_def_pol to replace_context_default
# and not to stack_context_default.
conda_tests_ctxt_mgmt_def_pol = replace_context_default
def env_name(prefix: PathType) -> PathType | str | None:
# counter part to `locate_prefix_by_name()` below
if not prefix:
return None
if paths_equal(prefix, context.root_prefix):
return ROOT_ENV_NAME
maybe_envs_dir, maybe_name = path_split(prefix)
for envs_dir in context.envs_dirs:
if paths_equal(envs_dir, maybe_envs_dir):
return maybe_name
return prefix
def locate_prefix_by_name(name: str, envs_dirs: PathsType | None = None) -> PathType:
"""Find the location of a prefix given a conda env name. If the location does not exist, an
error is raised. If the prefix is the base or root env, the root prefix is returned.
"""
if not name:
raise ValueError("'name' cannot be empty.")
if name in RESERVED_ENV_NAMES:
return context.root_prefix
if envs_dirs is None:
envs_dirs = context.envs_dirs
for envs_dir in envs_dirs:
if not isdir(envs_dir):
continue
prefix = join(envs_dir, name)
if isdir(prefix):
return abspath(prefix)
from ..exceptions import EnvironmentNameNotFound
raise EnvironmentNameNotFound(name)
def validate_channels(channels: Iterator[str]) -> tuple[str, ...]:
"""
Validate if the given channel URLs are allowed based on the context's allowlist
and denylist configurations.
:param channels: A list of channels (either URLs or names) to validate.
:raises ChannelNotAllowed: If any URL is not in the allowlist.
:raises ChannelDenied: If any URL is in the denylist.
"""
from ..exceptions import ChannelDenied, ChannelNotAllowed
from ..models.channel import Channel
allowlist = [
url
for channel in context.allowlist_channels
for url in Channel(channel).base_urls
]
denylist = [
url
for channel in context.denylist_channels
for url in Channel(channel).base_urls
]
if allowlist or denylist:
for channel in map(Channel, channels):
for url in channel.base_urls:
if url in denylist:
raise ChannelDenied(channel)
if allowlist and url not in allowlist:
raise ChannelNotAllowed(channel)
return tuple(
channel
for channel in dict.fromkeys(channels)
if Channel(channel).canonical_name != UNKNOWN_CHANNEL
)
@deprecated(
"25.9", "26.3", addendum="Use PrefixData.validate_name() + PrefixData.from_name()"
)
def validate_prefix_name(
prefix_name: str, ctx: Context, allow_base: bool = True
) -> PathType:
"""Run various validations to make sure prefix_name is valid"""
from ..exceptions import CondaValueError
if PREFIX_NAME_DISALLOWED_CHARS.intersection(prefix_name):
raise CondaValueError(
dals(
f"""
Invalid environment name: {prefix_name!r}
Characters not allowed: {PREFIX_NAME_DISALLOWED_CHARS}
If you are specifying a path to an environment, the `-p`
flag should be used instead.
"""
)
)
if prefix_name in RESERVED_ENV_NAMES:
if allow_base:
return ctx.root_prefix
else:
raise CondaValueError(
"Use of 'base' as environment name is not allowed here."
)
else:
from ..exceptions import EnvironmentNameNotFound
from ..gateways.disk.create import first_writable_envs_dir
try:
return locate_prefix_by_name(prefix_name)
except EnvironmentNameNotFound:
return join(first_writable_envs_dir(), prefix_name)
def determine_target_prefix(ctx: Context, args: Namespace | None = None) -> PathType:
"""Get the prefix to operate in. The prefix may not yet exist.
Args:
ctx: the context of conda
args: the argparse args from the command line
Returns: the prefix
Raises: CondaEnvironmentNotFoundError if the prefix is invalid
"""
argparse_args = args or ctx._argparse_args
try:
prefix_name = argparse_args.name
except AttributeError:
prefix_name = None
try:
prefix_path = argparse_args.prefix
except AttributeError:
prefix_path = None
if prefix_name is not None and not prefix_name.strip(): # pragma: no cover
from ..exceptions import ArgumentError
raise ArgumentError("Argument --name requires a value.")
if prefix_path is not None and not prefix_path.strip(): # pragma: no cover
from ..exceptions import ArgumentError
raise ArgumentError("Argument --prefix requires a value.")
if prefix_name is None and prefix_path is None:
return ctx.default_prefix
elif prefix_path is not None:
return expand(prefix_path)
else:
from ..core.prefix_data import PrefixData
return str(PrefixData.from_name(prefix_name).prefix_path)
@deprecated(
"25.9", "26.3", addendum="Use conda.gateways.disk.create.first_writable_envs_dir"
)
def _first_writable_envs_dir() -> PathType:
from conda.gateways.disk.create import first_writable_envs_dir
return first_writable_envs_dir()
@deprecated(
"25.9",
"26.3",
addendum="Use `conda.base.context.context.plugins.raw_data` instead.",
)
def get_plugin_config_data(
data: dict[Path, dict[str, RawParameter]],
) -> dict[Path, dict[str, RawParameter]]:
from ..plugins.config import PluginConfig
return PluginConfig(data).raw_data
@deprecated(
"25.9",
"26.3",
addendum="Use `conda.plugins.config.PluginConfig.add_plugin_setting` instead.",
)
def add_plugin_setting(
name: str,
parameter: Parameter,
aliases: tuple[str, ...] = (),
) -> None:
from ..plugins.config import PluginConfig
return PluginConfig.add_plugin_setting(name, parameter, aliases)
@deprecated(
"25.9",
"26.3",
addendum="Use `conda.plugins.config.PluginConfig.remove_all_plugin_settings` instead.",
)
def remove_all_plugin_settings() -> None:
from ..plugins.config import PluginConfig
return PluginConfig.remove_all_plugin_settings()
try:
context = Context((), None)
except ConfigurationLoadError as e: # pragma: no cover
print(repr(e), file=sys.stderr)
# Exception handler isn't loaded so use sys.exit
sys.exit(1)
|