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

de-privatize timezone functions #17543

Merged
merged 9 commits into from
Sep 23, 2017
Merged

de-privatize timezone functions #17543

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d77c181
de-privatize timezone functions
jbrockmendel Sep 15, 2017
3f45e61
fixup typo
jbrockmendel Sep 15, 2017
4b33f33
typo fixup nameerror
jbrockmendel Sep 16, 2017
acf6dbd
Fix de-privatized import
jbrockmendel Sep 16, 2017
5fa670e
Import timezone funcs directly from tslibs.timezones
jbrockmendel Sep 16, 2017
d77cbba
flake8 fixup remove unused import
jbrockmendel Sep 17, 2017
4898150
reprivative p_tz_cache_key, lint whitespace fixup
jbrockmendel Sep 17, 2017
b945494
Dont alias dateutil_gettz
jbrockmendel Sep 17, 2017
b6a14c2
Remove aliasing for dateutil_gettz
jbrockmendel Sep 18, 2017
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
6 changes: 3 additions & 3 deletions pandas/_libs/period.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ from pandas._libs import tslib, lib
from pandas._libs.tslib import (Timedelta, Timestamp, iNaT,
NaT)
from tslibs.timezones cimport (
is_utc, is_tzlocal, get_utcoffset, _get_dst_info, maybe_get_tz)
is_utc, is_tzlocal, get_utcoffset, get_dst_info, maybe_get_tz)
from tslib cimport _nat_scalar_rules

from tslibs.frequencies cimport get_freq_code
Expand Down Expand Up @@ -557,7 +557,7 @@ cdef _reso_local(ndarray[int64_t] stamps, object tz):
reso = curr_reso
else:
# Adjust datetime64 timestamp, recompute datetimestruct
trans, deltas, typ = _get_dst_info(tz)
trans, deltas, typ = get_dst_info(tz)

_pos = trans.searchsorted(stamps, side='right') - 1
if _pos.dtype != np.int64:
Expand Down Expand Up @@ -624,7 +624,7 @@ cdef ndarray[int64_t] localize_dt64arr_to_period(ndarray[int64_t] stamps,
dts.us, dts.ps, freq)
else:
# Adjust datetime64 timestamp, recompute datetimestruct
trans, deltas, typ = _get_dst_info(tz)
trans, deltas, typ = get_dst_info(tz)

_pos = trans.searchsorted(stamps, side='right') - 1
if _pos.dtype != np.int64:
Expand Down
32 changes: 16 additions & 16 deletions pandas/_libs/tslib.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,16 +100,16 @@ iNaT = NPY_NAT


from tslibs.timezones cimport (
is_utc, is_tzlocal, _is_fixed_offset,
is_utc, is_tzlocal, is_fixed_offset,
treat_tz_as_dateutil, treat_tz_as_pytz,
get_timezone, get_utcoffset, maybe_get_tz,
_get_dst_info
get_dst_info
)
from tslibs.timezones import ( # noqa
get_timezone, get_utcoffset, maybe_get_tz,
_p_tz_cache_key, dst_cache,
_unbox_utcoffsets,
_dateutil_gettz
p_tz_cache_key, dst_cache,
Copy link
Contributor

Choose a reason for hiding this comment

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

are all of these actually used in tslib or just other modules import them? if so then just import directly from time zones

unbox_utcoffsets,
dateutil_gettz
)


Expand Down Expand Up @@ -167,7 +167,7 @@ def ints_to_pydatetime(ndarray[int64_t] arr, tz=None, freq=None, box=False):
pandas_datetime_to_datetimestruct(
value, PANDAS_FR_ns, &dts)
result[i] = func_create(value, dts, tz, freq)
elif is_tzlocal(tz) or _is_fixed_offset(tz):
elif is_tzlocal(tz) or is_fixed_offset(tz):
for i in range(n):
value = arr[i]
if value == NPY_NAT:
Expand All @@ -181,7 +181,7 @@ def ints_to_pydatetime(ndarray[int64_t] arr, tz=None, freq=None, box=False):
dt = Timestamp(dt)
result[i] = dt
else:
trans, deltas, typ = _get_dst_info(tz)
trans, deltas, typ = get_dst_info(tz)

for i in range(n):

Expand Down Expand Up @@ -1641,12 +1641,12 @@ cdef inline void _localize_tso(_TSObject obj, object tz):
obj.tzinfo = tz
else:
# Adjust datetime64 timestamp, recompute datetimestruct
trans, deltas, typ = _get_dst_info(tz)
trans, deltas, typ = get_dst_info(tz)

pos = trans.searchsorted(obj.value, side='right') - 1

# static/pytz/dateutil specific code
if _is_fixed_offset(tz):
if is_fixed_offset(tz):
# statictzinfo
if len(deltas) > 0 and obj.value != NPY_NAT:
pandas_datetime_to_datetimestruct(obj.value + deltas[0],
Expand Down Expand Up @@ -4066,7 +4066,7 @@ def tz_convert(ndarray[int64_t] vals, object tz1, object tz2):
* 1000000000)
utc_dates[i] = v - delta
else:
trans, deltas, typ = _get_dst_info(tz1)
trans, deltas, typ = get_dst_info(tz1)

# all-NaT
tt = vals[vals!=NPY_NAT]
Expand Down Expand Up @@ -4108,7 +4108,7 @@ def tz_convert(ndarray[int64_t] vals, object tz1, object tz2):
return result

# Convert UTC to other timezone
trans, deltas, typ = _get_dst_info(tz2)
trans, deltas, typ = get_dst_info(tz2)

# use first non-NaT element
# if all-NaT, return all-NaT
Expand Down Expand Up @@ -4172,7 +4172,7 @@ def tz_convert_single(int64_t val, object tz1, object tz2):
delta = int(get_utcoffset(tz1, dt).total_seconds()) * 1000000000
utc_date = val - delta
elif get_timezone(tz1) != 'UTC':
trans, deltas, typ = _get_dst_info(tz1)
trans, deltas, typ = get_dst_info(tz1)
pos = trans.searchsorted(val, side='right') - 1
if pos < 0:
raise ValueError('First time before start of DST info')
Expand All @@ -4191,7 +4191,7 @@ def tz_convert_single(int64_t val, object tz1, object tz2):
return utc_date + delta

# Convert UTC to other timezone
trans, deltas, typ = _get_dst_info(tz2)
trans, deltas, typ = get_dst_info(tz2)

pos = trans.searchsorted(utc_date, side='right') - 1
if pos < 0:
Expand Down Expand Up @@ -4261,7 +4261,7 @@ def tz_localize_to_utc(ndarray[int64_t] vals, object tz, object ambiguous=None,
"Length of ambiguous bool-array must be the same size as vals")
ambiguous_array = np.asarray(ambiguous)

trans, deltas, typ = _get_dst_info(tz)
trans, deltas, typ = get_dst_info(tz)

tdata = <int64_t*> trans.data
ntrans = len(trans)
Expand Down Expand Up @@ -4967,7 +4967,7 @@ cdef _normalize_local(ndarray[int64_t] stamps, object tz):
result[i] = _normalized_stamp(&dts)
else:
# Adjust datetime64 timestamp, recompute datetimestruct
trans, deltas, typ = _get_dst_info(tz)
trans, deltas, typ = get_dst_info(tz)

_pos = trans.searchsorted(stamps, side='right') - 1
if _pos.dtype != np.int64:
Expand Down Expand Up @@ -5022,7 +5022,7 @@ def dates_normalized(ndarray[int64_t] stamps, tz=None):
if (dt.hour + dt.minute + dt.second + dt.microsecond) > 0:
return False
else:
trans, deltas, typ = _get_dst_info(tz)
trans, deltas, typ = get_dst_info(tz)

for i in range(n):
# Adjust datetime64 timestamp, recompute datetimestruct
Expand Down
4 changes: 2 additions & 2 deletions pandas/_libs/tslibs/timezones.pxd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ cpdef object get_timezone(object tz)
cpdef object maybe_get_tz(object tz)

cpdef get_utcoffset(tzinfo, obj)
cdef bint _is_fixed_offset(object tz)
cdef bint is_fixed_offset(object tz)

cdef object _get_dst_info(object tz)
cdef object get_dst_info(object tz)
28 changes: 14 additions & 14 deletions pandas/_libs/tslibs/timezones.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ from dateutil.tz import (
import sys
if sys.platform == 'win32' or sys.platform == 'cygwin':
# equiv pd.compat.is_platform_windows()
from dateutil.zoneinfo import gettz as _dateutil_gettz
from dateutil.zoneinfo import gettz as dateutil_gettz
else:
from dateutil.tz import gettz as _dateutil_gettz
from dateutil.tz import gettz as dateutil_gettz


from pytz.tzinfo import BaseTzInfo as _pytz_BaseTzInfo
Expand Down Expand Up @@ -100,7 +100,7 @@ cpdef inline object maybe_get_tz(object tz):
tz = _dateutil_tzlocal()
elif tz.startswith('dateutil/'):
zone = tz[9:]
tz = _dateutil_gettz(zone)
tz = dateutil_gettz(zone)
Copy link
Contributor

@jreback jreback Sep 17, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

so would like to rename these to be more consistent, maybe
get_timezone_from_dateutil

ok with doing it in this PR

# On Python 3 on Windows, the filename is not always set correctly.
if isinstance(tz, _dateutil_tzfile) and '.tar.gz' in tz._filename:
tz._filename = zone
Expand All @@ -111,16 +111,16 @@ cpdef inline object maybe_get_tz(object tz):
return tz


def _p_tz_cache_key(tz):
def p_tz_cache_key(tz):
""" Python interface for cache function to facilitate testing."""
Copy link
Contributor

Choose a reason for hiding this comment

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

this is dumb that we are exposing a function just to test. I don't think this is actually necessary and should be removed (so maybe leave this one as private).

Copy link
Member Author

Choose a reason for hiding this comment

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

Yah, best guess is that was created before cpdef was an option. Will re-privatize.

return _tz_cache_key(tz)
return tz_cache_key(tz)


# Timezone data caches, key is the pytz string or dateutil file name.
dst_cache = {}


cdef inline object _tz_cache_key(object tz):
cdef inline object tz_cache_key(object tz):
"""
Return the key in the cache for the timezone info object or None
if unknown.
Expand Down Expand Up @@ -163,7 +163,7 @@ cpdef get_utcoffset(tzinfo, obj):
return tzinfo.utcoffset(obj)


cdef inline bint _is_fixed_offset(object tz):
cdef inline bint is_fixed_offset(object tz):
if treat_tz_as_dateutil(tz):
if len(tz._trans_idx) == 0 and len(tz._trans_list) == 0:
return 1
Expand All @@ -178,7 +178,7 @@ cdef inline bint _is_fixed_offset(object tz):
return 1


cdef object _get_utc_trans_times_from_dateutil_tz(object tz):
cdef object get_utc_trans_times_from_dateutil_tz(object tz):
"""
Transition times in dateutil timezones are stored in local non-dst
time. This code converts them to UTC. It's the reverse of the code
Expand All @@ -193,7 +193,7 @@ cdef object _get_utc_trans_times_from_dateutil_tz(object tz):
return new_trans


cpdef ndarray _unbox_utcoffsets(object transinfo):
cpdef ndarray unbox_utcoffsets(object transinfo):
cdef:
Py_ssize_t i, sz
ndarray[int64_t] arr
Expand All @@ -211,15 +211,15 @@ cpdef ndarray _unbox_utcoffsets(object transinfo):
# Daylight Savings


cdef object _get_dst_info(object tz):
cdef object get_dst_info(object tz):
"""
return a tuple of :
(UTC times of DST transitions,
UTC offsets in microseconds corresponding to DST transitions,
string of type of transitions)

"""
cache_key = _tz_cache_key(tz)
cache_key = tz_cache_key(tz)
if cache_key is None:
num = int(get_utcoffset(tz, None).total_seconds()) * 1000000000
return (np.array([NPY_NAT + 1], dtype=np.int64),
Expand All @@ -235,13 +235,13 @@ cdef object _get_dst_info(object tz):
trans[0] = NPY_NAT + 1
except Exception:
pass
deltas = _unbox_utcoffsets(tz._transition_info)
deltas = unbox_utcoffsets(tz._transition_info)
typ = 'pytz'

elif treat_tz_as_dateutil(tz):
if len(tz._trans_list):
# get utc trans times
trans_list = _get_utc_trans_times_from_dateutil_tz(tz)
trans_list = get_utc_trans_times_from_dateutil_tz(tz)
trans = np.hstack([
np.array([0], dtype='M8[s]'), # place holder for first item
np.array(trans_list, dtype='M8[s]')]).astype(
Expand All @@ -255,7 +255,7 @@ cdef object _get_dst_info(object tz):
deltas *= 1000000000
typ = 'dateutil'

elif _is_fixed_offset(tz):
elif is_fixed_offset(tz):
trans = np.array([NPY_NAT + 1], dtype=np.int64)
deltas = np.array([tz._ttinfo_std.offset],
dtype='i8') * 1000000000
Expand Down
2 changes: 1 addition & 1 deletion pandas/tests/indexes/datetimes/test_setops.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ def test_month_range_union_tz_pytz(self):
def test_month_range_union_tz_dateutil(self):
tm._skip_if_windows_python_3()

from pandas._libs.tslib import _dateutil_gettz as timezone
from pandas._libs.tslib import dateutil_gettz as timezone
tz = timezone('US/Eastern')

early_start = datetime(2011, 1, 1)
Expand Down
4 changes: 2 additions & 2 deletions pandas/tests/scalar/test_period.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ def test_timestamp_tz_arg(self):
assert p.tz == exp.tz

def test_timestamp_tz_arg_dateutil(self):
from pandas._libs.tslib import _dateutil_gettz as gettz
from pandas._libs.tslib import dateutil_gettz as gettz
from pandas._libs.tslib import maybe_get_tz
for case in ['dateutil/Europe/Brussels', 'dateutil/Asia/Tokyo',
'dateutil/US/Pacific']:
Expand All @@ -264,7 +264,7 @@ def test_timestamp_tz_arg_dateutil(self):
assert p.tz == exp.tz

def test_timestamp_tz_arg_dateutil_from_string(self):
from pandas._libs.tslib import _dateutil_gettz as gettz
from pandas._libs.tslib import dateutil_gettz as gettz
p = Period('1/1/2005',
freq='M').to_timestamp(tz='dateutil/Europe/Brussels')
assert p.tz == gettz('Europe/Brussels')
Expand Down
2 changes: 1 addition & 1 deletion pandas/tests/scalar/test_timestamp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1295,7 +1295,7 @@ def test_timestamp_to_datetime_explicit_pytz(self):
def test_timestamp_to_datetime_explicit_dateutil(self):
tm._skip_if_windows_python_3()

from pandas._libs.tslib import _dateutil_gettz as gettz
from pandas._libs.tslib import dateutil_gettz as gettz
rng = date_range('20090415', '20090519', tz=gettz('US/Eastern'))

stamp = rng[0]
Expand Down
2 changes: 1 addition & 1 deletion pandas/tests/series/test_indexing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,7 @@ def test_getitem_setitem_datetime_tz_pytz(self):

def test_getitem_setitem_datetime_tz_dateutil(self):
from dateutil.tz import tzutc
from pandas._libs.tslib import _dateutil_gettz as gettz
from pandas._libs.tslib import dateutil_gettz as gettz

tz = lambda x: tzutc() if x == 'UTC' else gettz(
x) # handle special case for utc in dateutil
Expand Down
2 changes: 1 addition & 1 deletion pandas/tests/tseries/test_timezones.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1181,7 +1181,7 @@ def test_cache_keys_are_distinct_for_pytz_vs_dateutil(self):
if tz_d is None:
# skip timezones that dateutil doesn't know about.
continue
assert tslib._p_tz_cache_key(tz_p) != tslib._p_tz_cache_key(tz_d)
assert tslib.p_tz_cache_key(tz_p) != tslib.p_tz_cache_key(tz_d)


class TestTimeZones(object):
Expand Down