Skip to content
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

Jump to bottom

README file installed into site-packages conflicts with package named "readme" #68821

Closed
scls19fr mannequin opened this issue Jul 14, 2015 · 10 comments
Closed

README file installed into site-packages conflicts with package named "readme" #68821

scls19fr mannequin opened this issue Jul 14, 2015 · 10 comments
Labels
OS-mac

Comments

@scls19fr
Copy link
Mannequin

scls19fr mannequin commented Jul 14, 2015

BPO 24633
Nosy @brettcannon, @ronaldoussoren, @rbtcollins, @ned-deily, @dstufft, @scls19fr
Files
  • issue24633.patch: Rename to README.txt
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2015-08-23.23:50:03.454>
created_at = <Date 2015-07-14.08:07:26.099>
labels = ['OS-mac']
title = 'README file installed into site-packages conflicts with package named "readme"'
updated_at = <Date 2015-10-23.20:24:22.334>
user = 'https://github.com/scls19fr'

    bugs.python.org fields:

    activity = <Date 2015-10-23.20:24:22.334>
actor = 'python-dev'
assignee = 'none'
closed = True
closed_date = <Date 2015-08-23.23:50:03.454>
closer = 'rbcollins'
components = ['macOS']
creation = <Date 2015-07-14.08:07:26.099>
creator = 'scls'
dependencies = []
files = ['39924']
hgrepos = []
issue_num = 24633
keywords = ['patch']
message_count = 10.0
messages = ['246721', '246723', '246725', '246729', '246731', '246732', '246733', '249029', '249031', '253392']
nosy_count = 7.0
nosy_names = ['brett.cannon', 'ronaldoussoren', 'rbcollins', 'ned.deily', 'python-dev', 'dstufft', 'scls']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue24633'
versions = ['Python 3.6']
    @scls19fr
    Copy link
    Mannequin Author

    scls19fr mannequin commented Jul 14, 2015

    Hello,

    the package name "readme" conflicts with Python installed site-packages/README file on case-insensitive filesystems (Mac OS X).

    pypa/readme_renderer#26
    mgedmin/restview#30
    https://groups.google.com/a/continuum.io/forum/#!topic/anaconda/AGHXzB1sN0I

    I wonder if README file should be be renamed README.rst or README.txt or README.md to avoid this issue or if readme package should be renamed.

    Kind regards

    @scls19fr scls19fr mannequin added the OS-mac label Jul 14, 2015
    @ned-deily
    Copy link
    Member

    I agree with IIan's comments you cited in https://groups.google.com/a/continuum.io/forum/#!topic/anaconda/AGHXzB1sN0I. Python has been installing the README file in site-packages for a very long time and there have been case-insensitive file systems for a very long time, including, but not limited to, the default case-insensitive variant of HFS on OS X. So this seems to be an issue for the readme package, not for Python. Even if the Python-installed README file were installed under a different name in future release, it wouldn't solve the problem for trying to install the readme package under current and past Python releases. CC-ing Donald, as the author of readme, for his comments.

    @rbtcollins
    Copy link
    Member

    So, README is a valid package name. readme conflicting with README on case insensitive filesystems is a special case, but the general problem remains.

    We've no particular reason to use README rather than e.g. README.txt, which would open with a much more reasonable program on Windows, and would also remove this problem.

    @ronaldoussoren
    Copy link
    Contributor

    I agree with Robert: renaming the file to README.txt would be a good idea regardless to enable easily opening the file with a GUI editor and as a bonus removes any change of conflict with a package name.

    The patch looks good to me.

    @ned-deily
    Copy link
    Member

    I'm +0 on the name change but, again, it wouldn't solve the conflict problem for potential users of the readme package until 3.6.

    @ned-deily
    Copy link
    Member

    (And such a change would only be appropriate in a feature release, as it would complicate things for existing release installers and downstream distributions, etc.)

    @brettcannon brettcannon changed the title Not a directory: '//anaconda/lib/python2.7/site-packages/readme/__about__.py' README file installed into site-packages conflicts with package named "readme" Jul 14, 2015
    @brettcannon
    Copy link
    Member

    +1 on the file renaming. There really shouldn't be any files we put into site-packages that don't have a dot or some other symbol that we would never support as a file name for importing.

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Aug 23, 2015

    New changeset d90a65014c42 by Robert Collins in branch 'default':
    Issue bpo-24633: site-packages/README -> README.txt.
    https://hg.python.org/cpython/rev/d90a65014c42

    @rbtcollins
    Copy link
    Member

    Applied to 3.6 only (since I don't want to disrupt the 3.5 release train, and think that making packagers adjust on a point release would be mean).

    @python-dev
    Copy link
    Mannequin

    python-dev mannequin commented Oct 23, 2015

    New changeset 742aefb5ca46 by Steve Dower in branch 'default':
    Issue bpo-24633: Removes automatic rename of site-packages/README since README.txt is now committed.
    https://hg.python.org/cpython/rev/742aefb5ca46

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    OS-mac
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    4 participants
    @brettcannon @rbtcollins @ronaldoussoren @ned-deily