Skip to content

add capability to pass options to to_csv method #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add capability to pass options to to_csv method #103

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion socrata/sources.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,8 @@ def df(self, dataframe, **kwargs):

max_retries (integer): Optional retry limit per chunk in the upload. Defaults to 5.
backoff_seconds (integer): Optional amount of time to backoff upon a chunk upload failure. Defaults to 2.

pd_to_csv_params (dict): Optional keyword arguments passed to pd.DataFrame.to_csv method. Defaults to {}.
```

Returns:
Expand All @@ -458,9 +460,17 @@ def df(self, dataframe, **kwargs):
df = pandas.read_csv('test/fixtures/simple.csv')
upload = upload.df(df)
```
```python
import pandas
# assume test/fixtures/simple.csv contains the null byte \x00
# see https://github.com/pandas-dev/pandas/issues/47871
df = pandas.read_csv('test/fixtures/simple.csv')
upload = upload.df(df, pd_to_csv_params={"escapechar": "\\"})
```
"""
s = io.StringIO()
dataframe.to_csv(s, index=False)
pd_to_csv_params = kwargs.pop("pd_to_csv_params", {})
dataframe.to_csv(s, index=False, **pd_to_csv_params)
return self._chunked_bytes(bytes(s.getvalue().encode()),"text/csv", **kwargs)

def add_to_revision(self, uri, revision):
Expand Down