Skip to content

DOC: update the docstring of pandas.DataFrame.to_dict #20162

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

Merged
merged 5 commits into from
Mar 13, 2018
Merged

DOC: update the docstring of pandas.DataFrame.to_dict #20162

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a4121e7
DOC: update the docstring of pandas.DataFrame.to_dict
Mar 10, 2018
dd2d78e
Merge remote-tracking branch 'upstream/master' into Documentation2
Cheukting Mar 10, 2018
a9fa2f2
DOC: update the docstring of pandas.DataFrame.to_dict
Mar 10, 2018
9a05746
DOC: update the docstring of pandas.DataFrame.to_dict
Mar 11, 2018
f86ea83
Update formatting
TomAugspurger Mar 13, 2018
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
27 changes: 18 additions & 9 deletions pandas/core/frame.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -924,7 +924,12 @@ def from_dict(cls, data, orient='columns', dtype=None, columns=None):
return cls(data, index=index, columns=columns, dtype=dtype)

def to_dict(self, orient='dict', into=dict):
"""Convert DataFrame to dictionary.
"""
Convert DataFrame to dictionary.

Method converting the DataFrame to a Python dictionary,
the type of the key-value pairs can be customized with
the parameters (see below).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bit repetitive, I wouldn't repeat that it converts to a dictionary again, and directly explain that you can customize.


Parameters
----------
Expand All @@ -949,16 +954,21 @@ def to_dict(self, orient='dict', into=dict):
instance of the mapping type you want. If you want a
collections.defaultdict, you must pass it initialized.

.. versionadded:: 0.21.0
.. versionadded:: 0.21.0.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The validation script is wrong, you don't need the final dot here.


Returns
-------
result : collections.Mapping like {column -> {index -> value}}

See Also
--------
from_dict: create a DataFrame from a dictionary
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

from_dict -> DataFrame.from_dict


Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm guessing if it'd make sense to also add to_json here. I think users checking this method can be looking for that.

Examples
--------
>>> df = pd.DataFrame(
{'col1': [1, 2], 'col2': [0.5, 0.75]}, index=['a', 'b'])
>>> df = pd.DataFrame({'col1': [1, 2],
... 'col2': [0.5, 0.75]},
... index=['a', 'b'])
>>> df
col1 col2
a 1 0.50
Expand All @@ -975,9 +985,8 @@ def to_dict(self, orient='dict', into=dict):
b 0.75
Name: col2, dtype: float64}
>>> df.to_dict('split')
{'columns': ['col1', 'col2'],
'data': [[1.0, 0.5], [2.0, 0.75]],
'index': ['a', 'b']}
{'index': ['a', 'b'], 'columns': ['col1', 'col2'],
'data': [[1.0, 0.5], [2.0, 0.75]]}
>>> df.to_dict('records')
[{'col1': 1.0, 'col2': 0.5}, {'col1': 2.0, 'col2': 0.75}]
>>> df.to_dict('index')
Expand All @@ -994,8 +1003,8 @@ def to_dict(self, orient='dict', into=dict):

>>> dd = defaultdict(list)
>>> df.to_dict('records', into=dd)
[defaultdict(<type 'list'>, {'col2': 0.5, 'col1': 1.0}),
defaultdict(<type 'list'>, {'col2': 0.75, 'col1': 2.0})]
[defaultdict(<class 'list'>, {'col1': 1.0, 'col2': 0.5}),
defaultdict(<class 'list'>, {'col1': 2.0, 'col2': 0.75})]
"""
if not self.columns.is_unique:
warnings.warn("DataFrame columns are not unique, some "
Expand Down