Docstring changes to pandas.Series.dt.to_pydatetime #20198

priya-gitTest · 2018-03-10T16:42:38Z

Checklist for the pandas documentation sprint (ignore this if you are doing
an unrelated PR):

PR title is "DOC: update the docstring"
The validation script passes: scripts/validate_docstrings.py <your-function-or-method>
The PEP8 style check passes: git diff upstream/master -u -- "*.py" | flake8 --diff
The html version looks good: python doc/make.py --single <your-function-or-method>
It has been proofread on language by another sprint participant

Please include the output of the validation script below between the "```" ticks:

scripts/validate_docstrings.py pandas.Series.dt.to_pydatetime

Errors found:
        No extended summary found

Extended Summary removed as per Reviewers suggestion.


Checklist for other PRs (remove this part if you are doing a PR for the pandas documentation sprint):

- [x] closes #xxxx
- [ ] tests added / passed
- [ ] passes `git diff upstream/master -u -- "*.py" | flake8 --diff`
- [ ] whatsnew entry

pep8speaks · 2018-03-10T16:42:39Z

Hello @priya-gitTest! Thanks for updating the PR.

Cheers ! There are no PEP8 issues in this Pull Request. 🍻

Comment last updated on March 13, 2018 at 10:52 Hours UTC

…to_pydatetime

priya-gitTest · 2018-03-10T17:08:20Z

fixed the PEP8 issues

jreback · 2018-03-10T19:40:05Z

pandas/core/indexes/accessors.py

@@ -126,6 +126,32 @@ class DatetimeProperties(Properties):
    """

    def to_pydatetime(self):
+        """
+        Return DatetimeIndex as object ndarray of datetime.datetime objects.


Return DatetimeIndex as an object ndarray

Thanks. Fixed it.

jreback · 2018-03-10T19:44:00Z

pandas/core/indexes/accessors.py

+        """
+        Return DatetimeIndex as object ndarray of datetime.datetime objects.
+
+        This function converts the Pandas Series DatetimeIndex to


would remove this extended summary

jreback · 2018-03-10T19:44:10Z

pandas/core/indexes/accessors.py

+
+        Returns
+        -------
+        datetimes : ndarray


ndarray of object dtype

jreback · 2018-03-10T19:44:21Z

pandas/core/indexes/accessors.py

+
+        See Also
+        --------
+        pd.DatetimeIndex.to_pydatetime : Convert a Timestamp object to a native


pandas.DatetimeIndex.to_pydatetime

jreback · 2018-03-10T19:44:32Z

pandas/core/indexes/accessors.py

+        --------
+        pd.DatetimeIndex.to_pydatetime : Convert a Timestamp object to a native
+            Python datetime object.
+        pd.date.dt.values.to_datetime : For an Index containing strings or


remove this 2nd part which is not valid

jreback · 2018-03-10T19:45:42Z

pandas/core/indexes/accessors.py

+
+        Examples
+        --------
+        >>> df = pd.DataFrame({'date': [pd.to_datetime('2018-03-10'), pd.to_datetime('2017-02-01')]})


make a series like: In [1]: Series(pd.date_range('20180310', periods=2))
show its return, then show the return of using .dt.to_pytdatetime()

TomAugspurger · 2018-03-10T20:07:32Z

@priya-gitTest I think you replied to all of Jeff's comments. Make sure to push your changes when you're ready :)

…to_pydatetime

…eedback

priya-gitTest · 2018-03-10T20:33:18Z

Have pushed the changes. Can you Review them @jreback

jorisvandenbossche · 2018-03-10T22:48:31Z

pandas/core/indexes/accessors.py

@@ -126,6 +126,26 @@ class DatetimeProperties(Properties):
    """

    def to_pydatetime(self):
+        """
+        Return DatetimeIndex as an object ndarray.


I would mention it is an array of "native Python datetime objects" ?

Can you change this to "Return Series" instead of "Return DatetimeIndex" (as it is the accessor on a Series) ?

done, Kindly review

jorisvandenbossche · 2018-03-10T22:48:41Z

pandas/core/indexes/accessors.py

+
+        See Also
+        --------
+        pandas.DatetimeIndex.to_pydatetime : Convert a Timestamp object to a native


This is now referencing itself?

check : https://pandas.pydata.org/pandas-docs/stable/generated/pandas.DatetimeIndex.to_pydatetime.html
and
https://pandas.pydata.org/pandas-docs/stable/generated/pandas.Series.dt.to_pydatetime.html

Ah, sorry! Missed that this one was in accessors.py.

jorisvandenbossche · 2018-03-10T22:49:48Z

pandas/core/indexes/accessors.py

+        >>> df = pd.Series(pd.date_range('20180310', periods=2))
+        >>> type(df)
+        <class 'pandas.core.series.Series'>
+        >>> type(df.dt.to_pydatetime())


I would actually show the output here, instead of inspecting the type (that will also show it is an array, but also show it holds datetime.datetime objects)

jorisvandenbossche · 2018-03-10T22:50:08Z

pandas/core/indexes/accessors.py

+
+        Examples
+        --------
+        >>> df = pd.Series(pd.date_range('20180310', periods=2))


Can you call this s instead of df (since it is a Series)

jorisvandenbossche · 2018-03-10T22:50:24Z

pandas/core/indexes/accessors.py

+        --------
+        >>> df = pd.Series(pd.date_range('20180310', periods=2))
+        >>> type(df)
+        <class 'pandas.core.series.Series'>


This is not needed I think

jorisvandenbossche · 2018-03-10T23:05:07Z

pandas/core/indexes/accessors.py

+
+        Returns
+        -------
+        ndarray of object dtype


-> Series of object dtype

jorisvandenbossche · 2018-03-10T23:05:55Z

@priya-gitTest Updated some of my comments reflecting this is in accessors.py (and not the DatetimeIndex version). The other comments still stand though

…to_pydatetime

…omments

priya-gitTest · 2018-03-10T23:28:05Z

Done, Kindly review

jreback · 2018-03-11T15:05:07Z

lgtm. @jorisvandenbossche @TomAugspurger I am fine that the accessors look this way. possibly could add a pure index example as well.

TomAugspurger · 2018-03-11T15:11:46Z

FYI, this returns an ndarray, not a series or datetimeindex. Fixing up now.

TomAugspurger · 2018-03-11T15:22:10Z

pandas/core/indexes/accessors.py

+        >>> idx.to_pydatetime()
+        array([datetime.datetime(2018, 3, 10, 0, 0),
+               datetime.datetime(2018, 3, 11, 0, 0)], dtype=object)
+        """


I gave up on a tz example since the repr for datetime w/ tz is so long. Wasn't able to make it look nice.

TomAugspurger · 2018-03-11T16:03:12Z

Thanks @priya-gitTest are you able to pull my changes and make these last few recommendations?

priya-gitTest · 2018-03-11T16:05:34Z

Hi @TomAugspurger , I will try to pull and fix changes suggested by @datapythonista

priya-gitTest · 2018-03-11T16:42:50Z

Pushed the fixes. Kindly check !!!

datapythonista · 2018-03-11T17:18:15Z

Sorry, seems like you pushed many commits unrelated to this PR. Can you take a look?

priya-gitTest · 2018-03-11T17:25:14Z

Hi datapythonista,

I had to reset my master. That might be the cause as l had some local changes another DocString changes :(

I had done
git reset --hard HEAD
git clean -f
git pull

Will see , if i can do something about it :(

datapythonista · 2018-03-11T17:34:31Z

I'd say that in general you can just get the new changes to your branch by:

git checkout <your-branch>
git fetch upstream
git merge upstream/master

It may be a bit tricky now. I'd do a manual copy of your docstring somewhere else, before playing too much with git. :)

priya-gitTest · 2018-03-11T17:38:17Z

Thanks Marc. Resolving GIT issues are indeed tricky. I did used those steps but i wanted to work on another function and it had an un-commited file changes , hence some errors ...

priya-gitTest · 2018-03-11T17:44:36Z

Found this one for future http://blog.dennisrobinson.name/push-only-one-commit-with-git/.
Not going to play around with this on this branch ;)

TomAugspurger · 2018-03-12T16:25:25Z

Removedd the references to DatetimeIndex. Sorry about messing that up intitially @priya-gitTest.

TomAugspurger · 2018-03-12T16:27:27Z

Ah one thing I just thought of, we should add a warning about nanosecond-precision data not being supported by python's datetime.datetime.

In [13]: idx = pd.date_range('2017', periods=4, freq='ns')

In [14]: idx
Out[14]:
DatetimeIndex([          '2017-01-01 00:00:00',
               '2017-01-01 00:00:00.000000001',
               '2017-01-01 00:00:00.000000002',
               '2017-01-01 00:00:00.000000003'],
              dtype='datetime64[ns]', freq='N')

In [15]: idx.to_pydatetime()
Out[15]:
array([datetime.datetime(2017, 1, 1, 0, 0),
       datetime.datetime(2017, 1, 1, 0, 0),
       datetime.datetime(2017, 1, 1, 0, 0),
       datetime.datetime(2017, 1, 1, 0, 0)], dtype=object)

@priya-gitTest do you want to handle that? It should probably go in a ..warning box right after the note about timezone info being retained, and as an example.

priya-gitTest · 2018-03-12T17:40:57Z

Hi @TomAugspurger , I would have loved to fix it but i have messed up my local GIT repository. I could only undo upto your good changes of 35ce553 . Whenever i pull or push , i have merge conflicts and i don't want to push other people's changes via my PUSH. So, just let me know when i can close or delete my branch.

datapythonista · 2018-03-12T18:06:07Z

@priya-gitTest I think your branch looks all right now. May be I'm missing something, but I'd say that:

git checkout docstring_series_to_pydatetime
git pull
git fetch upstream
git merge upstream/master

shouldn't give you any conflict, and leave your changes with the latest version.

Otherwise, you can always do a new git clone, in a different directory, create a branch with the same name, change manually the docstring there, commit, and push to the remote branch (I think git push -u -f origin docstring_series_to_pydatetime should do the trick).

jorisvandenbossche · 2018-03-12T18:14:57Z

pandas/core/indexes/accessors.py

+
+        pandas' nanosecond precision is truncated to microseconds.
+
+        >>> idx = pd.date_range('2017', periods=2, freq='ns')


can you use a Series example here?

Btw, I dont get the same output as you @TomAugspurger for the nanosecond-precision data in the jupyter notebook.
I run my code on Windows !
Strangely the docstring Validation test passes, so it must be going right.

Strange, not sure why that would be.

Are you able to wrap that in a Series and do ser.dt.to_pydatetimte()? I'll it once you update.

TomAugspurger · 2018-03-12T18:15:08Z

And there's always the nuclear option of git reset --hard <branch> so git reset --hard origin/ docstring_series_to_pydatetime in this case. But that throws away local changes.

jorisvandenbossche · 2018-03-12T18:15:10Z

pandas/core/indexes/accessors.py

+        Examples
+        --------
+        >>> s = pd.Series(pd.date_range('20180310', periods=2))
+        >>> s.head()


head can be removed

priya-gitTest · 2018-03-12T18:46:41Z

Thanks all. I will give it a shot in a while and keep you
posted :)

…to_pydatetime

…riya-gitTest/pandas into docstring_series_to_pydatetime

…econd scenario

priya-gitTest · 2018-03-13T02:23:26Z

kindly review @jorisvandenbossche @TomAugspurger

codecov · 2018-03-13T10:52:24Z

Codecov Report

Merging #20198 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #20198   +/-   ##
=======================================
  Coverage   91.72%   91.72%           
=======================================
  Files         150      150           
  Lines       49165    49165           
=======================================
  Hits        45099    45099           
  Misses       4066     4066

Flag	Coverage Δ
#multiple	`90.11% <ø> (ø)`	⬆️
#single	`41.86% <ø> (ø)`	⬆️

Impacted Files	Coverage Δ
pandas/core/indexes/accessors.py	`90.19% <ø> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 31afaf8...932feff. Read the comment docs.

jorisvandenbossche

Thanks for the updates, looks good now!

jorisvandenbossche · 2018-03-13T10:53:00Z

And thanks for the PR! @priya-gitTest

priya-gitTest · 2018-03-13T19:22:30Z

Thanks everyone here again :)

PO: made docstring changes to pandas.Series.dt.to_pydatetime

6480b22

priya-gitTest closed this Mar 10, 2018

priya-gitTest reopened this Mar 10, 2018

priya-gitTest closed this Mar 10, 2018

priya-gitTest changed the title ~~PO: made docstring changes to pandas.Series.dt.to_pydatetime~~ Docstring changes to pandas.Series.dt.to_pydatetime Mar 10, 2018

priya-gitTest added 2 commits March 10, 2018 18:01

Merge remote-tracking branch 'upstream/master' into docstring_series_…

6a643fc

…to_pydatetime

Docstring changes to pandas.Series.dt.to_pydatetime, fixed PEP8 errors

e4dbd78

priya-gitTest reopened this Mar 10, 2018

jreback requested changes Mar 10, 2018

View reviewed changes

jreback added Docs Datetime Datetime data dtype labels Mar 10, 2018

priya-gitTest added 2 commits March 10, 2018 21:12

Merge remote-tracking branch 'upstream/master' into docstring_series_…

5523dd5

…to_pydatetime

DOCSTRING : pandas.Series.dt.to_pydatetime : Incorporated Reviewers F…

c83eff0

…eedback

jorisvandenbossche mentioned this pull request Mar 10, 2018

DOC: find solution for shared docstrings of DatetimeIndex and Series.dt #20258

Open

jorisvandenbossche reviewed Mar 10, 2018

View reviewed changes

pandas/core/indexes/accessors.py Outdated

Returns

-------

ndarray of object dtype

Copy link

Member

jorisvandenbossche Mar 10, 2018

Choose a reason for hiding this comment

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

-> Series of object dtype

priya-gitTest added 2 commits March 11, 2018 00:24

Merge remote-tracking branch 'upstream/master' into docstring_series_…

04dbd04

…to_pydatetime

DOCSTRING : pandas.Series.dt.to_pydatetime : Incorporated Reviewers c…

4f73176

…omments

jreback added this to the 0.23.0 milestone Mar 11, 2018

jreback approved these changes Mar 11, 2018

View reviewed changes

Updated return time, added DTI example

35ce553

TomAugspurger reviewed Mar 11, 2018

View reviewed changes

priya-gitTest force-pushed the docstring_series_to_pydatetime branch from 28d5a8a to 35ce553 Compare March 11, 2018 21:24

Removed DTI references

0279ae8

jorisvandenbossche mentioned this pull request Mar 12, 2018

API/INT: why is to_pydatetime handled differently in Series.dt accessor? #20306

Closed

Added warning

d8fe91d

jorisvandenbossche reviewed Mar 12, 2018

View reviewed changes

priya-gitTest added 3 commits March 13, 2018 01:29

Merge remote-tracking branch 'upstream/master' into docstring_series_…

2dd734c

…to_pydatetime

Merge branch 'docstring_series_to_pydatetime' of https://github.com/p…

e010c13

…riya-gitTest/pandas into docstring_series_to_pydatetime

Docstring_series_dt_to_pydatetime : Added example of Series for nanos…

34b4e99

…econd scenario

Update accessors.py

932feff

jorisvandenbossche approved these changes Mar 13, 2018

View reviewed changes

jorisvandenbossche merged commit 0cd5c5c into pandas-dev:master Mar 13, 2018


		pandas' nanosecond precision is truncated to microseconds.

		>>> idx = pd.date_range('2017', periods=2, freq='ns')

Docstring changes to pandas.Series.dt.to_pydatetime #20198

Docstring changes to pandas.Series.dt.to_pydatetime #20198

Conversation

priya-gitTest commented Mar 10, 2018 • edited Loading

pep8speaks commented Mar 10, 2018 • edited Loading

Comment last updated on March 13, 2018 at 10:52 Hours UTC

priya-gitTest commented Mar 10, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TomAugspurger commented Mar 10, 2018

priya-gitTest commented Mar 10, 2018

Choose a reason for hiding this comment

jorisvandenbossche Mar 10, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jorisvandenbossche commented Mar 10, 2018

priya-gitTest commented Mar 10, 2018

jreback commented Mar 11, 2018

TomAugspurger commented Mar 11, 2018

Choose a reason for hiding this comment

TomAugspurger commented Mar 11, 2018

priya-gitTest commented Mar 11, 2018

priya-gitTest commented Mar 11, 2018

datapythonista commented Mar 11, 2018

priya-gitTest commented Mar 11, 2018 • edited Loading

datapythonista commented Mar 11, 2018

priya-gitTest commented Mar 11, 2018

priya-gitTest commented Mar 11, 2018

TomAugspurger commented Mar 12, 2018

TomAugspurger commented Mar 12, 2018 • edited Loading

priya-gitTest commented Mar 12, 2018

datapythonista commented Mar 12, 2018

Choose a reason for hiding this comment

priya-gitTest Mar 13, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TomAugspurger commented Mar 12, 2018 • edited Loading

Choose a reason for hiding this comment

priya-gitTest commented Mar 12, 2018

priya-gitTest commented Mar 13, 2018

codecov bot commented Mar 13, 2018

Codecov Report

jorisvandenbossche left a comment

Choose a reason for hiding this comment

jorisvandenbossche commented Mar 13, 2018

priya-gitTest commented Mar 13, 2018

priya-gitTest commented Mar 10, 2018 •

edited

Loading

pep8speaks commented Mar 10, 2018 •

edited

Loading

jorisvandenbossche Mar 10, 2018 •

edited

Loading

priya-gitTest commented Mar 11, 2018 •

edited

Loading

TomAugspurger commented Mar 12, 2018 •

edited

Loading

priya-gitTest Mar 13, 2018 •

edited

Loading

TomAugspurger commented Mar 12, 2018 •

edited

Loading