snapcraft/extractors/setuppy.py: match setuptools metadata keys
Metadata
Current evaluation
PR #2518 (setup.py: use setuptools description/long_description as snap summary/description, for LP#1813364) was closed unmerged in Oct 2019 by maintainer merlijn-sebrechts; WIP successor #2756 was also closed.
Resolution: closed stale
Reason: Maintainer merlijn-sebrechts closed the unmerged PR on 2019-10-20, stating they found 'multiple issues with using long_description as the description field of a snap' (citing their comment on #2756) and proposing closure since 'there isn't much use for it anymore'. Review status was changes_requested, and the three-line diff was never merged into snapcraft/extractors/setuppy.py.
Evaluated by: mr-cal-bot
No scores available.
Issue body
* Use setuptools' description as snapcraft's summary
* Use setuptools' long_description as snapcraft's description
Fixes LP https://bugs.launchpad.net/snapcraft/+bug/1813364
See also https://forum.snapcraft.io/t/using-external-metadata/4642/10
- [x] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `./runtests.sh static`?
- [ ] Have you successfully run `./runtests.sh tests/unit`?
This fails for me, I get:
```
$ ./runtests.sh tests/unit
tests.unit (unittest.loader._FailedTest) ... ERROR
======================================================================
ERROR: tests.unit (unittest.loader._FailedTest)
----------------------------------------------------------------------
ImportError: Failed to import test module: tests.unit
Traceback (most recent call last):
File "/usr/lib/python3.6/unittest/loader.py", line 462, in _find_test_path
package = self._get_module_from_name(name)
File "/usr/lib/python3.6/unittest/loader.py", line 369, in _get_module_from_name
__import__(name)
File "/home/ijohnson/git/snapcraft/tests/unit/__init__.py", line 24, in <module>
import fixtures
ModuleNotFoundError: No module named 'fixtures'
----------------------------------------------------------------------
Ran 1 test in 0.000s
FAILED (errors=1)
```
-----
Also let me know if I need to change/modify any tests for this, this is my first PR to snapcraft :smiley: so I'm not sure what all should be changed for this
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed stale | PR #2518 (setup.py: use setuptools description/long_description as snap summary/description, for LP#1813364) was closed unmerged in Oct 2019 by maintainer merlijn-sebrechts; WIP successor #2756 was also closed. | |
| stealth/space-bunny-alpha | — | closed superseded | PR #2518 was closed unmerged after long_description proved unsuitable for Snap descriptions; WIP successor #2756 was also closed, so no change shipped. | |
| stealth/space-bunny-alpha | — | closed stale | PR #2518 (map setuptools description/long_description to snap summary/description) sat at changes_requested for ~18 months, then was closed unmerged by a maintainer in Oct 2019; WIP fix attempt #2756 was also closed with no fix shipped. | |
| stealth/space-bunny-alpha | — | closed stale | Abandoned unmerged: mapping setuptools long_description to a Snap description was found fundamentally problematic; WIP follow-up #2756 was also closed. | |
| qwen/qwen3.6-35b-a3b | — | — | Closed without merging. A reviewer found fundamental issues with mapping setuptools long_description to snap descriptions and proposed abandoning the PR as it is no longer useful. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Mapped setuptools metadata to snapcraft fields. After test updates, a maintainer identified issues with using long_description as the description and closed the pull request as it is no longer useful. |
Update history
No update history recorded yet.
Related work
-
Superseded By:
canonical/snapcraft#2756
(confidence 90%)
Maintainer's WIP reimplementation of the same idea; also closed unmerged after the same long_description concerns
-
Related To:
snapcraft#2756
(confidence 85%)
Issue comment 544284814 on #2756 documents the format/length/compatibility problems that led to closing #2518
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #2756 WIP: extractors: match setuptools metadata keys | snapcraft | closed | PR #2756 was closed unmerged; mapping setuptools long_description to a Snap description was abandoned over format, length, compatibility, and regression concerns. No fix shipped. | |
| #2070 extractors: support for setup.py | snapcraft | merged | Merged setup.py metadata extraction into Snapcraft, adding loading of setup.py and retrieval of version and description information in PR #2070 (commit 5c1761795). | |
| #1813364 The `setup.py` parse-info method treats description/long_description keys wrongly | snapcraft (launchpad) | closed | Issue closed without fix. Maintainer explained that long_description from PyPI is often too long and contains installation instructions, making it unsuitable for the snap description field (PR #2756). |