pypsa-meets-earth/pypsa-earth

Move from os to pathlib

Open

#501 opened on Oct 29, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (349 forks)auto 404
good first issueimprovement

Repository metrics

Stars
 (351 stars)
PR merge metrics
 (PR metrics pending)

Description

From Discord: "os.path vs pathlib": https://builtin.com/software-engineering-perspectives/python-pathlib The os module represents paths as strings with which you cannot do much. The pathlib module represents paths as special objects with useful methods and attributes.

Max: Let's use Pathlib by default. Tracking this here as a feature request so someone can work on the transition in future. I think it is a nice exercise for new contributors to get familiar with the code & the git workflow

Contributor guide

Research direction
Identify all usages of os.path in the codebase and replace them with equivalent pathlib methods. Run the existing tests to ensure no regressions.
Tech stack
python
Domain
backenddeveloper experience
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 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
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85