pypa / pypa/setuptools

pkg_resources.DefaultProvider breaks on unreadable files

Open
#617 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Needs Triage
Dominant language
Python
Stars
2.9k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
1

Description

DefaultProvider._has only checks that a file exists, and DefaultProvider._get reads it without catching permission issues, so if there's an unreadable file stuff will break. The particular case I'm looking at is reading a PKG-INFO file on some scan on import, but I think it's a general issue.

One simple solution is to use os.access in _has. In theory we should catch exceptions either in _get or its callers, but since this isnt something that typically races we can probably just change _has and call it a day.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating pkg_resources.DefaultProvider and reading its _has and _get methods. Reproduce the unreadable PKG-INFO case or add a focused regression test; the work is done when scanning or importing with an unreadable file no longer breaks.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.