jaraco/path

Maximize compatibility with `pathlib.Path`

Open

#214 opened on Jul 7, 2023

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Python (151 forks)github user discovery
help wanted

Repository metrics

Stars
 (1,125 stars)
PR merge metrics
 (PR metrics pending)

Description

This project does aspire to align with pathlib where possible, so it should probably do the same (and probably implement iterdir at the same time, if it's not present already).

Originally posted by @jaraco in https://github.com/jaraco/path/issues/212#issuecomment-1623882608

Here some other methods that are worth considering:

set(vars(pathlib.Path)) - set(vars(path.Path)) 
Out[9]: 
{'__slots__',
 '_make_child_relpath',
 '_scandir',
 'absolute',
 'cwd',
 'group',
 'hardlink_to',
 'home',
 'is_block_device',
 'is_char_device',
 'is_dir',
 'is_fifo',
 'is_file',
 'is_mount',
 'is_socket',
 'is_symlink',
 'iterdir',
 'lchmod',
 'link_to',
 'replace',
 'resolve',
 'rglob',
 'symlink_to'}
  • absolute
  • cwd
  • group
  • hardlink_to
  • home
  • is_block_device
  • is_char_device
  • is_dir
  • is_fifo
  • is_file
  • is_mount
  • is_socket
  • is_symlink
  • iterdir
  • lchmod
  • link_to
  • owner
  • replace
  • resolve
  • rglob
  • suffix
  • symlink_to
  • with_stem
  • with_name

Contributor guide

Research direction
Review the list of missing methods in the issue and implement each one by mimicking the behavior of the corresponding method in pathlib.Path. Ensure that the methods work with the existing path.py infrastructure and pass existing tests.
Tech stack
python
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60