Skip to content

Commit 79292b7

Browse files
committed
DOC: Update docs
1 parent 1647d90 commit 79292b7

File tree

5 files changed

+25
-18
lines changed

5 files changed

+25
-18
lines changed

pandas_datareader/_utils.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,13 @@ def _sanitize_dates(start, end):
4343
if end is None:
4444
# default to today
4545
end = dt.date.today()
46-
if start > end:
47-
raise ValueError("start must be an earlier date than end")
48-
4946
try:
5047
start = to_datetime(start)
5148
end = to_datetime(end)
5249
except (TypeError, ValueError):
5350
raise ValueError("Invalid date format.")
51+
if start > end:
52+
raise ValueError("start must be an earlier date than end")
5453
return start, end
5554

5655

pandas_datareader/av/time_series.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ class AVTimeSeriesReader(AlphaVantage):
1515
Single stock symbol (ticker)
1616
start : string, int, date, datetime, timestamp
1717
Starting date. Parses many different kind of date
18-
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980')
18+
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980'). Defaults to
19+
20 years before current date.
1920
end : string, int, date, datetime, timestamp
2021
Ending date
2122
retry_count : int, default 3

pandas_datareader/base.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ class _BaseReader(object):
2828
----------
2929
symbols : {str, List[str]}
3030
String symbol of like of symbols
31-
start : string, (defaults to 5 years before current date)
32-
Starting date, timestamp. Parses many different kind of date
31+
start : string, int, date, datetime, timestamp
32+
Starting date. Parses many different kind of date
3333
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980')
34-
end : string, (defaults to today)
35-
Ending date, timestamp. Same format as starting date.
34+
end : string, int, date, datetime, timestamp
35+
Ending date
3636
retry_count : int, default 3
3737
Number of times to retry query request.
3838
pause : float, default 0.1

pandas_datareader/iex/daily.py

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,12 @@ class IEXDailyReader(_DailyBaseReader):
2727
symbols : string, array-like object (list, tuple, Series), or DataFrame
2828
Single stock symbol (ticker), array-like object of symbols or
2929
DataFrame with index containing stock symbols.
30-
start : string, (defaults to '1/1/2010')
31-
Starting date, timestamp. Parses many different kind of date
32-
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980')
33-
end : string, (defaults to today)
34-
Ending date, timestamp. Same format as starting date.
30+
start : string, int, date, datetime, timestamp
31+
Starting date. Parses many different kind of date
32+
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980'). Defaults to
33+
15 years before current date
34+
end : string, int, date, datetime, timestamp
35+
Ending date
3536
retry_count : int, default 3
3637
Number of times to retry query request.
3738
pause : int, default 0.1
@@ -80,6 +81,11 @@ def __init__(
8081
chunksize=chunksize,
8182
)
8283

84+
@property
85+
def default_start_date(self):
86+
today = datetime.date.today()
87+
return today - datetime.timedelta(days=365 * 15)
88+
8389
@property
8490
def url(self):
8591
"""API URL"""

pandas_datareader/yahoo/daily.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,12 @@ class YahooDailyReader(_DailyBaseReader):
2222
symbols : string, array-like object (list, tuple, Series), or DataFrame
2323
Single stock symbol (ticker), array-like object of symbols or
2424
DataFrame with index containing stock symbols.
25-
start : string, (defaults to '1/1/2010')
26-
Starting date, timestamp. Parses many different kind of date
27-
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980')
28-
end : string, (defaults to today)
29-
Ending date, timestamp. Same format as starting date.
25+
start : string, int, date, datetime, timestamp
26+
Starting date. Parses many different kind of date
27+
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980'). Defaults to
28+
15 years before current date.
29+
end : string, int, date, datetime, timestamp
30+
Ending date
3031
retry_count : int, default 3
3132
Number of times to retry query request.
3233
pause : int, default 0.1

0 commit comments

Comments
 (0)