Enhancement: relax os.path.common input requirements
Open
Nobody has claimed this yet.
stdlib
type-feature
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
Feature or enhancement
os.path.commonpath is needlessly strict requiring its paths argument to be a Sequence. The underlying algorithm does not require it and the restriction is an implementation artifact.
Pitch
- Faster code: current implementation goes over its input while, in principle, one iteration is sufficient
- Relaxed argument requirement:
Sequenceis replaced withIterable
Previous discussion
https://discuss.python.org/t/os-path-commonpath-doesnt-need-a-sequence/21543/13
Linked PRs
- gh-99964
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 os.path.commonpath entry point and inspect the existing implementation and tests for its paths argument. Compare the behavior with the linked discussion, then verify that iterable inputs are accepted, processing is performed in one pass, and existing path behavior remains intact.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- operating-systems
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 25/100