Skip to content

bdist_wheel misbehaves on Windows newlines #1126

Open
@boppreh

Description

@boppreh

Environment

Python 3.6 64 bits, Windows 10.

>>> setuptools.__version__
'36.2.6'

Steps to reproduce

setup.py

from setuptools import setup
setup(
    name='package',
    version='0.0.0',
    long_description='first line\r\nsecond line',
)
$ python setup.py bdist_wheel
running bdist_wheel
running build
installing to build\bdist.win-amd64\wheel
running install
running install_egg_info
running egg_info
writing package.egg-info\PKG-INFO
writing dependency_links to package.egg-info\dependency_links.txt
writing top-level names to package.egg-info\top_level.txt
reading manifest file 'package.egg-info\SOURCES.txt'
writing manifest file 'package.egg-info\SOURCES.txt'
Copying package.egg-info to build\bdist.win-amd64\wheel\.\package-0.0.0-py3.6.egg-info
running install_scripts
creating build\bdist.win-amd64\wheel\package-0.0.0.dist-info\WHEEL

Observed behavior

dist\package-0.0.0-py3-none-any.whl\package-0.0.0.dist-info\METADATA

Metadata-Version: 2.0
Name: package
Version: 0.0.0
Summary: UNKNOWN
Home-page: UNKNOWN
Author: UNKNOWN
Author-email: UNKNOWN
License: UNKNOWN

first line

Expected behavior

METADATA should include "second line", or an error raised during build.

Notes

python setup.py sdist generates a file with both lines correctly in the description field of PKG-INFO, but they maintain their '\r\n' line endings while the rest of the file uses only \n. This is very unusual and should probably be changed or warned against.

I'm not sure if this issue should be reported here or in https://github.com/pypa/wheel, so apologies if I'm in the wrong place.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Needs InvestigationIssues which are likely in scope but need investigation to figure out the causeNeeds ReproIssues that need a reproducible example.bug

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions