Morph MORPH
SIGN IN SIGN UP
apache / arrow UNCLAIMED

Apache Arrow is the universal columnar format and multi-language toolbox for fast data interchange and in-memory analytics

0 0 16 C++
Normal View History Raw
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
# Tools for dealing with Arrow type metadata in Python
ARROW-5027: [Python] Python bindings for JSON reader This PR implements Python bindings for the JSON reader. Author: Philipp Moritz <pcmoritz@gmail.com> Closes #4044 from pcmoritz/cython-read-json and squashes the following commits: 1148f43ed <Philipp Moritz> update 465e9d416 <Philipp Moritz> fixes and docstring d75b02d18 <Philipp Moritz> add tests b630845a7 <Philipp Moritz> temp commit aa0aa3f85 <Philipp Moritz> update b1742b00e <Philipp Moritz> update 9dfc978cf <Philipp Moritz> add absolute imports c776e0f5e <Philipp Moritz> linting bb614282b <Philipp Moritz> comment in again 46a8561fe <Philipp Moritz> update 619064571 <Philipp Moritz> update 364971c86 <Philipp Moritz> update 90a3510a8 <Philipp Moritz> update 4edb201f6 <Philipp Moritz> initial work on JSON reader python wrapper
2019-05-27 18:01:27 +02:00
GH-47123: [Python] Add Enums to PyArrow Types (#47139) ### Rationale for this change Please see Github Issue #47123 ### What changes are included in this PR? Added public Type Enums that mimic the original private variable groups used for internal type checking. ### Are these changes tested? Yes. Partly for now. ### Are there any user-facing changes? No, just additional features were added: they will now able to access the underlying types directly via the Type Enums. * GitHub Issue: #47123 Lead-authored-by: Bogdan Romenskii <rmnsk@seznam.cz> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-07-25 15:14:26 +02:00
from enum import IntEnum
ARROW-3363: [C++/Python] Add helper functions to detect scalar Python types Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Author: Krisztián Szűcs <szucs.krisztian@gmail.com> Closes #2659 from xhochy/ARROW-3363 and squashes the following commits: 3560fd35 <Krisztián Szűcs> flake8 ffcc20c8 <Korn, Uwe> Rename functions to _value c7115214 <Korn, Uwe> ARROW-3363:  Add helper functions to detect scalar Python types
2018-09-30 13:48:47 +02:00
from pyarrow.lib import (is_boolean_value, # noqa
is_integer_value,
ARROW-3963: [Packaging/Docker] Nightly test for building sphinx documentations Test is here: https://github.com/kszucs/crossbow/branches/all?utf8=%E2%9C%93&query=docker-docs Author: Krisztián Szűcs <szucs.krisztian@gmail.com> Closes #3130 from kszucs/ARROW-3963 and squashes the following commits: 0b5be2cc <Krisztián Szűcs> add docker-docs to docker group 1575909e <Krisztián Szűcs> path corrections 51768fc0 <Krisztián Szűcs> use sphinx-build command instead of setup.py 60635acc <Krisztián Szűcs> error msg a93fcad6 <Krisztián Szűcs> merge _as_type and ensure_type 8d3d58fd <Krisztián Szűcs> nightly test for building cpp and python docs
2018-12-09 22:22:08 +01:00
is_float_value)
ARROW-3363: [C++/Python] Add helper functions to detect scalar Python types Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Author: Krisztián Szűcs <szucs.krisztian@gmail.com> Closes #2659 from xhochy/ARROW-3363 and squashes the following commits: 3560fd35 <Krisztián Szűcs> flake8 ffcc20c8 <Korn, Uwe> Rename functions to _value c7115214 <Korn, Uwe> ARROW-3363:  Add helper functions to detect scalar Python types
2018-09-30 13:48:47 +02:00
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
import pyarrow.lib as lib
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
from pyarrow.util import doc
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
_SIGNED_INTEGER_TYPES = {lib.Type_INT8, lib.Type_INT16, lib.Type_INT32,
lib.Type_INT64}
_UNSIGNED_INTEGER_TYPES = {lib.Type_UINT8, lib.Type_UINT16, lib.Type_UINT32,
lib.Type_UINT64}
_INTEGER_TYPES = _SIGNED_INTEGER_TYPES | _UNSIGNED_INTEGER_TYPES
_FLOATING_TYPES = {lib.Type_HALF_FLOAT, lib.Type_FLOAT, lib.Type_DOUBLE}
GH-44713: [Python] Add support for Decimal32 and Decimal64 types (#44882) ### Rationale for this change Arrow C++ and the Arrow specification now support 32-bit and 64-bit decimal types...pyarrow should too! ### What changes are included in this PR? Added type, array, and scalar bindings. ### Are these changes tested? Yes! ### Are there any user-facing changes? Yes! * GitHub Issue: #44713 Authored-by: Dewey Dunnington <dewey@fishandwhistle.net> Signed-off-by: Dewey Dunnington <dewey@fishandwhistle.net>
2024-12-16 21:12:07 -06:00
_DECIMAL_TYPES = {lib.Type_DECIMAL32, lib.Type_DECIMAL64, lib.Type_DECIMAL128,
lib.Type_DECIMAL256}
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
_DATE_TYPES = {lib.Type_DATE32, lib.Type_DATE64}
_TIME_TYPES = {lib.Type_TIME32, lib.Type_TIME64}
ARROW-13806: [C++][Python] Add support for new MonthDayNano Interval Type - Refactored ObjectWriter helpers from arrow_to_pandas, so they can be used for plain python types as well (generalized the lowest level so it can work on both PyObject** and an adapter for PyList. - Add DateOffset to static pandas imports - Tried to start laying out code in a way to use C++ for Array.to_pylist (feel free to comment). Support importing from timeinterval, relativedelta and DateOffset types (this is actually mostly duck types, the one complication is that relativedelta has a property weeks that is automatically calculated, so some type checking is necessary). Open questions: - Should we be more strict on duck typing imports? I chose generalism over performance here (rechecking non-present attributes, etc)? - Is the new arrow_to_python.h desirable (I think this can be easily extended for other types)? - My python is rusty and Python C-API even more so, please don't assume I know exactly what I'm doing :) Closes #11302 from emkornfield/interval_python Lead-authored-by: Micah Kornfield <micahk@google.com> Co-authored-by: emkornfield <emkornfield@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-10-07 12:36:46 +02:00
_INTERVAL_TYPES = {lib.Type_INTERVAL_MONTH_DAY_NANO}
_TEMPORAL_TYPES = ({lib.Type_TIMESTAMP,
lib.Type_DURATION} | _TIME_TYPES | _DATE_TYPES |
_INTERVAL_TYPES)
ARROW-8866: [C++] Split UNION into SPARSE_UNION and DENSE_UNION Also splits `UnionType -> SparseUnionType and DenseUnionType` and similar for `UnionArray`, `UnionScalar`. `SparseUnionArray` no longer includes the unused offsets buffer Closes #7378 from bkietz/8866-Split-TypeUNION-into-Type Lead-authored-by: Benjamin Kietzman <bengilgit@gmail.com> Co-authored-by: Wes McKinney <wesm@apache.org> Signed-off-by: Wes McKinney <wesm@apache.org>
2020-06-12 13:03:12 -05:00
_UNION_TYPES = {lib.Type_SPARSE_UNION, lib.Type_DENSE_UNION}
GH-40171: [Python] Add Type_FIXED_SIZE_LIST to _NESTED_TYPES set (#40172) ### Rationale for this change ### What changes are included in this PR? This PR fixes a minor bug in `types.is_nested` which doesn't consider the `FIXED_SIZE_LIST` type as nested type. ### Are these changes tested? ### Are there any user-facing changes? * Closes: #40171 Authored-by: hussein-awala <hussein@awala.fr> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2024-02-27 14:28:55 +01:00
_NESTED_TYPES = {lib.Type_LIST, lib.Type_FIXED_SIZE_LIST, lib.Type_LARGE_LIST,
GH-40266: [Python] Mark ListView as a nested type (#40265) ### Rationale for this change ListView types are nested, so `is_nested()` should return True. ### What changes are included in this PR? * `pa.types.is_nested(pa.list_view(<type>))` returns True ### Are these changes tested? Yes, unit tested. ### Are there any user-facing changes? Yes. * GitHub Issue: #40266 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2024-02-28 04:37:34 -05:00
lib.Type_LIST_VIEW, lib.Type_LARGE_LIST_VIEW,
GH-40171: [Python] Add Type_FIXED_SIZE_LIST to _NESTED_TYPES set (#40172) ### Rationale for this change ### What changes are included in this PR? This PR fixes a minor bug in `types.is_nested` which doesn't consider the `FIXED_SIZE_LIST` type as nested type. ### Are these changes tested? ### Are there any user-facing changes? * Closes: #40171 Authored-by: hussein-awala <hussein@awala.fr> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2024-02-27 14:28:55 +01:00
lib.Type_STRUCT, lib.Type_MAP} | _UNION_TYPES
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
GH-47123: [Python] Add Enums to PyArrow Types (#47139) ### Rationale for this change Please see Github Issue #47123 ### What changes are included in this PR? Added public Type Enums that mimic the original private variable groups used for internal type checking. ### Are these changes tested? Yes. Partly for now. ### Are there any user-facing changes? No, just additional features were added: they will now able to access the underlying types directly via the Type Enums. * GitHub Issue: #47123 Lead-authored-by: Bogdan Romenskii <rmnsk@seznam.cz> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Signed-off-by: AlenkaF <frim.alenka@gmail.com>
2025-07-25 15:14:26 +02:00
class TypesEnum(IntEnum):
"""
An Enum that maps constant values to data types.
Exposes the underlying data types representation for type checking purposes.
Note that some of the types listed here are not supported by PyArrow yet:
INTERVAL_MONTHS and INTERVAL_DAY_TIME.
Examples
--------
>>> import pyarrow as pa
>>> from pyarrow.types import TypesEnum
>>> int8_field = pa.field('int8_field', pa.int8())
>>> int8_field.type.id == TypesEnum.INT8
True
>>> fixed_size_list = pa.list_(pa.uint16(), 3)
>>> fixed_size_list.id == TypesEnum.LIST
False
>>> fixed_size_list.id == TypesEnum.FIXED_SIZE_LIST
True
"""
NA = lib.Type_NA
BOOL = lib.Type_BOOL
INT8 = lib.Type_INT8
INT16 = lib.Type_INT16
INT32 = lib.Type_INT32
INT64 = lib.Type_INT64
UINT8 = lib.Type_UINT8
UINT16 = lib.Type_UINT16
UINT32 = lib.Type_UINT32
UINT64 = lib.Type_UINT64
HALF_FLOAT = lib.Type_HALF_FLOAT
FLOAT = lib.Type_FLOAT
DOUBLE = lib.Type_DOUBLE
BINARY = lib.Type_BINARY
BINARY_VIEW = lib.Type_BINARY_VIEW
LARGE_BINARY = lib.Type_LARGE_BINARY
STRING = lib.Type_STRING
STRING_VIEW = lib.Type_STRING_VIEW
LARGE_STRING = lib.Type_LARGE_STRING
FIXED_SIZE_BINARY = lib.Type_FIXED_SIZE_BINARY
DECIMAL32 = lib.Type_DECIMAL32
DECIMAL64 = lib.Type_DECIMAL64
DECIMAL128 = lib.Type_DECIMAL128
DECIMAL256 = lib.Type_DECIMAL256
LIST = lib.Type_LIST
LARGE_LIST = lib.Type_LARGE_LIST
LIST_VIEW = lib.Type_LIST_VIEW
LARGE_LIST_VIEW = lib.Type_LARGE_LIST_VIEW
MAP = lib.Type_MAP
FIXED_SIZE_LIST = lib.Type_FIXED_SIZE_LIST
STRUCT = lib.Type_STRUCT
SPARSE_UNION = lib.Type_SPARSE_UNION
DENSE_UNION = lib.Type_DENSE_UNION
RUN_END_ENCODED = lib.Type_RUN_END_ENCODED
DATE32 = lib.Type_DATE32
DATE64 = lib.Type_DATE64
TIME32 = lib.Type_TIME32
TIME64 = lib.Type_TIME64
TIMESTAMP = lib.Type_TIMESTAMP
INTERVAL_MONTHS = lib.Type_INTERVAL_MONTHS
INTERVAL_DAY_TIME = lib.Type_INTERVAL_DAY_TIME
INTERVAL_MONTH_DAY_NANO = lib.Type_INTERVAL_MONTH_DAY_NANO
DURATION = lib.Type_DURATION
DICTIONARY = lib.Type_DICTIONARY
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(datatype="null")
ARROW-1905: [Python] Add more comprehensive list of exact type checking functions to pyarrow.types cc @BryanCutler Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1410 from wesm/ARROW-1905 and squashes the following commits: 93bddc9f [Wes McKinney] Add new functions to API, fix docstring dcd0829f [Wes McKinney] Add more exact type checking functions
2017-12-11 10:09:16 -05:00
def is_null(t):
"""
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
Return True if value is an instance of type: {datatype}.
ARROW-13637: [Python] Fix docstrings Address all docstrings to make sure they pass `archery numpydoc --allow-rule PR01` Closes #11245 from amol-/ARROW-13637 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-10-04 11:44:40 +02:00
Parameters
----------
t : DataType
ARROW-1905: [Python] Add more comprehensive list of exact type checking functions to pyarrow.types cc @BryanCutler Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1410 from wesm/ARROW-1905 and squashes the following commits: 93bddc9f [Wes McKinney] Add new functions to API, fix docstring dcd0829f [Wes McKinney] Add more exact type checking functions
2017-12-11 10:09:16 -05:00
"""
return t.id == lib.Type_NA
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="boolean")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_boolean(t):
return t.id == lib.Type_BOOL
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="any integer")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_integer(t):
return t.id in _INTEGER_TYPES
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="signed integer")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_signed_integer(t):
return t.id in _SIGNED_INTEGER_TYPES
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="unsigned integer")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_unsigned_integer(t):
return t.id in _UNSIGNED_INTEGER_TYPES
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="int8")
ARROW-1905: [Python] Add more comprehensive list of exact type checking functions to pyarrow.types cc @BryanCutler Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1410 from wesm/ARROW-1905 and squashes the following commits: 93bddc9f [Wes McKinney] Add new functions to API, fix docstring dcd0829f [Wes McKinney] Add more exact type checking functions
2017-12-11 10:09:16 -05:00
def is_int8(t):
return t.id == lib.Type_INT8
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="int16")
ARROW-1905: [Python] Add more comprehensive list of exact type checking functions to pyarrow.types cc @BryanCutler Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1410 from wesm/ARROW-1905 and squashes the following commits: 93bddc9f [Wes McKinney] Add new functions to API, fix docstring dcd0829f [Wes McKinney] Add more exact type checking functions
2017-12-11 10:09:16 -05:00
def is_int16(t):
return t.id == lib.Type_INT16
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="int32")
ARROW-1905: [Python] Add more comprehensive list of exact type checking functions to pyarrow.types cc @BryanCutler Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1410 from wesm/ARROW-1905 and squashes the following commits: 93bddc9f [Wes McKinney] Add new functions to API, fix docstring dcd0829f [Wes McKinney] Add more exact type checking functions
2017-12-11 10:09:16 -05:00
def is_int32(t):
return t.id == lib.Type_INT32
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="int64")
ARROW-1905: [Python] Add more comprehensive list of exact type checking functions to pyarrow.types cc @BryanCutler Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1410 from wesm/ARROW-1905 and squashes the following commits: 93bddc9f [Wes McKinney] Add new functions to API, fix docstring dcd0829f [Wes McKinney] Add more exact type checking functions
2017-12-11 10:09:16 -05:00
def is_int64(t):
return t.id == lib.Type_INT64
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="uint8")
ARROW-1905: [Python] Add more comprehensive list of exact type checking functions to pyarrow.types cc @BryanCutler Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1410 from wesm/ARROW-1905 and squashes the following commits: 93bddc9f [Wes McKinney] Add new functions to API, fix docstring dcd0829f [Wes McKinney] Add more exact type checking functions
2017-12-11 10:09:16 -05:00
def is_uint8(t):
return t.id == lib.Type_UINT8
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="uint16")
ARROW-1905: [Python] Add more comprehensive list of exact type checking functions to pyarrow.types cc @BryanCutler Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1410 from wesm/ARROW-1905 and squashes the following commits: 93bddc9f [Wes McKinney] Add new functions to API, fix docstring dcd0829f [Wes McKinney] Add more exact type checking functions
2017-12-11 10:09:16 -05:00
def is_uint16(t):
return t.id == lib.Type_UINT16
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="uint32")
ARROW-1905: [Python] Add more comprehensive list of exact type checking functions to pyarrow.types cc @BryanCutler Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1410 from wesm/ARROW-1905 and squashes the following commits: 93bddc9f [Wes McKinney] Add new functions to API, fix docstring dcd0829f [Wes McKinney] Add more exact type checking functions
2017-12-11 10:09:16 -05:00
def is_uint32(t):
return t.id == lib.Type_UINT32
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="uint64")
ARROW-1905: [Python] Add more comprehensive list of exact type checking functions to pyarrow.types cc @BryanCutler Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1410 from wesm/ARROW-1905 and squashes the following commits: 93bddc9f [Wes McKinney] Add new functions to API, fix docstring dcd0829f [Wes McKinney] Add more exact type checking functions
2017-12-11 10:09:16 -05:00
def is_uint64(t):
return t.id == lib.Type_UINT64
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="floating point numeric")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_floating(t):
return t.id in _FLOATING_TYPES
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="float16 (half-precision)")
ARROW-1905: [Python] Add more comprehensive list of exact type checking functions to pyarrow.types cc @BryanCutler Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1410 from wesm/ARROW-1905 and squashes the following commits: 93bddc9f [Wes McKinney] Add new functions to API, fix docstring dcd0829f [Wes McKinney] Add more exact type checking functions
2017-12-11 10:09:16 -05:00
def is_float16(t):
return t.id == lib.Type_HALF_FLOAT
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="float32 (single precision)")
ARROW-1905: [Python] Add more comprehensive list of exact type checking functions to pyarrow.types cc @BryanCutler Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1410 from wesm/ARROW-1905 and squashes the following commits: 93bddc9f [Wes McKinney] Add new functions to API, fix docstring dcd0829f [Wes McKinney] Add more exact type checking functions
2017-12-11 10:09:16 -05:00
def is_float32(t):
return t.id == lib.Type_FLOAT
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="float64 (double precision)")
ARROW-1905: [Python] Add more comprehensive list of exact type checking functions to pyarrow.types cc @BryanCutler Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1410 from wesm/ARROW-1905 and squashes the following commits: 93bddc9f [Wes McKinney] Add new functions to API, fix docstring dcd0829f [Wes McKinney] Add more exact type checking functions
2017-12-11 10:09:16 -05:00
def is_float64(t):
return t.id == lib.Type_DOUBLE
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="list")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_list(t):
return t.id == lib.Type_LIST
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="large list")
ARROW-6084: [Python] Support LargeList Closes #4979 from pitrou/ARROW-6084-py-large-list and squashes the following commits: 4266ea2c6 <Antoine Pitrou> ARROW-6084: Support LargeList Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Wes McKinney <wesm+git@apache.org>
2019-08-06 13:41:41 -05:00
def is_large_list(t):
return t.id == lib.Type_LARGE_LIST
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="fixed size list")
ARROW-7261: [Python] Add Python support for Fixed Size List type https://issues.apache.org/jira/browse/ARROW-7261 Conversion from python lists works, but conversion to python (to numpy/pandas) not yet. Closes #5906 from jorisvandenbossche/ARROW-7261-fixed-size-list and squashes the following commits: 5046c85fc <Joris Van den Bossche> fixup rebase feb648834 <Joris Van den Bossche> fix C++ docstring 7b4f57102 <Joris Van den Bossche> other updates d01b45d6a <Joris Van den Bossche> fix list_size of 0 + add tests da2a2b3ea <Joris Van den Bossche> Use Result instead of Status 8b3161937 <Joris Van den Bossche> known null_count of 0 cb68db4d5 <Joris Van den Bossche> use int32 for list_size 88a5cbdd9 <Joris Van den Bossche> add proper python -> arrow conversion a502fa729 <Joris Van den Bossche> edits for feedback 8d94b0f7a <Joris Van den Bossche> ARROW-7261: Add Python support for Fixed Size List type Authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2019-12-10 14:58:29 +01:00
def is_fixed_size_list(t):
return t.id == lib.Type_FIXED_SIZE_LIST
GH-39812: [Python] Add bindings for ListView and LargeListView (#39813) ### Rationale for this change Add bindings to the ListView and LargeListView array formats. ### What changes are included in this PR? * Add initial implementation for ListView and LargeListView * Add basic unit tests ### Are these changes tested? * Basic unit tests only (follow up PRs will be needed to implement full functionality) ### Are there any user-facing changes? Yes, documentation is updated in this PR to include the new PyArrow objects. * Closes: #39812 Lead-authored-by: Dane Pitkin <dane@voltrondata.com> Co-authored-by: Dane Pitkin <48041712+danepitkin@users.noreply.github.com> Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2024-02-08 09:44:19 -05:00
@doc(is_null, datatype="list view")
def is_list_view(t):
return t.id == lib.Type_LIST_VIEW
@doc(is_null, datatype="large list view")
def is_large_list_view(t):
return t.id == lib.Type_LARGE_LIST_VIEW
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="struct")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_struct(t):
return t.id == lib.Type_STRUCT
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="union")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_union(t):
ARROW-8866: [C++] Split UNION into SPARSE_UNION and DENSE_UNION Also splits `UnionType -> SparseUnionType and DenseUnionType` and similar for `UnionArray`, `UnionScalar`. `SparseUnionArray` no longer includes the unused offsets buffer Closes #7378 from bkietz/8866-Split-TypeUNION-into-Type Lead-authored-by: Benjamin Kietzman <bengilgit@gmail.com> Co-authored-by: Wes McKinney <wesm@apache.org> Signed-off-by: Wes McKinney <wesm@apache.org>
2020-06-12 13:03:12 -05:00
return t.id in _UNION_TYPES
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="nested type")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_nested(t):
return t.id in _NESTED_TYPES
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="run-end encoded")
GH-34568: [C++][Python] Expose Run-End Encoded arrays in Python Arrow (#34570) * Closes: #34568 Authored-by: Felipe Oliveira Carvalho <felipekde@gmail.com> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2023-03-23 05:20:06 -03:00
def is_run_end_encoded(t):
return t.id == lib.Type_RUN_END_ENCODED
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="date, time, timestamp or duration")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_temporal(t):
return t.id in _TEMPORAL_TYPES
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="timestamp")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_timestamp(t):
return t.id == lib.Type_TIMESTAMP
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="duration")
ARROW-5855: [Python] Support for Duration (timedelta) type https://issues.apache.org/jira/browse/ARROW-5855 - [x] Basic wrappers for DurationArray/Type/Value - [x] Numpy / pandas conversion - [x] Python conversion Closes #5566 from jorisvandenbossche/ARROW-5855-duration-python and squashes the following commits: cd9f12aa6 <Joris Van den Bossche> Type -> ArrowType 7458000cf <Joris Van den Bossche> templated TimestampConverter 56bd1b3b3 <Joris Van den Bossche> update for feedback f4d6b4b64 <Joris Van den Bossche> handle python 2 compat 6bfafbe14 <Joris Van den Bossche> clean-up 779e724f0 <Joris Van den Bossche> implement python conversion 03d399223 <Joris Van den Bossche> ARROW-5855: Support for Duration (timedelta) type Authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Signed-off-by: Antoine Pitrou <antoine@python.org>
2019-10-08 13:12:38 +02:00
def is_duration(t):
return t.id == lib.Type_DURATION
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="time")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_time(t):
return t.id in _TIME_TYPES
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="time32")
ARROW-1905: [Python] Add more comprehensive list of exact type checking functions to pyarrow.types cc @BryanCutler Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1410 from wesm/ARROW-1905 and squashes the following commits: 93bddc9f [Wes McKinney] Add new functions to API, fix docstring dcd0829f [Wes McKinney] Add more exact type checking functions
2017-12-11 10:09:16 -05:00
def is_time32(t):
return t.id == lib.Type_TIME32
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="time64")
ARROW-1905: [Python] Add more comprehensive list of exact type checking functions to pyarrow.types cc @BryanCutler Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1410 from wesm/ARROW-1905 and squashes the following commits: 93bddc9f [Wes McKinney] Add new functions to API, fix docstring dcd0829f [Wes McKinney] Add more exact type checking functions
2017-12-11 10:09:16 -05:00
def is_time64(t):
return t.id == lib.Type_TIME64
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="variable-length binary")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_binary(t):
return t.id == lib.Type_BINARY
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="large variable-length binary")
ARROW-6000: [Python] Add support for LargeString and LargeBinary types Also fix a bug in Take / Filter for large binary types. Closes #4927 from pitrou/ARROW-6000-py-large-binary and squashes the following commits: 0bb1b7f89 <Antoine Pitrou> Fix Take on LargeBinary / LargeString data 9672ca4c3 <Antoine Pitrou> ARROW-6000: Add support for LargeString and LargeBinary types Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2019-08-01 12:50:21 +02:00
def is_large_binary(t):
return t.id == lib.Type_LARGE_BINARY
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(method="is_string")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_unicode(t):
"""
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
Alias for {method}.
ARROW-13637: [Python] Fix docstrings Address all docstrings to make sure they pass `archery numpydoc --allow-rule PR01` Closes #11245 from amol-/ARROW-13637 Authored-by: Alessandro Molina <amol@turbogears.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-10-04 11:44:40 +02:00
Parameters
----------
t : DataType
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
"""
return is_string(t)
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="string (utf8 unicode)")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_string(t):
return t.id == lib.Type_STRING
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_unicode, method="is_large_string")
ARROW-6000: [Python] Add support for LargeString and LargeBinary types Also fix a bug in Take / Filter for large binary types. Closes #4927 from pitrou/ARROW-6000-py-large-binary and squashes the following commits: 0bb1b7f89 <Antoine Pitrou> Fix Take on LargeBinary / LargeString data 9672ca4c3 <Antoine Pitrou> ARROW-6000: Add support for LargeString and LargeBinary types Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2019-08-01 12:50:21 +02:00
def is_large_unicode(t):
return is_large_string(t)
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="large string (utf8 unicode)")
ARROW-6000: [Python] Add support for LargeString and LargeBinary types Also fix a bug in Take / Filter for large binary types. Closes #4927 from pitrou/ARROW-6000-py-large-binary and squashes the following commits: 0bb1b7f89 <Antoine Pitrou> Fix Take on LargeBinary / LargeString data 9672ca4c3 <Antoine Pitrou> ARROW-6000: Add support for LargeString and LargeBinary types Authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2019-08-01 12:50:21 +02:00
def is_large_string(t):
return t.id == lib.Type_LARGE_STRING
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="fixed size binary")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_fixed_size_binary(t):
return t.id == lib.Type_FIXED_SIZE_BINARY
GH-39651: [Python] Basic pyarrow bindings for Binary/StringView classes (#39652) ### Rationale for this change First step for https://github.com/apache/arrow/issues/39633: exposing the Array, DataType and Scalar classes for BinaryView and StringView, such that those can already be represented in pyarrow. (I exposed a variant of StringBuilder as well, just for now to be able to create test data) * Closes: #39651 Authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
2024-01-30 12:54:19 +01:00
@doc(is_null, datatype="variable-length binary view")
def is_binary_view(t):
return t.id == lib.Type_BINARY_VIEW
@doc(is_null, datatype="variable-length string (utf-8) view")
def is_string_view(t):
return t.id == lib.Type_STRING_VIEW
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="date")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_date(t):
return t.id in _DATE_TYPES
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="date32 (days)")
ARROW-1905: [Python] Add more comprehensive list of exact type checking functions to pyarrow.types cc @BryanCutler Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1410 from wesm/ARROW-1905 and squashes the following commits: 93bddc9f [Wes McKinney] Add new functions to API, fix docstring dcd0829f [Wes McKinney] Add more exact type checking functions
2017-12-11 10:09:16 -05:00
def is_date32(t):
return t.id == lib.Type_DATE32
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="date64 (milliseconds)")
ARROW-1905: [Python] Add more comprehensive list of exact type checking functions to pyarrow.types cc @BryanCutler Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1410 from wesm/ARROW-1905 and squashes the following commits: 93bddc9f [Wes McKinney] Add new functions to API, fix docstring dcd0829f [Wes McKinney] Add more exact type checking functions
2017-12-11 10:09:16 -05:00
def is_date64(t):
return t.id == lib.Type_DATE64
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="map")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_map(t):
return t.id == lib.Type_MAP
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="decimal")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_decimal(t):
ARROW-9747: [Java][C++] Initial Support for 256-bit Decimals This provides sufficient coverage to support round trip between C++ and Java. There are still some gaps in python. Based on review, I will open JIRAs to track missing functionality (i.e. parquet support in C++). Marking as draft until i can triage CI failures but early feedback is welcome. Open questions I have: [C++] * Should we retain logic in decimal() factory function to adjust type on scale/precision or take an explicit argument or keep it as an alias for decimal128? [Java] * Naming: Would Decimal256 be better then BigDecimal? Closes #8475 from emkornfield/decimal256 Lead-authored-by: Mingyu Zhong <69326943+MingyuZhong@users.noreply.github.com> Co-authored-by: Micah Kornfield <micahk@google.com> Co-authored-by: Micah Kornfield <emkornfield@gmail.com> Co-authored-by: emkornfield <emkornfield@gmail.com> Co-authored-by: Ezra <eumen@google.com> Signed-off-by: Micah Kornfield <emkornfield@gmail.com>
2020-10-22 21:39:53 -07:00
return t.id in _DECIMAL_TYPES
GH-44713: [Python] Add support for Decimal32 and Decimal64 types (#44882) ### Rationale for this change Arrow C++ and the Arrow specification now support 32-bit and 64-bit decimal types...pyarrow should too! ### What changes are included in this PR? Added type, array, and scalar bindings. ### Are these changes tested? Yes! ### Are there any user-facing changes? Yes! * GitHub Issue: #44713 Authored-by: Dewey Dunnington <dewey@fishandwhistle.net> Signed-off-by: Dewey Dunnington <dewey@fishandwhistle.net>
2024-12-16 21:12:07 -06:00
@doc(is_null, datatype="decimal32")
def is_decimal32(t):
return t.id == lib.Type_DECIMAL32
@doc(is_null, datatype="decimal64")
def is_decimal64(t):
return t.id == lib.Type_DECIMAL64
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="decimal128")
ARROW-9747: [Java][C++] Initial Support for 256-bit Decimals This provides sufficient coverage to support round trip between C++ and Java. There are still some gaps in python. Based on review, I will open JIRAs to track missing functionality (i.e. parquet support in C++). Marking as draft until i can triage CI failures but early feedback is welcome. Open questions I have: [C++] * Should we retain logic in decimal() factory function to adjust type on scale/precision or take an explicit argument or keep it as an alias for decimal128? [Java] * Naming: Would Decimal256 be better then BigDecimal? Closes #8475 from emkornfield/decimal256 Lead-authored-by: Mingyu Zhong <69326943+MingyuZhong@users.noreply.github.com> Co-authored-by: Micah Kornfield <micahk@google.com> Co-authored-by: Micah Kornfield <emkornfield@gmail.com> Co-authored-by: emkornfield <emkornfield@gmail.com> Co-authored-by: Ezra <eumen@google.com> Signed-off-by: Micah Kornfield <emkornfield@gmail.com>
2020-10-22 21:39:53 -07:00
def is_decimal128(t):
return t.id == lib.Type_DECIMAL128
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="decimal256")
ARROW-9747: [Java][C++] Initial Support for 256-bit Decimals This provides sufficient coverage to support round trip between C++ and Java. There are still some gaps in python. Based on review, I will open JIRAs to track missing functionality (i.e. parquet support in C++). Marking as draft until i can triage CI failures but early feedback is welcome. Open questions I have: [C++] * Should we retain logic in decimal() factory function to adjust type on scale/precision or take an explicit argument or keep it as an alias for decimal128? [Java] * Naming: Would Decimal256 be better then BigDecimal? Closes #8475 from emkornfield/decimal256 Lead-authored-by: Mingyu Zhong <69326943+MingyuZhong@users.noreply.github.com> Co-authored-by: Micah Kornfield <micahk@google.com> Co-authored-by: Micah Kornfield <emkornfield@gmail.com> Co-authored-by: emkornfield <emkornfield@gmail.com> Co-authored-by: Ezra <eumen@google.com> Signed-off-by: Micah Kornfield <emkornfield@gmail.com>
2020-10-22 21:39:53 -07:00
def is_decimal256(t):
return t.id == lib.Type_DECIMAL256
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="dictionary-encoded")
ARROW-1250: [Python] Add pyarrow.types module with useful type checking functions cc @TomAugspurger @cpcloud @xhochy for review Author: Wes McKinney <wes.mckinney@twosigma.com> Closes #1183 from wesm/ARROW-1250 and squashes the following commits: e8ee7460 [Wes McKinney] Add is_dictionary 6fe40301 [Wes McKinney] Add test_types.py 1de24190 [Wes McKinney] Do not use isinstance 2f09c00c [Wes McKinney] Remove unused imports 3074efb5 [Wes McKinney] Add pyarrow.types module with useful type checking functions
2017-10-07 15:49:10 -04:00
def is_dictionary(t):
return t.id == lib.Type_DICTIONARY
ARROW-2491: [Python] raise NotImplementedError on from_buffers with nested types Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Closes #1927 from xhochy/ARROW-2491 and squashes the following commits: f2300dbf <Korn, Uwe> Test for NotImplementedError 0dbcc34f <Korn, Uwe> ARROW-2491: raise NotImplementedError on from_buffers with nested types
2018-05-08 19:15:40 +02:00
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="interval")
ARROW-13806: [C++][Python] Add support for new MonthDayNano Interval Type - Refactored ObjectWriter helpers from arrow_to_pandas, so they can be used for plain python types as well (generalized the lowest level so it can work on both PyObject** and an adapter for PyList. - Add DateOffset to static pandas imports - Tried to start laying out code in a way to use C++ for Array.to_pylist (feel free to comment). Support importing from timeinterval, relativedelta and DateOffset types (this is actually mostly duck types, the one complication is that relativedelta has a property weeks that is automatically calculated, so some type checking is necessary). Open questions: - Should we be more strict on duck typing imports? I chose generalism over performance here (rechecking non-present attributes, etc)? - Is the new arrow_to_python.h desirable (I think this can be easily extended for other types)? - My python is rusty and Python C-API even more so, please don't assume I know exactly what I'm doing :) Closes #11302 from emkornfield/interval_python Lead-authored-by: Micah Kornfield <micahk@google.com> Co-authored-by: emkornfield <emkornfield@gmail.com> Co-authored-by: Antoine Pitrou <antoine@python.org> Signed-off-by: Antoine Pitrou <antoine@python.org>
2021-10-07 12:36:46 +02:00
def is_interval(t):
return t.id == lib.Type_INTERVAL_MONTH_DAY_NANO
GH-34868: [Python] Share docstrings between classes (#34894) ### Rationale for this change Python classes sometimes duplicate docstrings, but change one word such as class name. Add a decorator function as a utility to help deduplicate docstring descriptions. Only works in Python. Does not work in Cython due to this CPython issue https://github.com/python/cpython/issues/91309. ### What changes are included in this PR? Add a decorator `@ doc` that can copy, concatenate, and/or format docstrings between classes. ### Are these changes tested? Tests added. ``` >>> import pyarrow >>> from pyarrow.filesystem import FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper >>> from pyarrow.hdfs import HadoopFileSystem >>> for fs in [FileSystem, LocalFileSystem, DaskFileSystem, S3FSWrapper, HadoopFileSystem]: ... print(fs.__name__) ... print(fs.isdir.__doc__) ... FileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. LocalFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. DaskFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. S3FSWrapper Return True if path is a directory. Parameters ---------- path : str Path to check. HadoopFileSystem Return True if path is a directory. Parameters ---------- path : str Path to check. ``` Note that `FileSystem.isdir.__doc__` is not dedented because it does not use the `@ doc` decorator. ### Are there any user-facing changes? No * Closes: #34868 Authored-by: Dane Pitkin <dane@voltrondata.com> Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
2023-04-24 02:18:52 -04:00
@doc(is_null, datatype="primitive type")
ARROW-2491: [Python] raise NotImplementedError on from_buffers with nested types Author: Korn, Uwe <Uwe.Korn@blue-yonder.com> Closes #1927 from xhochy/ARROW-2491 and squashes the following commits: f2300dbf <Korn, Uwe> Test for NotImplementedError 0dbcc34f <Korn, Uwe> ARROW-2491: raise NotImplementedError on from_buffers with nested types
2018-05-08 19:15:40 +02:00
def is_primitive(t):
return lib._is_primitive(t.id)
Reference in New Issue Copy Permalink