Skip to content

Commit 6f7285f

Browse files
committed
Add docstring to emphasise laziness
1 parent da811b9 commit 6f7285f

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/pip/_internal/resolution/resolvelib/found_candidates.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,13 @@
1+
"""Utilities to lazily create and visit candidates found.
2+
3+
Creating and visiting a candidate is a *very* costly operation. It involves
4+
fetching, extracting, potentially building modules from source, and verifying
5+
distribution metadata. It is therefore crucial for performance to keep
6+
everything here lazy all the way down, so we only touch candidates that we
7+
absolutely need, and not "download the world" when we only need one version of
8+
something.
9+
"""
10+
111
import itertools
212

313
from pip._vendor.six.moves import collections_abc # type: ignore

0 commit comments

Comments
 (0)