pathlib.Path.unlink raises a `NotADirectoryError` if some element of the path is actually a file - this is undocumented
Open
Nobody has claimed this yet.
docs
topic-pathlib
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
Documentation
https://docs.python.org/3/library/pathlib.html#pathlib.Path.unlink states that a FileNotFoundError will be raised if the path does not exist.
On macos-14 a NotADirectoryError is raised if the directory does not exist.
See pypa/cibuildwheel#1850 for an example.
Linked PRs
- gh-120049
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the pathlib.Path.unlink documentation page and review pypa/cibuildwheel#1850 for the reported macOS behavior. Verify the exception scenario and update the documentation so the relevant NotADirectoryError behavior is described; the documentation should accurately cover both missing paths and paths containing a file.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100