future annotations

Author: MarcoGorelli

.pre-commit-config.yaml

@@ -156,6 +156,21 @@ repos:
             |(pd|pandas)\.api\.types\.
         files: ^pandas/tests/
         types_or: [python, cython, rst]
+    -   id: future-annotations
+        name: Use from __future__ import annotations in source code
+        language: pygrep
+        entry: from __future__ import annotations
+        files: ^pandas/
+        exclude: |
+            (?x)
+            __init__\.py$
+            |^pandas/tests/
+            |^pandas/testing\.py
+            |api\.py$
+            |pandas/io/formats/_color_data\.py
+            |pandas/io/sas/sas_constants\.py
+        args: [--negate]
+        types: [python]
     -   id: pip-to-conda
         name: Generate pip dependency from conda
         description: This hook checks if the conda environment.yml and requirements-dev.txt are equal

pandas/_config/config.py

@@ -48,6 +48,8 @@
 
 """
 
+from __future__ import annotations
+
 from collections import namedtuple
 from contextlib import (
     ContextDecorator,

pandas/_config/dates.py

@@ -1,6 +1,8 @@
 """
 config for datetime formatting
 """
+from __future__ import annotations
+
 from pandas._config import config as cf
 
 pc_date_dayfirst_doc = """

pandas/_config/display.py

@@ -2,6 +2,8 @@
 Unopinionated display configuration.
 """
 
+from __future__ import annotations
+
 import locale
 import sys
 from typing import Optional

pandas/_config/localization.py

@@ -3,6 +3,8 @@
 
 Name `localization` is chosen to avoid overlap with builtin `locale` module.
 """
+from __future__ import annotations
+
 from contextlib import contextmanager
 import locale
 import re

pandas/_testing/_io.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import bz2
 from functools import wraps
 import gzip

pandas/_testing/_random.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import string
 
 import numpy as np

pandas/_testing/_warnings.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from contextlib import contextmanager
 import re
 from typing import (

pandas/_testing/asserters.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import (
     Union,
     cast,

pandas/_testing/compat.py

@@ -2,6 +2,8 @@
 Helpers for sharing tests between DataFrame/Series
 """
 
+from __future__ import annotations
+
 from pandas import DataFrame
 
 

pandas/_testing/contexts.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from contextlib import contextmanager
 import os
 from pathlib import Path

pandas/_typing.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from datetime import (
     datetime,
     timedelta,

pandas/_version.py

@@ -9,6 +9,8 @@
 
 """Git implementation of _version.py."""
 
+from __future__ import annotations
+
 import errno
 import os
 import re

pandas/compat/_optional.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import distutils.version
 import importlib
 import sys

pandas/compat/chainmap.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import (
     ChainMap,
     MutableMapping,

pandas/compat/numpy/function.py

@@ -15,6 +15,8 @@
 methods that are spread throughout the codebase. This module will make it
 easier to adjust to future upstream changes in the analogous numpy signatures.
 """
+from __future__ import annotations
+
 from distutils.version import LooseVersion
 from typing import (
     Any,

pandas/conftest.py

@@ -18,6 +18,8 @@
 - Misc
 """
 
+from __future__ import annotations
+
 from collections import abc
 from datetime import (
     date,

pandas/core/accessor.py

@@ -4,6 +4,8 @@
 that can be mixed into or pinned onto other pandas classes.
 
 """
+from __future__ import annotations
+
 from typing import (
     FrozenSet,
     List,

pandas/core/array_algos/masked_reductions.py

@@ -3,6 +3,8 @@
 for missing values.
 """
 
+from __future__ import annotations
+
 from typing import Callable
 
 import numpy as np

pandas/core/array_algos/putmask.py

@@ -1,6 +1,8 @@
 """
 EA-compatible analogue to to np.putmask
 """
+from __future__ import annotations
+
 from typing import (
     Any,
     Tuple,

pandas/core/array_algos/replace.py

@@ -1,6 +1,8 @@
 """
 Methods used by Block.replace and related methods.
 """
+from __future__ import annotations
+
 import operator
 import re
 from typing import (

pandas/core/array_algos/transforms.py

@@ -2,6 +2,8 @@
 transforms.py is for shape-preserving functions.
 """
 
+from __future__ import annotations
+
 import numpy as np
 
 from pandas.core.dtypes.common import ensure_platform_int

pandas/core/arraylike.py

@@ -4,6 +4,8 @@
     Index
     ExtensionArray
 """
+from __future__ import annotations
+
 import operator
 from typing import Any
 import warnings

pandas/core/arrays/_arrow_utils.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from distutils.version import LooseVersion
 import json
 

pandas/core/arrays/_ranges.py

@@ -3,6 +3,8 @@
 (and possibly TimedeltaArray/PeriodArray)
 """
 
+from __future__ import annotations
+
 from typing import Union
 
 import numpy as np

pandas/core/arrays/sparse/accessor.py

@@ -1,5 +1,7 @@
 """Sparse accessor"""
 
+from __future__ import annotations
+
 import numpy as np
 
 from pandas.compat._optional import import_optional_dependency

pandas/core/arrays/sparse/scipy_sparse.py

@@ -3,6 +3,8 @@
 
 Currently only includes to_coo helpers.
 """
+from __future__ import annotations
+
 from pandas.core.indexes.api import (
     Index,
     MultiIndex,

pandas/core/base.py

@@ -2,6 +2,8 @@
 Base and utility classes for pandas objects.
 """
 
+from __future__ import annotations
+
 import builtins
 import textwrap
 from typing import (

pandas/core/computation/check.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from pandas.compat._optional import import_optional_dependency
 
 ne = import_optional_dependency("numexpr", errors="warn")

pandas/core/computation/common.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from functools import reduce
 
 import numpy as np

pandas/core/computation/engines.py

@@ -2,6 +2,8 @@
 Engine classes for :func:`~pandas.eval`
 """
 
+from __future__ import annotations
+
 import abc
 from typing import (
     Dict,

pandas/core/computation/eval.py

@@ -2,6 +2,8 @@
 Top level ``eval`` module.
 """
 
+from __future__ import annotations
+
 import tokenize
 from typing import Optional
 import warnings

pandas/core/computation/expr.py

@@ -2,6 +2,8 @@
 :func:`~pandas.eval` parsers.
 """
 
+from __future__ import annotations
+
 import ast
 from functools import (
     partial,

pandas/core/computation/expressions.py

@@ -5,6 +5,8 @@
 Offer fast expression evaluation through numexpr
 
 """
+from __future__ import annotations
+
 import operator
 from typing import (
     List,

pandas/core/computation/parsing.py

@@ -2,6 +2,8 @@
 :func:`~pandas.eval` source string parsing functions
 """
 
+from __future__ import annotations
+
 from io import StringIO
 from keyword import iskeyword
 import token

pandas/core/config_init.py

@@ -9,6 +9,8 @@
 module is imported, register them here rather than in the module.
 
 """
+from __future__ import annotations
+
 import os
 import warnings
 

pandas/core/dtypes/common.py

@@ -2,6 +2,8 @@
 Common type operations.
 """
 
+from __future__ import annotations
+
 from typing import (
     Any,
     Callable,

pandas/core/dtypes/concat.py

@@ -1,6 +1,8 @@
 """
 Utility functions related to concat.
 """
+from __future__ import annotations
+
 from typing import cast
 
 import numpy as np

pandas/core/dtypes/inference.py

@@ -1,5 +1,7 @@
 """ basic inference routines """
 
+from __future__ import annotations
+
 from collections import abc
 from numbers import Number
 import re

pandas/core/dtypes/missing.py

@@ -1,6 +1,8 @@
 """
 missing types & inference
 """
+from __future__ import annotations
+
 from decimal import Decimal
 from functools import partial
 

pandas/core/flags.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import weakref
 
 

pandas/core/groupby/base.py

@@ -3,6 +3,8 @@
 hold the allowlist of methods that are exposed on the
 SeriesGroupBy and the DataFrameGroupBy objects.
 """
+from __future__ import annotations
+
 import collections
 from typing import List
 

pandas/core/groupby/categorical.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import (
     Optional,
     Tuple,

pandas/core/groupby/numba_.py

@@ -1,4 +1,6 @@
 """Common utilities for Numba operations with groupby ops"""
+from __future__ import annotations
+
 import inspect
 from typing import (
     Any,

pandas/core/index.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import warnings
 
 from pandas.core.indexes.api import (  # noqa:F401

pandas/core/indexes/category.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from typing import (
     Any,
     Hashable,

pandas/core/indexes/datetimelike.py

@@ -1,6 +1,8 @@
 """
 Base and utility classes for tseries type pandas objects.
 """
+from __future__ import annotations
+
 from datetime import datetime
 from typing import (
     TYPE_CHECKING,

pandas/core/indexes/extension.py

@@ -1,6 +1,8 @@
 """
 Shared methods for Index subclasses backed by ExtensionArray.
 """
+from __future__ import annotations
+
 from typing import (
     Hashable,
     List,