← Back to issue list

Relative path base poorly documented

View original Launchpad issue

Metadata

Project
snapcraft (launchpad)
Number
#1808896
Type
issue
State
open
Author
~racb
Labels
—
Created
Updated
Closed
—

Current evaluation

2019 request to document what the python plugin's relative requirements-file path is relative to and make its error message show the searched path. The plugin code and error now live in external craft-parts; the referenced dead doc URL is gone. Awaiting maintainer decision.

Suggested action: needs triage

Reason: The issue is unlabelled with no maintainer response beyond one user workaround comment from ~den4uk ('I solved it by placing the requirements.txt file into the directory specified in "source"'), so it has never been triaged. Investigation shows the exact error string is gone from the repo and the code path now lives in external craft-parts (snapcraft/parts/plugins/python_plugin.py:19 is only a shim: 'from craft_parts.plugins import python_plugin'), so neither requested fix can be made in this repo. This is not purely age-based dismissal — a maintainer must decide whether to file it upstream in craft-parts, or whether craft-parts already documents the relative-to semantics.

Evaluated by: mr-cal-bot

Impact: 22 Quick Win: 4 Complexity: 45 Confidence: 72 Actionability: 35

Issue body

https://docs.snapcraft.io/the-python-plugin/8529 says "Path to a requirements.txt file". Relative to what? I'm getting: Failed to find the referred requirements file at the given path: 'requirements.txt'. Check the property and ensure the file exists. This is unhelpful because it isn't telling me where it's looking, requiring me to guess by trying various base paths. To fix this, please: 1. Document what the path should be relative to. 2. Arrange for the error message to tell me where it actually looked. This is particularly important for snapcraft, IMHO, as depending on what's going on various different base paths are used. This was with snapcraft 2.43.1 on Xenial.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 22
Quick Win: 4
Complexity: 45
Confidence: 72
Actionability: 35
needs triage 2019 request to document what the python plugin's relative requirements-file path is relative to and make its error message show the searched path. The plugin code and error now live in external craft-parts; the referenced dead doc URL is gone. Awaiting maintainer decision.
stealth/space-bunny-alpha
Impact: 35
Quick Win: 19
Complexity: 28
Confidence: 86
Actionability: 76
needs triage Python plugin requirements paths still lack an explicit base; the old 2.43.1 error omitted the resolved location, and placing the file under source is confirmed to work. Needs triage.
stealth/space-bunny-alpha
Impact: 30
Quick Win: 17
Complexity: 30
Confidence: 78
Actionability: 80
needs triage Python plugin requirements-path documentation omits the relative-path base, while the missing-file error omits the resolved location; this needs triage on a legacy report.
qwen/qwen3.8-27b
Impact: 30
Quick Win: 24
Staleness: 90
Complexity: 20
Confidence: 35
Support Request: 40
needs triage Python plugin 'requirements' doc doesn't state what relative paths are based on, and the 'Failed to find the referred requirements file' error doesn't say where snapcraft looked. Reported on snapcraft 2.43.1; no labels, comments, or maintainer activity since.
qwen/qwen3.6-35b-a3b
Staleness: 98
Complexity: 15
Confidence: 90
Support Request: 20
close stale Over 7-year-old issue requesting documentation and error message improvements for the snapcraft python plugin's requirements.txt path. References obsolete snapcraft 2.43.1 and Ubuntu Xenial with no maintainer interaction.
qwen/qwen3.6-35b-a3b
Staleness: 98
Complexity: 15
Confidence: 95
Support Request: 25
close stale Request to document the base path for a relative requirements.txt property and improve the associated error message. Currently untriaged and inactive for over seven years.
qwen3.6-35b-a3b-mtp-q6
Staleness: 98
Complexity: 15
Confidence: 90
Support Request: 20
close stale Documentation and error message improvement request for snapcraft's python plugin requirements.txt path. Issue is extremely stale with no maintainer interaction since 2018 and references a deprecated snapcraft version.

Update history

Date Change
created

Related work

  • Blocked By: canonical/craft-parts (confidence 70%)

    Both the requirements-file property handling and its error message now live in the external craft-parts project; this repo's python_plugin.py is a thin re-export shim.

Related issues

No related issues found above the similarity threshold.