Skip to content
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

Jump to bottom

ENH: Add jsonline output format in to_dict(), failing type checks #58448

Closed
wants to merge 1 commit into from
Closed

ENH: Add jsonline output format in to_dict(), failing type checks #58448

Show file tree
Hide file tree
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 13 additions & 4 deletions pandas/core/frame.py
View file
Open in desktop
Expand Up @@ -1952,7 +1952,7 @@ def to_dict(
@overload
def to_dict(
self,
orient: Literal["records"],
orient: Literal["records", "jsonlines"],
*,
into: type[MutableMappingT] | MutableMappingT,
index: bool = ...,
Expand All @@ -1970,7 +1970,7 @@ def to_dict(
@overload
def to_dict(
self,
orient: Literal["records"],
orient: Literal["records", "jsonlines"],
*,
into: type[dict] = ...,
index: bool = ...,
Expand All @@ -1981,7 +1981,7 @@ def to_dict(
def to_dict(
self,
orient: Literal[
"dict", "list", "series", "split", "tight", "records", "index"
"dict", "list", "series", "split", "tight", "records", "index", "jsonlines"
] = "dict",
*,
into: type[MutableMappingT] | MutableMappingT = dict, # type: ignore[assignment]
Expand All @@ -1995,7 +1995,8 @@ def to_dict(

Parameters
----------
orient : str {'dict', 'list', 'series', 'split', 'tight', 'records', 'index'}
orient : str {'dict', 'list', 'series', 'split', 'tight',
'records', 'index', 'jsonlines'}
Determines the type of the values of the dictionary.

- 'dict' (default) : dict like {column -> {index -> value}}
Expand All @@ -2009,6 +2010,10 @@ def to_dict(
- 'records' : list like
[{column -> value}, ... , {column -> value}]
- 'index' : dict like {index -> {column -> value}}
- 'jsonlines' : newline-separated items like
{column -> value}
...
{column -> value}

.. versionadded:: 1.4.0
'tight' as an allowed value for the ``orient`` argument
Expand Down Expand Up @@ -2076,6 +2081,10 @@ def to_dict(
{'index': ['row1', 'row2'], 'columns': ['col1', 'col2'],
'data': [[1, 0.5], [2, 0.75]], 'index_names': [None], 'column_names': [None]}

>>> df.to_dict("jsonlines")
{'col1': 1, 'col2': 0.5}
{'col1': 2, 'col2': 0.75}

You can also specify the mapping type.

>>> from collections import OrderedDict, defaultdict
Expand Down
26 changes: 18 additions & 8 deletions pandas/core/methods/to_dict.py
View file
Open in desktop
@@ -1,5 +1,6 @@
from __future__ import annotations

import json
from typing import (
TYPE_CHECKING,
Literal,
Expand Down Expand Up @@ -65,7 +66,7 @@ def to_dict(
@overload
def to_dict(
df: DataFrame,
orient: Literal["records"],
orient: Literal["records", "jsonlines"],
*,
into: type[MutableMappingT] | MutableMappingT,
index: bool = ...,
Expand All @@ -85,7 +86,7 @@ def to_dict(
@overload
def to_dict(
df: DataFrame,
orient: Literal["records"],
orient: Literal["records", "jsonlines"],
*,
into: type[dict] = ...,
index: bool = ...,
Expand All @@ -97,7 +98,7 @@ def to_dict(
def to_dict(
df: DataFrame,
orient: Literal[
"dict", "list", "series", "split", "tight", "records", "index"
"dict", "list", "series", "split", "tight", "records", "index", "jsonlines"
] = "dict",
*,
into: type[MutableMappingT] | MutableMappingT = dict, # type: ignore[assignment]
Expand All @@ -111,7 +112,8 @@ def to_dict(

Parameters
----------
orient : str {'dict', 'list', 'series', 'split', 'tight', 'records', 'index'}
orient : str {'dict', 'list', 'series', 'split', 'tight',
'records', 'index', 'jsonlines'}
Determines the type of the values of the dictionary.

- 'dict' (default) : dict like {column -> {index -> value}}
Expand All @@ -125,7 +127,10 @@ def to_dict(
- 'records' : list like
[{column -> value}, ... , {column -> value}]
- 'index' : dict like {index -> {column -> value}}

- 'jsonlines' : newline-separated items like
{column -> value}
...
{column -> value}
.. versionadded:: 1.4.0
'tight' as an allowed value for the ``orient`` argument

Expand Down Expand Up @@ -160,7 +165,7 @@ def to_dict(

# error: Incompatible types in assignment (expression has type "str",
# variable has type "Literal['dict', 'list', 'series', 'split', 'tight',
# 'records', 'index']")
# 'records', 'index', 'jsonlines']")
orient = orient.lower() # type: ignore[assignment]

if not index and orient not in ["split", "tight"]:
Expand Down Expand Up @@ -231,10 +236,10 @@ def to_dict(
+ (("column_names", list(df.columns.names)),)
)

elif orient == "records":
elif orient in ("records", "jsonlines"):
columns = df.columns.tolist()
if are_all_object_dtype_cols:
return [
data = [
into_c(zip(columns, map(maybe_box_native, row)))
for row in df.itertuples(index=False, name=None)
]
Expand All @@ -252,6 +257,11 @@ def to_dict(
for row in data:
for col in object_dtype_cols:
row[col] = maybe_box_native(row[col])

if orient == "jsonlines":
jsonlines_string = "\n".join([json.dumps(row) for row in data])
return jsonlines_string
else:
return data # type: ignore[return-value]

elif orient == "index":
Expand Down