|
| 1 | +{{ header }} |
| 2 | + |
| 3 | +.. _api.typing.aliases: |
| 4 | + |
| 5 | +====================================== |
| 6 | +pandas typing aliases |
| 7 | +====================================== |
| 8 | + |
| 9 | +************** |
| 10 | +Typing aliases |
| 11 | +************** |
| 12 | + |
| 13 | +.. currentmodule:: pandas.api.typing.aliases |
| 14 | + |
| 15 | +The typing declarations in ``pandas/_typing.py`` are considered private, and used |
| 16 | +by pandas developers for type checking of the pandas code base. For users, it is |
| 17 | +highly recommended to use the ``pandas-stubs`` package that represents the officially |
| 18 | +supported type declarations for users of pandas. |
| 19 | +They are documented here for users who wish to use these declarations in their |
| 20 | +own python code that calls pandas or expects certain results. |
| 21 | + |
| 22 | +.. warning:: |
| 23 | + |
| 24 | + Note that the definitions and use cases of these aliases are subject to change without notice in any major, minor, or patch release of pandas. |
| 25 | + |
| 26 | +Each of these aliases listed in the table below can be found by importing them from :py:mod:`pandas.api.typing.aliases`. |
| 27 | + |
| 28 | +==================================== ================================================================ |
| 29 | +Alias Meaning |
| 30 | +==================================== ================================================================ |
| 31 | +:py:type:`AggFuncType` Type of functions that can be passed to :meth:`agg` methods |
| 32 | +:py:type:`AlignJoin` Argument type for ``join`` in :meth:`DataFrame.join` |
| 33 | +:py:type:`AnyAll` Argument type for ``how`` in :meth:`dropna` |
| 34 | +:py:type:`AnyArrayLike` Used to represent :class:`ExtensionArray`, ``numpy`` arrays, :class:`Index` and :class:`Series` |
| 35 | +:py:type:`ArrayLike` Used to represent :class:`ExtensionArray`, ``numpy`` arrays |
| 36 | +:py:type:`AstypeArg` Argument type in :meth:`astype` |
| 37 | +:py:type:`Axes` :py:type:`AnyArrayLike` plus sequences (not strings) and ``range`` |
| 38 | +:py:type:`Axis` Argument type for ``axis`` in many methods |
| 39 | +:py:type:`CSVEngine` Argument type for ``engine`` in :meth:`DataFrame.read_csv` |
| 40 | +:py:type:`ColspaceArgType` Argument type for ``colspace`` in :meth:`DataFrame.to_html` |
| 41 | +:py:type:`CompressionOptions` Argument type for ``compression`` in all I/O output methods except :meth:`DataFrame.to_parquet` |
| 42 | +:py:type:`CorrelationMethod` Argument type for ``correlation`` in :meth:`corr` |
| 43 | +:py:type:`DropKeep` Argument type for ``keep`` in :meth:`drop_duplicates` |
| 44 | +:py:type:`Dtype` Types as objects that can be used to specify dtypes |
| 45 | +:py:type:`DtypeArg` Argument type for ``dtype`` in various methods |
| 46 | +:py:type:`DtypeBackend` Argument type for ``dtype_backend`` in various methods |
| 47 | +:py:type:`DtypeObj` Numpy dtypes and Extension dtypes |
| 48 | +:py:type:`ExcelWriterIfSheetExists` Argument type for ``if_sheet_exists`` in :class:`ExcelWriter` |
| 49 | +:py:type:`ExcelWriterMergeCells` Argument type for ``merge_cells`` in :meth:`to_excel` |
| 50 | +:py:type:`FilePath` Type of paths for files for I/O methods |
| 51 | +:py:type:`FillnaOptions` Argument type for ``method`` in various methods where NA values are filled |
| 52 | +:py:type:`FloatFormatType` Argument type for ``float_format`` in :meth:`to_string` |
| 53 | +:py:type:`FormattersType` Argument type for ``formatters`` in :meth:`to_string` |
| 54 | +:py:type:`FromDictOrient` Argument type for ``orient`` in :meth:`DataFrame.from_dict` |
| 55 | +:py:type:`HTMLFlavors` Argument type for ``flavor`` in :meth:`pandas.read_html` |
| 56 | +:py:type:`IgnoreRaise` Argument type for ``errors`` in multiple methods |
| 57 | +:py:type:`IndexLabel` Argument type for ``level`` in multiple methods |
| 58 | +:py:type:`InterpolateOptions` Argument type for ``interpolate`` in :meth:`interpolate` |
| 59 | +:py:type:`JSONEngine` Argument type for ``engine`` in :meth:`read_json` |
| 60 | +:py:type:`JSONSerializable` Argument type for the return type of a callable for argument ``default_handler`` in :meth:`to_json` |
| 61 | +:py:type:`JoinHow` Argument type for ``how`` in :meth:`pandas.merge_ordered` and for ``join`` in :meth:`Series.align` |
| 62 | +:py:type:`JoinValidate` Argument type for ``validate`` in :meth:`DataFrame.join` |
| 63 | +:py:type:`MergeHow` Argument type for ``how`` in :meth:`merge` |
| 64 | +:py:type:`MergeValidate` Argument type for ``validate`` in :meth:`merge` |
| 65 | +:py:type:`NaPosition` Argument type for ``na_position`` in :meth:`sort_index` and :meth:`sort_values` |
| 66 | +:py:type:`NsmallestNlargestKeep` Argument type for ``keep`` in :meth:`nlargest` and :meth:`nsmallest` |
| 67 | +:py:type:`OpenFileErrors` Argument type for ``errors`` in :meth:`to_hdf` and :meth:`to_csv` |
| 68 | +:py:type:`Ordered` Return type for :py:attr:`ordered`` in :class:`CategoricalDtype` and :class:`Categorical` |
| 69 | +:py:type:`ParquetCompressionOptions` Argument type for ``compression`` in :meth:`DataFrame.to_parquet` |
| 70 | +:py:type:`QuantileInterpolation` Argument type for ``interpolation`` in :meth:`quantile` |
| 71 | +:py:type:`ReadBuffer` Additional argument type corresponding to buffers for various file reading methods |
| 72 | +:py:type:`ReadCsvBuffer` Additional argument type corresponding to buffers for :meth:`pandas.read_csv` |
| 73 | +:py:type:`ReadPickleBuffer` Additional argument type corresponding to buffers for :meth:`pandas.read_pickle` |
| 74 | +:py:type:`ReindexMethod` Argument type for ``reindex`` in :meth:`reindex` |
| 75 | +:py:type:`Scalar` Types that can be stored in :class:`Series` with non-object dtype |
| 76 | +:py:type:`SequenceNotStr` Used for arguments that require sequences, but not plain strings |
| 77 | +:py:type:`SliceType` Argument types for ``start`` and ``end`` in :meth:`Index.slice_locs` |
| 78 | +:py:type:`SortKind` Argument type for ``kind`` in :meth:`sort_index` and :meth:`sort_values` |
| 79 | +:py:type:`StorageOptions` Argument type for ``storage_options`` in various file output methods |
| 80 | +:py:type:`Suffixes` Argument type for ``suffixes`` in :meth:`merge`, :meth:`compare` and :meth:`merge_ordered` |
| 81 | +:py:type:`TakeIndexer` Argument type for ``indexer`` and ``indices`` in :meth:`take` |
| 82 | +:py:type:`TimeAmbiguous` Argument type for ``ambiguous`` in time operations |
| 83 | +:py:type:`TimeGrouperOrigin` Argument type for ``origin`` in :meth:`resample` and :class:`TimeGrouper` |
| 84 | +:py:type:`TimeNonexistent` Argument type for ``nonexistent`` in time operations |
| 85 | +:py:type:`TimeUnit` Time unit argument and return type for :py:attr:`unit`, arguments ``unit`` and ``date_unit`` |
| 86 | +:py:type:`TimedeltaConvertibleTypes` Argument type for ``offset`` in :meth:`resample`, ``halflife`` in :meth:`ewm` and ``start`` and ``end`` in :meth:`pandas.timedelta_range` |
| 87 | +:py:type:`TimestampConvertibleTypes` Argument type for ``origin`` in :meth:`resample` and :meth:`pandas.to_datetime` |
| 88 | +:py:type:`ToStataByteorder` Argument type for ``byteorder`` in :meth:`DataFrame.to_stata` |
| 89 | +:py:type:`ToTimestampHow` Argument type for ``how`` in :meth:`to_timestamp` and ``convention`` in :meth:`resample` |
| 90 | +:py:type:`UpdateJoin` Argument type for ``join`` in :meth:`DataFrame.update` |
| 91 | +:py:type:`UsecolsArgType` Argument type for ``usecols`` in :meth:`pandas.read_clipboard`, :meth:`pandas.read_csv` and :meth:`pandas.read_excel` |
| 92 | +:py:type:`WindowingRankType` Argument type for ``method`` in :meth:`rank`` in rolling and expanding window operations |
| 93 | +:py:type:`WriteBuffer` Additional argument type corresponding to buffers for various file output methods |
| 94 | +:py:type:`WriteExcelBuffer` Additional argument type corresponding to buffers for :meth:`to_excel` |
| 95 | +:py:type:`XMLParsers` Argument type for ``parser`` in :meth:`DataFrame.to_xml` and :meth:`pandas.read_xml` |
| 96 | +==================================== ================================================================ |
0 commit comments