aws/aws-sdk-pandas

change the name of "mode" argument to awswrangler.s3.to_csv

Open

#2,409 opened on Jul 25, 2023

View on GitHub
 (5 comments) (0 reactions) (1 assignee)Python (3,560 stars) (630 forks)batch import
enhancementhelp wantedinvestigating

Description

Describe the bug

The method (awswrangler.s3.to_csv) supports a "mode" argument and **pandas_kwargs. The "mode" argument is not passed through to Pandas, but consumed in the awswrangler method, which also expects dataset=True to use "mode". In some cases, it would be useful to pass this argument through to Pandas.

If there is already a way to pass "mode" to Pandas, a documentation update would resolve this issue:

How to Reproduce

import awswrangler as wr

...

load a DataFrame and name it df

...

Pandas "mode"

wr.s3.to_csv(df, "some_test_file_name", mode="a", header=False)

awswrangler expects mode="append", dataset=True

Expected behavior

No response

Your project

No response

Screenshots

No response

OS

AWS Lambda x86_64 Architecture

Python version

3.10

AWS SDK for pandas version

3.2.0

Additional context

No response

Contributor guide

Tech stack
pythonpandasaws
Domain
datacloud
Issue type
bug
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-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonpandasAWS SDK for pandas
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
The issue concerns the awswrangler.s3.to csv function where the 'mode' argument is consumed by the library and not passed to pandas. Review the function signature in the source code (likely in awswrangler/s3/ write csv.py or similar) and the pandas to csv documentation to determine a proper rename (e.g., 'dataset mode' or 'overwrite mode'). Check issue comments for any maintainer guidance. Ensure backward compatibility by adding a deprecation warning for the old argument name.
change the name of "mode" argument to awswrangler.s3.to_csv · aws/aws-sdk-pandas#2409 | Good First Issue