File size: 17,522 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 | # Copyright (C) 2012 Anaconda, Inc
# SPDX-License-Identifier: BSD-3-Clause
"""Collection of conda's high-level APIs."""
from .base.constants import DepsModifier as _DepsModifier
from .base.constants import UpdateModifier as _UpdateModifier
from .base.context import context
from .common.constants import NULL
from .core.package_cache_data import PackageCacheData as _PackageCacheData
from .core.prefix_data import PrefixData as _PrefixData
from .core.subdir_data import SubdirData as _SubdirData
from .models.channel import Channel
DepsModifier = _DepsModifier
"""Flags to enable alternate handling of dependencies."""
UpdateModifier = _UpdateModifier
"""Flags to enable alternate handling for updates of existing packages in the environment."""
class Solver:
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
A high-level API to conda's solving logic. Three public methods are provided to access a
solution in various forms.
* :meth:`solve_final_state`
* :meth:`solve_for_diff`
* :meth:`solve_for_transaction`
"""
def __init__(
self, prefix, channels, subdirs=(), specs_to_add=(), specs_to_remove=()
):
"""
**Beta**
Args:
prefix (str):
The conda prefix / environment location for which the :class:`Solver`
is being instantiated.
channels (Sequence[:class:`Channel`]):
A prioritized list of channels to use for the solution.
subdirs (Sequence[str]):
A prioritized list of subdirs to use for the solution.
specs_to_add (set[:class:`MatchSpec`]):
The set of package specs to add to the prefix.
specs_to_remove (set[:class:`MatchSpec`]):
The set of package specs to remove from the prefix.
"""
solver_backend = context.plugin_manager.get_cached_solver_backend()
self._internal = solver_backend(
prefix, channels, subdirs, specs_to_add, specs_to_remove
)
def solve_final_state(
self,
update_modifier=NULL,
deps_modifier=NULL,
prune=NULL,
ignore_pinned=NULL,
force_remove=NULL,
):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Gives the final, solved state of the environment.
Args:
deps_modifier (DepsModifier):
An optional flag indicating special solver handling for dependencies. The
default solver behavior is to be as conservative as possible with dependency
updates (in the case the dependency already exists in the environment), while
still ensuring all dependencies are satisfied. Options include
* NO_DEPS
* ONLY_DEPS
* UPDATE_DEPS
* UPDATE_DEPS_ONLY_DEPS
* FREEZE_INSTALLED
prune (bool):
If ``True``, the solution will not contain packages that were
previously brought into the environment as dependencies but are no longer
required as dependencies and are not user-requested.
ignore_pinned (bool):
If ``True``, the solution will ignore pinned package configuration
for the prefix.
force_remove (bool):
Forces removal of a package without removing packages that depend on it.
Returns:
tuple[PackageRef]:
In sorted dependency order from roots to leaves, the package references for
the solved state of the environment.
"""
return self._internal.solve_final_state(
update_modifier, deps_modifier, prune, ignore_pinned, force_remove
)
def solve_for_diff(
self,
update_modifier=NULL,
deps_modifier=NULL,
prune=NULL,
ignore_pinned=NULL,
force_remove=NULL,
force_reinstall=False,
):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Gives the package references to remove from an environment, followed by
the package references to add to an environment.
Args:
deps_modifier (DepsModifier):
See :meth:`solve_final_state`.
prune (bool):
See :meth:`solve_final_state`.
ignore_pinned (bool):
See :meth:`solve_final_state`.
force_remove (bool):
See :meth:`solve_final_state`.
force_reinstall (bool):
For requested specs_to_add that are already satisfied in the environment,
instructs the solver to remove the package and spec from the environment,
and then add it back--possibly with the exact package instance modified,
depending on the spec exactness.
Returns:
tuple[PackageRef], tuple[PackageRef]:
A two-tuple of PackageRef sequences. The first is the group of packages to
remove from the environment, in sorted dependency order from leaves to roots.
The second is the group of packages to add to the environment, in sorted
dependency order from roots to leaves.
"""
return self._internal.solve_for_diff(
update_modifier,
deps_modifier,
prune,
ignore_pinned,
force_remove,
force_reinstall,
)
def solve_for_transaction(
self,
update_modifier=NULL,
deps_modifier=NULL,
prune=NULL,
ignore_pinned=NULL,
force_remove=NULL,
force_reinstall=False,
):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Gives an UnlinkLinkTransaction instance that can be used to execute the solution
on an environment.
Args:
deps_modifier (DepsModifier):
See :meth:`solve_final_state`.
prune (bool):
See :meth:`solve_final_state`.
ignore_pinned (bool):
See :meth:`solve_final_state`.
force_remove (bool):
See :meth:`solve_final_state`.
force_reinstall (bool):
See :meth:`solve_for_diff`.
Returns:
UnlinkLinkTransaction:
"""
return self._internal.solve_for_transaction(
update_modifier,
deps_modifier,
prune,
ignore_pinned,
force_remove,
force_reinstall,
)
class SubdirData:
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
High-level management and usage of repodata.json for subdirs.
"""
def __init__(self, channel):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Args:
channel (str or Channel):
The target subdir for the instance. Must either be a url that includes a subdir
or a :obj:`Channel` that includes a subdir. e.g.:
* 'https://repo.anaconda.com/pkgs/main/linux-64'
* Channel('https://repo.anaconda.com/pkgs/main/linux-64')
* Channel('conda-forge/osx-64')
"""
channel = Channel(channel)
if not channel.subdir:
raise ValueError("SubdirData requires platform-aware Channel objects.")
self._internal = _SubdirData(channel)
def query(self, package_ref_or_match_spec):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Run a query against this specific instance of repodata.
Args:
package_ref_or_match_spec (PackageRef or MatchSpec or str):
Either an exact :obj:`PackageRef` to match against, or a :obj:`MatchSpec`
query object. A :obj:`str` will be turned into a :obj:`MatchSpec` automatically.
Returns:
tuple[PackageRecord]
"""
return tuple(self._internal.query(package_ref_or_match_spec))
@staticmethod
def query_all(package_ref_or_match_spec, channels=None, subdirs=None):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Run a query against all repodata instances in channel/subdir matrix.
Args:
package_ref_or_match_spec (PackageRef or MatchSpec or str):
Either an exact :obj:`PackageRef` to match against, or a :obj:`MatchSpec`
query object. A :obj:`str` will be turned into a :obj:`MatchSpec` automatically.
channels (Iterable[Channel or str] or None):
An iterable of urls for channels or :obj:`Channel` objects. If None, will fall
back to context.channels.
subdirs (Iterable[str] or None):
If None, will fall back to context.subdirs.
Returns:
tuple[PackageRecord]
"""
return tuple(
_SubdirData.query_all(package_ref_or_match_spec, channels, subdirs)
)
def iter_records(self):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Returns:
Iterable[PackageRecord]: A generator over all records contained in the repodata.json
instance. Warning: this is a generator that is exhausted on first use.
"""
return self._internal.iter_records()
def reload(self):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Update the instance with new information. Backing information (i.e. repodata.json)
is lazily downloaded/loaded on first use by the other methods of this class. You
should only use this method if you are *sure* you have outdated data.
Returns:
SubdirData
"""
self._internal = self._internal.reload()
return self
class PackageCacheData:
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
High-level management and usage of package caches.
"""
def __init__(self, pkgs_dir):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Args:
pkgs_dir (str):
"""
self._internal = _PackageCacheData(pkgs_dir)
def get(self, package_ref, default=NULL):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Args:
package_ref (PackageRef):
A :obj:`PackageRef` instance representing the key for the
:obj:`PackageCacheRecord` being sought.
default: The default value to return if the record does not exist. If not
specified and no record exists, :exc:`KeyError` is raised.
Returns:
PackageCacheRecord
"""
return self._internal.get(package_ref, default)
def query(self, package_ref_or_match_spec):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Run a query against this specific package cache instance.
Args:
package_ref_or_match_spec (PackageRef or MatchSpec or str):
Either an exact :obj:`PackageRef` to match against, or a :obj:`MatchSpec`
query object. A :obj:`str` will be turned into a :obj:`MatchSpec` automatically.
Returns:
tuple[PackageCacheRecord]
"""
return tuple(self._internal.query(package_ref_or_match_spec))
@staticmethod
def query_all(package_ref_or_match_spec, pkgs_dirs=None):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Run a query against all package caches.
Args:
package_ref_or_match_spec (PackageRef or MatchSpec or str):
Either an exact :obj:`PackageRef` to match against, or a :obj:`MatchSpec`
query object. A :obj:`str` will be turned into a :obj:`MatchSpec` automatically.
pkgs_dirs (Iterable[str] or None):
If None, will fall back to context.pkgs_dirs.
Returns:
tuple[PackageCacheRecord]
"""
return tuple(_PackageCacheData.query_all(package_ref_or_match_spec, pkgs_dirs))
def iter_records(self):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Returns:
Iterable[PackageCacheRecord]: A generator over all records contained in the package
cache instance. Warning: this is a generator that is exhausted on first use.
"""
return self._internal.iter_records()
@property
def is_writable(self):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Indicates if the package cache location is writable or read-only.
Returns:
bool
"""
return self._internal.is_writable
@staticmethod
def first_writable(pkgs_dirs=None):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Get an instance object for the first writable package cache.
Args:
pkgs_dirs (Iterable[str]):
If None, will fall back to context.pkgs_dirs.
Returns:
PackageCacheData:
An instance for the first writable package cache.
"""
return PackageCacheData(_PackageCacheData.first_writable(pkgs_dirs).pkgs_dir)
def reload(self):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Update the instance with new information. Backing information (i.e. contents of
the pkgs_dir) is lazily loaded on first use by the other methods of this class. You
should only use this method if you are *sure* you have outdated data.
Returns:
PackageCacheData
"""
self._internal = self._internal.reload()
return self
class PrefixData:
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
High-level management and usage of conda environment prefixes.
"""
def __init__(self, prefix_path):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Args:
prefix_path (str):
"""
self._internal = _PrefixData(prefix_path)
def get(self, package_ref, default=NULL):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Args:
package_ref (PackageRef):
A :obj:`PackageRef` instance representing the key for the
:obj:`PrefixRecord` being sought.
default: The default value to return if the record does not exist. If not
specified and no record exists, :exc:`KeyError` is raised.
Returns:
PrefixRecord
"""
return self._internal.get(package_ref.name, default)
def query(self, package_ref_or_match_spec):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Run a query against this specific prefix instance.
Args:
package_ref_or_match_spec (PackageRef or MatchSpec or str):
Either an exact :obj:`PackageRef` to match against, or a :obj:`MatchSpec`
query object. A :obj:`str` will be turned into a :obj:`MatchSpec` automatically.
Returns:
tuple[PrefixRecord]
"""
return tuple(self._internal.query(package_ref_or_match_spec))
def iter_records(self):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Returns:
Iterable[PrefixRecord]: A generator over all records contained in the prefix.
Warning: this is a generator that is exhausted on first use.
"""
return self._internal.iter_records()
@property
def is_writable(self):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Indicates if the prefix is writable or read-only.
Returns:
bool or None:
True if the prefix is writable. False if read-only. None if the prefix
does not exist as a conda environment.
"""
return self._internal.is_writable
def reload(self):
"""
**Beta** While in beta, expect both major and minor changes across minor releases.
Update the instance with new information. Backing information (i.e. contents of
the conda-meta directory) is lazily loaded on first use by the other methods of this
class. You should only use this method if you are *sure* you have outdated data.
Returns:
PrefixData
"""
self._internal = self._internal.reload()
return self
|