drivendataorg/cloudpathlib

Add a `dirs_exist_ok` parameter to the `copytree` implementation

Open

#144 opened on May 20, 2021

View on GitHubContributor guide
 (0 comments) (1 reaction) (0 assignees)Python (87 forks)auto 404
enhancementgood first issue

Repository metrics

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

Description

We could add a dirs_exist_ok parameter to copy tree. To do this, we would also need to raise on mkdir if dir exists for cloud implementations. For most clients mkdir is a no-op right now, so that logic would need to be added/tested.

It seems like shutil.copytree has a dirs_exist_ok parameter that controls this exist_ok. Do we want to mimic that interface?

https://docs.python.org/3/library/shutil.html#shutil.copytree

Originally posted by @jayqi in https://github.com/drivendataorg/cloudpathlib/pull/142#discussion_r634894797

Contributor guide

Research direction
Implement a `dirs exist ok` parameter in the `copytree` method, modifying the `mkdir` calls to raise if directory exists and `exist ok` is False.
Tech stack
python
Domain
backend
Issue type
Feature
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.
Half day
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.
65