Skip to content

Commit

Permalink
improve export subsystem docs
Browse files Browse the repository at this point in the history
Also removes a reference to legacy exports which were deprecated
and removed in earlier releases.
  • Loading branch information
cognifloyd committed Apr 16, 2024
1 parent 9cdb89e commit 462b828
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions src/python/pants/backend/python/goals/export.py
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,6 @@ class ExportPluginOptions:
This only applies when '[python].enable_resolves' is true and when exporting a
'mutable_virtualenv' ('symlinked_immutable_virtualenv' exports are not "full"
virtualenvs because they must not be edited, and do not include 'pip').
NOTE: If you are using legacy exports (not using the '--resolve' option), then
this option has no effect. Legacy exports will not include any editable installs.
"""
),
advanced=True,
Expand All @@ -114,7 +111,15 @@ class ExportPluginOptions:
- `-E` ignores all `PYTHON*` env vars like `PYTHONPATH`.
Set this to false if you need non-hermetic scripts with
simple python shebangs that respect vars like `PYTHONPATH`.
simple python shebangs that respect vars like `PYTHONPATH`,
to, for example, allow IDEs like PyCharm to inject its debugger,
coverage, or other IDE-specific libs when running a script.
This only applies when when exporting a 'mutable_virtualenv'
('symlinked_immutable_virtualenv' exports are not "full"
virtualenvs because they are used internally by pants itself.
Pants requires hermetic scripts to provide its reproduciblity
guarantee, fine-grained caching, and other features).
"""
),
advanced=True,
Expand Down

0 comments on commit 462b828

Please sign in to comment.