Skip to content

Make missing long_description check more flexible #887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bhrutledge merged 5 commits into from
Mar 31, 2022
Merged

Make missing long_description check more flexible #887

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
cd9e29f
Make missing long_description check more flexible.
bhrutledge Mar 26, 2022
8cfce78
Rewrite tests using `build`
bhrutledge Mar 26, 2022
5e81076
Attempt to detect missing description on Windows
bhrutledge Mar 27, 2022
b7a38d9
Reconfigure output before each test
bhrutledge Mar 27, 2022
5d72468
Add changelong entry
bhrutledge Mar 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Make missing long_description check more flexible. 
A missing `long_description` results in `UNKNOWN` being written to
PKG-INFO, but at some point, the number of trailing newlines changed.

See
pypa/readme_renderer#231 (comment)
  • Loading branch information
@bhrutledge
bhrutledge committed Mar 26, 2022
commit cd9e29f435761259169098cfad88a175a9c29605
5 changes: 3 additions & 2 deletions tests/test_check.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,11 @@ def test_check_passing_distribution_with_none_renderer(
assert capsys.readouterr().out == "Checking dist/dist.tar.gz: PASSED\n"


def test_check_no_description(monkeypatch, capsys, caplog):
@pytest.mark.parametrize("description", [None, "UNKNOWN\n\n", "UNKNOWN\n\n\n"])
def test_check_no_description(description, monkeypatch, capsys, caplog):
package = pretend.stub(
metadata_dictionary=lambda: {
"description": None,
"description": description,
"description_content_type": None,
}
)
Expand Down
2 changes: 1 addition & 1 deletion twine/commands/check.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ def _check_file(
content_type, params = cgi.parse_header(description_content_type)
renderer = _RENDERERS.get(content_type, _RENDERERS[None])

if description in {None, "UNKNOWN\n\n\n"}:
if description is None or description.rstrip("\n") == "UNKNOWN":
warnings.append("`long_description` missing.")
elif renderer:
rendering_result = renderer.render(
Expand Down