From 536b7c882f07babc26c02a66ce9284db54162091 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dea=20Mar=C3=ADa=20L=C3=A9on?= Date: Fri, 23 Jun 2023 17:09:26 +0200 Subject: [PATCH 1/4] Examples api.types, Sparse, TZDtype --- pandas/_libs/lib.pyx | 32 ++++++++++++++++++++++++++++++++ pandas/core/dtypes/common.py | 5 +++++ pandas/core/dtypes/dtypes.py | 35 +++++++++++++++++++++++++++++++++++ 3 files changed, 72 insertions(+) diff --git a/pandas/_libs/lib.pyx b/pandas/_libs/lib.pyx index a622de742a840..c3fbd3ee4853e 100644 --- a/pandas/_libs/lib.pyx +++ b/pandas/_libs/lib.pyx @@ -1056,6 +1056,14 @@ def is_float(obj: object) -> bool: Returns ------- bool + + Examples + -------- + >>> pd.api.types.is_float(1.0) + True + + >>> pd.api.types.is_float(1) + False """ return util.is_float_object(obj) @@ -1067,6 +1075,14 @@ def is_integer(obj: object) -> bool: Returns ------- bool + + Examples + -------- + >>> pd.api.types.is_integer(1) + True + + >>> pd.api.types.is_integer(1.0) + False """ return util.is_integer_object(obj) @@ -1089,6 +1105,14 @@ def is_bool(obj: object) -> bool: Returns ------- bool + + Examples + -------- + >>> pd.api.types.is_bool(True) + True + + >>> pd.api.types.is_bool(1) + False """ return util.is_bool_object(obj) @@ -1100,6 +1124,14 @@ def is_complex(obj: object) -> bool: Returns ------- bool + + Examples + -------- + >>> pd.api.types.is_complex(1 + 1j) + True + + >>> pd.api.types.is_complex(1) + False """ return util.is_complex_object(obj) diff --git a/pandas/core/dtypes/common.py b/pandas/core/dtypes/common.py index 3931b12e06f9b..16b8e9770e7f3 100644 --- a/pandas/core/dtypes/common.py +++ b/pandas/core/dtypes/common.py @@ -1603,6 +1603,11 @@ def pandas_dtype(dtype) -> DtypeObj: Raises ------ TypeError if not a dtype + + Examples + -------- + >>> pd.api.types.pandas_dtype(int) + dtype('int64') """ # short-circuit if isinstance(dtype, np.ndarray): diff --git a/pandas/core/dtypes/dtypes.py b/pandas/core/dtypes/dtypes.py index c1d3188471aef..6d250ae08cc76 100644 --- a/pandas/core/dtypes/dtypes.py +++ b/pandas/core/dtypes/dtypes.py @@ -756,6 +756,12 @@ def _creso(self) -> int: def unit(self) -> str_type: """ The precision of the datetime data. + + Examples + -------- + >>> dtype = pd.DatetimeTZDtype(tz='dateutil/US/Central') + >>> dtype.unit + 'ns' """ return self._unit @@ -763,6 +769,12 @@ def unit(self) -> str_type: def tz(self) -> tzinfo: """ The timezone. + + Examples + -------- + >>> dtype = pd.DatetimeTZDtype(tz='dateutil/US/Central') + >>> dtype.tz + tzfile('/usr/share/zoneinfo/US/Central') """ return self._tz @@ -951,6 +963,12 @@ def __reduce__(self): def freq(self): """ The frequency object of this PeriodDtype. + + Examples + -------- + >>> dtype = pd.PeriodDtype(freq='D') + >>> dtype.freq + """ return self._freq @@ -1201,6 +1219,12 @@ def closed(self) -> IntervalClosedType: def subtype(self): """ The dtype of the Interval bounds. + + Examples + -------- + >>> dtype = pd.IntervalDtype(subtype='int64', closed='both') + >>> dtype.subtype + dtype('int64') """ return self._subtype @@ -1549,6 +1573,17 @@ class SparseDtype(ExtensionDtype): Methods ------- None + + Examples + -------- + >>> ser = pd.Series([1, 0, 0], dtype=pd.SparseDtype(dtype=int, fill_value=0)) + >>> ser + 0 1 + 1 0 + 2 0 + dtype: Sparse[int64, 0] + >>> ser.sparse.density + 0.3333333333333333 """ # We include `_is_na_fill_value` in the metadata to avoid hash collisions From 40eb2744ec8e20a1c85d55a62f4ceccb1610017b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dea=20Mar=C3=ADa=20L=C3=A9on?= Date: Fri, 23 Jun 2023 18:59:44 +0200 Subject: [PATCH 2/4] Edited code_checks --- ci/code_checks.sh | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/ci/code_checks.sh b/ci/code_checks.sh index 472bd78e4d3bc..5870a9ad8d60b 100755 --- a/ci/code_checks.sh +++ b/ci/code_checks.sh @@ -105,17 +105,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then pandas.errors.UnsupportedFunctionCall \ pandas.test \ pandas.NaT \ - pandas.SparseDtype \ - pandas.DatetimeTZDtype.unit \ - pandas.DatetimeTZDtype.tz \ - pandas.PeriodDtype.freq \ - pandas.IntervalDtype.subtype \ - pandas_dtype \ - pandas.api.types.is_bool \ - pandas.api.types.is_complex \ - pandas.api.types.is_float \ - pandas.api.types.is_integer \ - pandas.api.types.pandas_dtype \ pandas.read_clipboard \ pandas.ExcelFile \ pandas.ExcelFile.parse \ From 5573573a596a233a69c22d48f67cbc74bca0dc15 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dea=20Mar=C3=ADa=20L=C3=A9on?= Date: Sat, 24 Jun 2023 16:08:55 +0200 Subject: [PATCH 3/4] Changed tz to zoneinfo --- pandas/core/dtypes/dtypes.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pandas/core/dtypes/dtypes.py b/pandas/core/dtypes/dtypes.py index ad66763f83a5b..a43cce0044ba8 100644 --- a/pandas/core/dtypes/dtypes.py +++ b/pandas/core/dtypes/dtypes.py @@ -775,7 +775,7 @@ def unit(self) -> str_type: Examples -------- - >>> dtype = pd.DatetimeTZDtype(tz='dateutil/US/Central') + >>> dtype = pd.DatetimeTZDtype(tz='America/Los_Angeles') >>> dtype.unit 'ns' """ @@ -788,9 +788,9 @@ def tz(self) -> tzinfo: Examples -------- - >>> dtype = pd.DatetimeTZDtype(tz='dateutil/US/Central') + >>> dtype = pd.DatetimeTZDtype(tz='America/Los_Angeles') >>> dtype.tz - tzfile('/usr/share/zoneinfo/US/Central') + """ return self._tz From 11747d19b2e938c824bab290641bf4c1c1573546 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dea=20Mar=C3=ADa=20L=C3=A9on?= Date: Mon, 26 Jun 2023 16:42:31 +0200 Subject: [PATCH 4/4] Added ZoneInfo for tz param --- pandas/core/dtypes/dtypes.py | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/pandas/core/dtypes/dtypes.py b/pandas/core/dtypes/dtypes.py index a43cce0044ba8..ea4d10c06efe3 100644 --- a/pandas/core/dtypes/dtypes.py +++ b/pandas/core/dtypes/dtypes.py @@ -697,16 +697,17 @@ class DatetimeTZDtype(PandasExtensionDtype): Raises ------ - pytz.UnknownTimeZoneError + ZoneInfoNotFoundError When the requested timezone cannot be found. Examples -------- - >>> pd.DatetimeTZDtype(tz='UTC') + >>> from zoneinfo import ZoneInfo + >>> pd.DatetimeTZDtype(tz=ZoneInfo('UTC')) datetime64[ns, UTC] - >>> pd.DatetimeTZDtype(tz='dateutil/US/Central') - datetime64[ns, tzfile('/usr/share/zoneinfo/US/Central')] + >>> pd.DatetimeTZDtype(tz=ZoneInfo('Europe/Paris')) + datetime64[ns, Europe/Paris] """ type: type[Timestamp] = Timestamp @@ -775,7 +776,8 @@ def unit(self) -> str_type: Examples -------- - >>> dtype = pd.DatetimeTZDtype(tz='America/Los_Angeles') + >>> from zoneinfo import ZoneInfo + >>> dtype = pd.DatetimeTZDtype(tz=ZoneInfo('America/Los_Angeles')) >>> dtype.unit 'ns' """ @@ -788,9 +790,10 @@ def tz(self) -> tzinfo: Examples -------- - >>> dtype = pd.DatetimeTZDtype(tz='America/Los_Angeles') + >>> from zoneinfo import ZoneInfo + >>> dtype = pd.DatetimeTZDtype(tz=ZoneInfo('America/Los_Angeles')) >>> dtype.tz - + zoneinfo.ZoneInfo(key='America/Los_Angeles') """ return self._tz