From 1b24cedce5265cac0bd8a1c80aa7d0008b7fbf6b Mon Sep 17 00:00:00 2001 From: Laura <35954013+LauraCollard@users.noreply.github.com> Date: Tue, 1 Oct 2019 14:46:26 +0100 Subject: [PATCH 1/5] DOC: Fixed PR06 docstrings errors in pandas.timedelta_range --- pandas/core/indexes/timedeltas.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/pandas/core/indexes/timedeltas.py b/pandas/core/indexes/timedeltas.py index b03d60c7b5b37..49dcea4da5760 100644 --- a/pandas/core/indexes/timedeltas.py +++ b/pandas/core/indexes/timedeltas.py @@ -717,17 +717,17 @@ def timedelta_range( Parameters ---------- - start : string or timedelta-like, default None + start : str or timedelta-like, default None Left bound for generating timedeltas - end : string or timedelta-like, default None + end : str or timedelta-like, default None Right bound for generating timedeltas - periods : integer, default None + periods : int, default None Number of periods to generate - freq : string or DateOffset, default 'D' + freq : str or DateOffset, default 'D' Frequency strings can have multiples, e.g. '5H' - name : string, default None + name : str, default None Name of the resulting TimedeltaIndex - closed : string, default None + closed : str, default None Make the interval closed with respect to the given frequency to the 'left', 'right', or both sides (None) From b73758c37a004c912e806e0197962a7b7c0ec5f9 Mon Sep 17 00:00:00 2001 From: Laura <35954013+LauraCollard@users.noreply.github.com> Date: Tue, 1 Oct 2019 16:16:43 +0100 Subject: [PATCH 2/5] add typing to timedelta_range --- pandas/core/indexes/timedeltas.py | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/pandas/core/indexes/timedeltas.py b/pandas/core/indexes/timedeltas.py index 49dcea4da5760..9229cb43c5a00 100644 --- a/pandas/core/indexes/timedeltas.py +++ b/pandas/core/indexes/timedeltas.py @@ -2,6 +2,8 @@ from datetime import datetime import warnings +from typing import Optional + import numpy as np from pandas._libs import NaT, Timedelta, index as libindex, join as libjoin, lib @@ -709,8 +711,13 @@ def _is_convertible_to_index(other): def timedelta_range( - start=None, end=None, periods=None, freq=None, name=None, closed=None -): + start: Optional[str], + end: Optional[str], + periods: Optional[int], + freq: Optional[str], + name: Optional[str], + closed: Optional[str], +) -> TimedeltaIndex: """ Return a fixed frequency TimedeltaIndex, with day as the default frequency. From 6a54a5517aac135a10d8cacbc5aadb8c3028f408 Mon Sep 17 00:00:00 2001 From: Laura <35954013+LauraCollard@users.noreply.github.com> Date: Tue, 1 Oct 2019 16:51:01 +0100 Subject: [PATCH 3/5] fix issue with Optional type and None --- pandas/core/indexes/timedeltas.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/pandas/core/indexes/timedeltas.py b/pandas/core/indexes/timedeltas.py index 9229cb43c5a00..a4a713065ce51 100644 --- a/pandas/core/indexes/timedeltas.py +++ b/pandas/core/indexes/timedeltas.py @@ -711,12 +711,12 @@ def _is_convertible_to_index(other): def timedelta_range( - start: Optional[str], - end: Optional[str], - periods: Optional[int], - freq: Optional[str], - name: Optional[str], - closed: Optional[str], + start: Optional[str] = None, + end: Optional[str] = None, + periods: Optional[int] = None, + freq: Optional[str] = None, + name: Optional[str] = None, + closed: Optional[str] = None, ) -> TimedeltaIndex: """ Return a fixed frequency TimedeltaIndex, with day as the default From 93319f099f7e74e56e480b2c29a98a732f995062 Mon Sep 17 00:00:00 2001 From: Laura <35954013+LauraCollard@users.noreply.github.com> Date: Tue, 1 Oct 2019 20:35:30 +0100 Subject: [PATCH 4/5] revert to pure types --- pandas/core/indexes/timedeltas.py | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/pandas/core/indexes/timedeltas.py b/pandas/core/indexes/timedeltas.py index a4a713065ce51..fc97a5a57ad6a 100644 --- a/pandas/core/indexes/timedeltas.py +++ b/pandas/core/indexes/timedeltas.py @@ -2,8 +2,6 @@ from datetime import datetime import warnings -from typing import Optional - import numpy as np from pandas._libs import NaT, Timedelta, index as libindex, join as libjoin, lib @@ -711,12 +709,12 @@ def _is_convertible_to_index(other): def timedelta_range( - start: Optional[str] = None, - end: Optional[str] = None, - periods: Optional[int] = None, - freq: Optional[str] = None, - name: Optional[str] = None, - closed: Optional[str] = None, + start: str = None, + end: str = None, + periods: int = None, + freq: str = None, + name: str = None, + closed: str = None, ) -> TimedeltaIndex: """ Return a fixed frequency TimedeltaIndex, with day as the default From 301f3d4bbfdfd92f8bb910453d90f9d80bda18d9 Mon Sep 17 00:00:00 2001 From: Laura <35954013+LauraCollard@users.noreply.github.com> Date: Tue, 1 Oct 2019 20:42:20 +0100 Subject: [PATCH 5/5] remove typing for a separate PR --- pandas/core/indexes/timedeltas.py | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/pandas/core/indexes/timedeltas.py b/pandas/core/indexes/timedeltas.py index fc97a5a57ad6a..49dcea4da5760 100644 --- a/pandas/core/indexes/timedeltas.py +++ b/pandas/core/indexes/timedeltas.py @@ -709,13 +709,8 @@ def _is_convertible_to_index(other): def timedelta_range( - start: str = None, - end: str = None, - periods: int = None, - freq: str = None, - name: str = None, - closed: str = None, -) -> TimedeltaIndex: + start=None, end=None, periods=None, freq=None, name=None, closed=None +): """ Return a fixed frequency TimedeltaIndex, with day as the default frequency.