python-poetry / python-poetry/poetry
mark dry run mode in poetry output
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 34.3k
- Forks
- 2.5k
- Avg merge
- 2d 19h
- Merged PRs (30d)
- 30
Description
Issue Kind
Change in current behaviour
Description
Currently, there is no difference in output between poetry install --dry-run and poetry install.
$ poetry install --dry-run
Installing dependencies from lock file
Package operations: 4 installs, 0 updates, 0 removals
- Installing mdurl (0.1.2)
- Installing pygments (2.18.0)
- Installing markdown-it-py (3.0.0)
- Installing rich (13.9.4)
Installing the current project: my-package (0.1.0)
$ poetry install
Installing dependencies from lock file
Package operations: 4 installs, 0 updates, 0 removals
- Installing mdurl (0.1.2)
- Installing pygments (2.18.0)
- Installing markdown-it-py (3.0.0)
- Installing rich (13.9.4)
Installing the current project: my-package (0.1.0)
Impact
This may be confusing, since observing only the output of poetry command, there is no way of telling if it was actually executed, or only simulated.
Workarounds
You need to observe both the command used (to check for dry-run flag) and the output (to see an actual output) in order to check if for example a package was installed. This makes scripting poetry output more challenging.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing the output produced by poetry install and how the --dry-run option is handled. Compare the dry-run and normal execution paths, then add or update coverage for their output. Done means the output clearly indicates when installation is simulated, without requiring users to inspect the command arguments.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100