| |
| |
| <!DOCTYPE html> |
| |
| |
| <html lang="en" data-content_root="" > |
| |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>pyarrow.types — Apache Arrow v17.0.0.dev52</title> |
| |
| |
| |
| <script data-cfasync="false"> |
| document.documentElement.dataset.mode = localStorage.getItem("mode") || ""; |
| document.documentElement.dataset.theme = localStorage.getItem("theme") || "light"; |
| </script> |
| |
| <!-- Loaded before other Sphinx assets --> |
| <link href="../../_static/styles/theme.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| <link href="../../_static/styles/bootstrap.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| <link href="../../_static/styles/pydata-sphinx-theme.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| |
| |
| <link href="../../_static/vendor/fontawesome/6.5.1/css/all.min.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.woff2" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.5.1/webfonts/fa-brands-400.woff2" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.5.1/webfonts/fa-regular-400.woff2" /> |
| |
| <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/theme_overrides.css" /> |
| |
| <!-- Pre-loaded scripts that we'll load fully later --> |
| <link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae" /> |
| <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" /> |
| <script src="../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script> |
| |
| <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> |
| <script src="../../_static/doctools.js"></script> |
| <script src="../../_static/sphinx_highlight.js"></script> |
| <script src="../../_static/clipboard.min.js"></script> |
| <script src="../../_static/copybutton.js"></script> |
| <script src="../../_static/design-tabs.js"></script> |
| <script>DOCUMENTATION_OPTIONS.pagename = '_modules/pyarrow/types';</script> |
| <script> |
| DOCUMENTATION_OPTIONS.theme_version = '0.15.2'; |
| DOCUMENTATION_OPTIONS.theme_switcher_json_url = '/docs/_static/versions.json'; |
| DOCUMENTATION_OPTIONS.theme_switcher_version_match = 'dev/'; |
| DOCUMENTATION_OPTIONS.show_version_warning_banner = true; |
| </script> |
| <link rel="canonical" href="https://arrow.apache.org/docs/_modules/pyarrow/types.html" /> |
| <link rel="icon" href="../../_static/favicon.ico"/> |
| <link rel="index" title="Index" href="../../genindex.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <meta name="docsearch:language" content="en"/> |
| |
| <!-- Matomo --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| /* We explicitly disable cookie tracking to avoid privacy issues */ |
| _paq.push(['disableCookies']); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '20']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| <!-- End Matomo Code --> |
| |
| </head> |
| |
| |
| <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode=""> |
| |
| |
| |
| <a id="pst-skip-link" class="skip-link" href="#main-content">Skip to main content</a> |
| |
| <div id="pst-scroll-pixel-helper"></div> |
| |
| <button type="button" class="btn rounded-pill" id="pst-back-to-top"> |
| <i class="fa-solid fa-arrow-up"></i> |
| Back to top |
| </button> |
| |
| |
| <input type="checkbox" |
| class="sidebar-toggle" |
| name="__primary" |
| id="__primary"/> |
| <label class="overlay overlay-primary" for="__primary"></label> |
| |
| <input type="checkbox" |
| class="sidebar-toggle" |
| name="__secondary" |
| id="__secondary"/> |
| <label class="overlay overlay-secondary" for="__secondary"></label> |
| |
| <div class="search-button__wrapper"> |
| <div class="search-button__overlay"></div> |
| <div class="search-button__search-container"> |
| <form class="bd-search d-flex align-items-center" |
| action="../../search.html" |
| method="get"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <input type="search" |
| class="form-control" |
| name="q" |
| id="search-input" |
| placeholder="Search the docs ..." |
| aria-label="Search the docs ..." |
| autocomplete="off" |
| autocorrect="off" |
| autocapitalize="off" |
| spellcheck="false"/> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span> |
| </form></div> |
| </div> |
| |
| <header class="bd-header navbar navbar-expand-lg bd-navbar"> |
| <div class="bd-header__inner bd-page-width"> |
| <label class="sidebar-toggle primary-toggle" for="__primary"> |
| <span class="fa-solid fa-bars"></span> |
| </label> |
| |
| |
| <div class="col-lg-3 navbar-header-items__start"> |
| |
| <div class="navbar-item"> |
| |
| |
| |
| <a class="navbar-brand logo" href="../../index.html"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <img src="../../_static/arrow.png" class="logo__image only-light" alt="Apache Arrow v17.0.0.dev52 - Home"/> |
| <script>document.write(`<img src="../../_static/arrow-dark.png" class="logo__image only-dark" alt="Apache Arrow v17.0.0.dev52 - Home"/>`);</script> |
| |
| |
| </a></div> |
| |
| </div> |
| |
| <div class="col-lg-9 navbar-header-items"> |
| |
| <div class="me-auto navbar-header-items__center"> |
| |
| <div class="navbar-item"> |
| <nav class="navbar-nav"> |
| <ul class="bd-navbar-elements navbar-nav"> |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../format/index.html"> |
| Specifications |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../developers/index.html"> |
| Development |
| </a> |
| </li> |
| |
| <li class="nav-item dropdown"> |
| <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links"> |
| Implementations |
| </button> |
| <ul id="pst-nav-more-links" class="dropdown-menu"> |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../c_glib/index.html"> |
| C/GLib |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../cpp/index.html"> |
| C++ |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/csharp/README.md"> |
| C# |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://pkg.go.dev/github.com/apache/arrow/go/v17"> |
| Go |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../java/index.html"> |
| Java |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../js/index.html"> |
| JavaScript |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/julia/"> |
| Julia |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/matlab/README.md"> |
| MATLAB |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/nanoarrow/"> |
| nanoarrow |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../python/index.html"> |
| Python |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../r/index.html"> |
| R |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/ruby/README.md"> |
| Ruby |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://docs.rs/crate/arrow/"> |
| Rust |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../status.html"> |
| Implementation Status |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/cpp/"> |
| C++ cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/java/"> |
| Java cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/py/"> |
| Python cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/r/"> |
| R cookbook |
| </a> |
| </li> |
| |
| </ul> |
| </li> |
| |
| </ul> |
| </nav></div> |
| |
| </div> |
| |
| |
| <div class="navbar-header-items__end"> |
| |
| <div class="navbar-item navbar-persistent--container"> |
| |
| |
| <script> |
| document.write(` |
| <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <span class="search-button__default-text">Search</span> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> |
| </button> |
| `); |
| </script> |
| </div> |
| |
| |
| <div class="navbar-item"> |
| <script> |
| document.write(` |
| <div class="version-switcher__container dropdown"> |
| <button id="pst-version-switcher-button-2" |
| type="button" |
| class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" |
| data-bs-toggle="dropdown" |
| aria-haspopup="listbox" |
| aria-controls="pst-version-switcher-list-2" |
| aria-label="Version switcher list" |
| > |
| Choose version <!-- this text may get changed later by javascript --> |
| <span class="caret"></span> |
| </button> |
| <div id="pst-version-switcher-list-2" |
| class="version-switcher__menu dropdown-menu list-group-flush py-0" |
| role="listbox" aria-labelledby="pst-version-switcher-button-2"> |
| <!-- dropdown will be populated by javascript on page load --> |
| </div> |
| </div> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"> |
| |
| <script> |
| document.write(` |
| <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span> |
| </button> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"><ul class="navbar-icon-links navbar-nav" |
| aria-label="Icon Links"> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://github.com/apache/arrow" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">GitHub</span></a> |
| </li> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://twitter.com/ApacheArrow" title="X" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-x-twitter fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">X</span></a> |
| </li> |
| </ul></div> |
| |
| </div> |
| |
| </div> |
| |
| |
| <div class="navbar-persistent--mobile"> |
| |
| <script> |
| document.write(` |
| <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <span class="search-button__default-text">Search</span> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> |
| </button> |
| `); |
| </script> |
| </div> |
| |
| |
| |
| </div> |
| |
| </header> |
| |
| |
| <div class="bd-container"> |
| <div class="bd-container__inner bd-page-width"> |
| |
| |
| |
| |
| |
| <div class="bd-sidebar-primary bd-sidebar hide-on-wide"> |
| |
| |
| |
| <div class="sidebar-header-items sidebar-primary__section"> |
| |
| |
| <div class="sidebar-header-items__center"> |
| |
| <div class="navbar-item"> |
| <nav class="navbar-nav"> |
| <ul class="bd-navbar-elements navbar-nav"> |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../format/index.html"> |
| Specifications |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../developers/index.html"> |
| Development |
| </a> |
| </li> |
| |
| <li class="nav-item dropdown"> |
| <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links-2"> |
| Implementations |
| </button> |
| <ul id="pst-nav-more-links-2" class="dropdown-menu"> |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../c_glib/index.html"> |
| C/GLib |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../cpp/index.html"> |
| C++ |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/csharp/README.md"> |
| C# |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://pkg.go.dev/github.com/apache/arrow/go/v17"> |
| Go |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../java/index.html"> |
| Java |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../js/index.html"> |
| JavaScript |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/julia/"> |
| Julia |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/matlab/README.md"> |
| MATLAB |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/nanoarrow/"> |
| nanoarrow |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../python/index.html"> |
| Python |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../r/index.html"> |
| R |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/ruby/README.md"> |
| Ruby |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://docs.rs/crate/arrow/"> |
| Rust |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../status.html"> |
| Implementation Status |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/cpp/"> |
| C++ cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/java/"> |
| Java cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/py/"> |
| Python cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/r/"> |
| R cookbook |
| </a> |
| </li> |
| |
| </ul> |
| </li> |
| |
| </ul> |
| </nav></div> |
| |
| </div> |
| |
| |
| |
| <div class="sidebar-header-items__end"> |
| |
| <div class="navbar-item"> |
| <script> |
| document.write(` |
| <div class="version-switcher__container dropdown"> |
| <button id="pst-version-switcher-button-3" |
| type="button" |
| class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" |
| data-bs-toggle="dropdown" |
| aria-haspopup="listbox" |
| aria-controls="pst-version-switcher-list-3" |
| aria-label="Version switcher list" |
| > |
| Choose version <!-- this text may get changed later by javascript --> |
| <span class="caret"></span> |
| </button> |
| <div id="pst-version-switcher-list-3" |
| class="version-switcher__menu dropdown-menu list-group-flush py-0" |
| role="listbox" aria-labelledby="pst-version-switcher-button-3"> |
| <!-- dropdown will be populated by javascript on page load --> |
| </div> |
| </div> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"> |
| |
| <script> |
| document.write(` |
| <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span> |
| </button> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"><ul class="navbar-icon-links navbar-nav" |
| aria-label="Icon Links"> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://github.com/apache/arrow" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">GitHub</span></a> |
| </li> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://twitter.com/ApacheArrow" title="X" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-x-twitter fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">X</span></a> |
| </li> |
| </ul></div> |
| |
| </div> |
| |
| </div> |
| |
| |
| <div class="sidebar-primary-items__end sidebar-primary__section"> |
| </div> |
| |
| <div id="rtd-footer-container"></div> |
| |
| |
| </div> |
| |
| <main id="main-content" class="bd-main"> |
| |
| |
| <div class="bd-content"> |
| <div class="bd-article-container"> |
| |
| <div class="bd-header-article"> |
| <div class="header-article-items header-article__inner"> |
| |
| <div class="header-article-items__start"> |
| |
| <div class="header-article-item"> |
| |
| |
| |
| <nav aria-label="Breadcrumb"> |
| <ul class="bd-breadcrumbs"> |
| |
| <li class="breadcrumb-item breadcrumb-home"> |
| <a href="../../index.html" class="nav-link" aria-label="Home"> |
| <i class="fa-solid fa-home"></i> |
| </a> |
| </li> |
| |
| <li class="breadcrumb-item"><a href="../index.html" class="nav-link">Module code</a></li> |
| |
| |
| <li class="breadcrumb-item"><a href="../pyarrow.html" class="nav-link">pyarrow</a></li> |
| |
| <li class="breadcrumb-item active" aria-current="page">pyarrow.types</li> |
| </ul> |
| </nav> |
| </div> |
| |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| |
| |
| |
| <div id="searchbox"></div> |
| <article class="bd-article"> |
| |
| <h1>Source code for pyarrow.types</h1><div class="highlight"><pre> |
| <span></span><span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="c1"># or more contributor license agreements. See the NOTICE file</span> |
| <span class="c1"># distributed with this work for additional information</span> |
| <span class="c1"># regarding copyright ownership. The ASF licenses this file</span> |
| <span class="c1"># to you under the Apache License, Version 2.0 (the</span> |
| <span class="c1"># "License"); you may not use this file except in compliance</span> |
| <span class="c1"># with the License. You may obtain a copy of the License at</span> |
| <span class="c1">#</span> |
| <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="c1">#</span> |
| <span class="c1"># Unless required by applicable law or agreed to in writing,</span> |
| <span class="c1"># software distributed under the License is distributed on an</span> |
| <span class="c1"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span> |
| <span class="c1"># KIND, either express or implied. See the License for the</span> |
| <span class="c1"># specific language governing permissions and limitations</span> |
| <span class="c1"># under the License.</span> |
| |
| <span class="c1"># Tools for dealing with Arrow type metadata in Python</span> |
| |
| |
| <span class="kn">from</span> <span class="nn">pyarrow.lib</span> <span class="kn">import</span> <span class="p">(</span><span class="n">is_boolean_value</span><span class="p">,</span> <span class="c1"># noqa</span> |
| <span class="n">is_integer_value</span><span class="p">,</span> |
| <span class="n">is_float_value</span><span class="p">)</span> |
| |
| <span class="kn">import</span> <span class="nn">pyarrow.lib</span> <span class="k">as</span> <span class="nn">lib</span> |
| <span class="kn">from</span> <span class="nn">pyarrow.util</span> <span class="kn">import</span> <span class="n">doc</span> |
| |
| |
| <span class="n">_SIGNED_INTEGER_TYPES</span> <span class="o">=</span> <span class="p">{</span><span class="n">lib</span><span class="o">.</span><span class="n">Type_INT8</span><span class="p">,</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_INT16</span><span class="p">,</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_INT32</span><span class="p">,</span> |
| <span class="n">lib</span><span class="o">.</span><span class="n">Type_INT64</span><span class="p">}</span> |
| <span class="n">_UNSIGNED_INTEGER_TYPES</span> <span class="o">=</span> <span class="p">{</span><span class="n">lib</span><span class="o">.</span><span class="n">Type_UINT8</span><span class="p">,</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_UINT16</span><span class="p">,</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_UINT32</span><span class="p">,</span> |
| <span class="n">lib</span><span class="o">.</span><span class="n">Type_UINT64</span><span class="p">}</span> |
| <span class="n">_INTEGER_TYPES</span> <span class="o">=</span> <span class="n">_SIGNED_INTEGER_TYPES</span> <span class="o">|</span> <span class="n">_UNSIGNED_INTEGER_TYPES</span> |
| <span class="n">_FLOATING_TYPES</span> <span class="o">=</span> <span class="p">{</span><span class="n">lib</span><span class="o">.</span><span class="n">Type_HALF_FLOAT</span><span class="p">,</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_FLOAT</span><span class="p">,</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DOUBLE</span><span class="p">}</span> |
| <span class="n">_DECIMAL_TYPES</span> <span class="o">=</span> <span class="p">{</span><span class="n">lib</span><span class="o">.</span><span class="n">Type_DECIMAL128</span><span class="p">,</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DECIMAL256</span><span class="p">}</span> |
| <span class="n">_DATE_TYPES</span> <span class="o">=</span> <span class="p">{</span><span class="n">lib</span><span class="o">.</span><span class="n">Type_DATE32</span><span class="p">,</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DATE64</span><span class="p">}</span> |
| <span class="n">_TIME_TYPES</span> <span class="o">=</span> <span class="p">{</span><span class="n">lib</span><span class="o">.</span><span class="n">Type_TIME32</span><span class="p">,</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_TIME64</span><span class="p">}</span> |
| <span class="n">_INTERVAL_TYPES</span> <span class="o">=</span> <span class="p">{</span><span class="n">lib</span><span class="o">.</span><span class="n">Type_INTERVAL_MONTH_DAY_NANO</span><span class="p">}</span> |
| <span class="n">_TEMPORAL_TYPES</span> <span class="o">=</span> <span class="p">({</span><span class="n">lib</span><span class="o">.</span><span class="n">Type_TIMESTAMP</span><span class="p">,</span> |
| <span class="n">lib</span><span class="o">.</span><span class="n">Type_DURATION</span><span class="p">}</span> <span class="o">|</span> <span class="n">_TIME_TYPES</span> <span class="o">|</span> <span class="n">_DATE_TYPES</span> <span class="o">|</span> |
| <span class="n">_INTERVAL_TYPES</span><span class="p">)</span> |
| <span class="n">_UNION_TYPES</span> <span class="o">=</span> <span class="p">{</span><span class="n">lib</span><span class="o">.</span><span class="n">Type_SPARSE_UNION</span><span class="p">,</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DENSE_UNION</span><span class="p">}</span> |
| <span class="n">_NESTED_TYPES</span> <span class="o">=</span> <span class="p">{</span><span class="n">lib</span><span class="o">.</span><span class="n">Type_LIST</span><span class="p">,</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_FIXED_SIZE_LIST</span><span class="p">,</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_LARGE_LIST</span><span class="p">,</span> |
| <span class="n">lib</span><span class="o">.</span><span class="n">Type_LIST_VIEW</span><span class="p">,</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_LARGE_LIST_VIEW</span><span class="p">,</span> |
| <span class="n">lib</span><span class="o">.</span><span class="n">Type_STRUCT</span><span class="p">,</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_MAP</span><span class="p">}</span> <span class="o">|</span> <span class="n">_UNION_TYPES</span> |
| |
| |
| <div class="viewcode-block" id="is_null"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_null.html#pyarrow.types.is_null">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">datatype</span><span class="o">=</span><span class="s2">"null"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_null</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""</span> |
| <span class="sd"> Return True if value is an instance of type: {datatype}.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> t : DataType</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_NA</span></div> |
| |
| |
| <div class="viewcode-block" id="is_boolean"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_boolean.html#pyarrow.types.is_boolean">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"boolean"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_boolean</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_BOOL</span></div> |
| |
| |
| <div class="viewcode-block" id="is_integer"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_integer.html#pyarrow.types.is_integer">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"any integer"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_integer</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">_INTEGER_TYPES</span></div> |
| |
| |
| <div class="viewcode-block" id="is_signed_integer"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_signed_integer.html#pyarrow.types.is_signed_integer">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"signed integer"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_signed_integer</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">_SIGNED_INTEGER_TYPES</span></div> |
| |
| |
| <div class="viewcode-block" id="is_unsigned_integer"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_unsigned_integer.html#pyarrow.types.is_unsigned_integer">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"unsigned integer"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_unsigned_integer</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">_UNSIGNED_INTEGER_TYPES</span></div> |
| |
| |
| <div class="viewcode-block" id="is_int8"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_int8.html#pyarrow.types.is_int8">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"int8"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_int8</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_INT8</span></div> |
| |
| |
| <div class="viewcode-block" id="is_int16"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_int16.html#pyarrow.types.is_int16">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"int16"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_int16</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_INT16</span></div> |
| |
| |
| <div class="viewcode-block" id="is_int32"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_int32.html#pyarrow.types.is_int32">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"int32"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_int32</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_INT32</span></div> |
| |
| |
| <div class="viewcode-block" id="is_int64"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_int64.html#pyarrow.types.is_int64">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"int64"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_int64</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_INT64</span></div> |
| |
| |
| <div class="viewcode-block" id="is_uint8"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_uint8.html#pyarrow.types.is_uint8">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"uint8"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_uint8</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_UINT8</span></div> |
| |
| |
| <div class="viewcode-block" id="is_uint16"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_uint16.html#pyarrow.types.is_uint16">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"uint16"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_uint16</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_UINT16</span></div> |
| |
| |
| <div class="viewcode-block" id="is_uint32"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_uint32.html#pyarrow.types.is_uint32">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"uint32"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_uint32</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_UINT32</span></div> |
| |
| |
| <div class="viewcode-block" id="is_uint64"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_uint64.html#pyarrow.types.is_uint64">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"uint64"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_uint64</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_UINT64</span></div> |
| |
| |
| <div class="viewcode-block" id="is_floating"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_floating.html#pyarrow.types.is_floating">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"floating point numeric"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_floating</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">_FLOATING_TYPES</span></div> |
| |
| |
| <div class="viewcode-block" id="is_float16"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_float16.html#pyarrow.types.is_float16">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"float16 (half-precision)"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_float16</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_HALF_FLOAT</span></div> |
| |
| |
| <div class="viewcode-block" id="is_float32"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_float32.html#pyarrow.types.is_float32">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"float32 (single precision)"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_float32</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_FLOAT</span></div> |
| |
| |
| <div class="viewcode-block" id="is_float64"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_float64.html#pyarrow.types.is_float64">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"float64 (double precision)"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_float64</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DOUBLE</span></div> |
| |
| |
| <div class="viewcode-block" id="is_list"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_list.html#pyarrow.types.is_list">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"list"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_list</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_LIST</span></div> |
| |
| |
| <div class="viewcode-block" id="is_large_list"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_large_list.html#pyarrow.types.is_large_list">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"large list"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_large_list</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_LARGE_LIST</span></div> |
| |
| |
| <div class="viewcode-block" id="is_fixed_size_list"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_fixed_size_list.html#pyarrow.types.is_fixed_size_list">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"fixed size list"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_fixed_size_list</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_FIXED_SIZE_LIST</span></div> |
| |
| |
| <div class="viewcode-block" id="is_list_view"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_list_view.html#pyarrow.types.is_list_view">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"list view"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_list_view</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_LIST_VIEW</span></div> |
| |
| |
| <div class="viewcode-block" id="is_large_list_view"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_large_list_view.html#pyarrow.types.is_large_list_view">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"large list view"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_large_list_view</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_LARGE_LIST_VIEW</span></div> |
| |
| |
| <div class="viewcode-block" id="is_struct"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_struct.html#pyarrow.types.is_struct">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"struct"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_struct</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_STRUCT</span></div> |
| |
| |
| <div class="viewcode-block" id="is_union"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_union.html#pyarrow.types.is_union">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"union"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_union</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">_UNION_TYPES</span></div> |
| |
| |
| <div class="viewcode-block" id="is_nested"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_nested.html#pyarrow.types.is_nested">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"nested type"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_nested</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">_NESTED_TYPES</span></div> |
| |
| |
| <div class="viewcode-block" id="is_run_end_encoded"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_run_end_encoded.html#pyarrow.types.is_run_end_encoded">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"run-end encoded"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_run_end_encoded</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_RUN_END_ENCODED</span></div> |
| |
| |
| <div class="viewcode-block" id="is_temporal"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_temporal.html#pyarrow.types.is_temporal">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"date, time, timestamp or duration"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_temporal</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">_TEMPORAL_TYPES</span></div> |
| |
| |
| <div class="viewcode-block" id="is_timestamp"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_timestamp.html#pyarrow.types.is_timestamp">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"timestamp"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_timestamp</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_TIMESTAMP</span></div> |
| |
| |
| <div class="viewcode-block" id="is_duration"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_duration.html#pyarrow.types.is_duration">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"duration"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_duration</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DURATION</span></div> |
| |
| |
| <div class="viewcode-block" id="is_time"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_time.html#pyarrow.types.is_time">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"time"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_time</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">_TIME_TYPES</span></div> |
| |
| |
| <div class="viewcode-block" id="is_time32"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_time32.html#pyarrow.types.is_time32">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"time32"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_time32</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_TIME32</span></div> |
| |
| |
| <div class="viewcode-block" id="is_time64"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_time64.html#pyarrow.types.is_time64">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"time64"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_time64</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_TIME64</span></div> |
| |
| |
| <div class="viewcode-block" id="is_binary"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_binary.html#pyarrow.types.is_binary">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"variable-length binary"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_binary</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_BINARY</span></div> |
| |
| |
| <div class="viewcode-block" id="is_large_binary"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_large_binary.html#pyarrow.types.is_large_binary">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"large variable-length binary"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_large_binary</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_LARGE_BINARY</span></div> |
| |
| |
| <div class="viewcode-block" id="is_unicode"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_unicode.html#pyarrow.types.is_unicode">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">method</span><span class="o">=</span><span class="s2">"is_string"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_unicode</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="w"> </span><span class="sd">"""</span> |
| <span class="sd"> Alias for {method}.</span> |
| |
| <span class="sd"> Parameters</span> |
| <span class="sd"> ----------</span> |
| <span class="sd"> t : DataType</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="n">is_string</span><span class="p">(</span><span class="n">t</span><span class="p">)</span></div> |
| |
| |
| <div class="viewcode-block" id="is_string"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_string.html#pyarrow.types.is_string">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"string (utf8 unicode)"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_string</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_STRING</span></div> |
| |
| |
| <div class="viewcode-block" id="is_large_unicode"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_large_unicode.html#pyarrow.types.is_large_unicode">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_unicode</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="s2">"is_large_string"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_large_unicode</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">is_large_string</span><span class="p">(</span><span class="n">t</span><span class="p">)</span></div> |
| |
| |
| <div class="viewcode-block" id="is_large_string"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_large_string.html#pyarrow.types.is_large_string">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"large string (utf8 unicode)"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_large_string</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_LARGE_STRING</span></div> |
| |
| |
| <div class="viewcode-block" id="is_fixed_size_binary"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_fixed_size_binary.html#pyarrow.types.is_fixed_size_binary">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"fixed size binary"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_fixed_size_binary</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_FIXED_SIZE_BINARY</span></div> |
| |
| |
| <div class="viewcode-block" id="is_binary_view"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_binary_view.html#pyarrow.types.is_binary_view">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"variable-length binary view"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_binary_view</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_BINARY_VIEW</span></div> |
| |
| |
| <div class="viewcode-block" id="is_string_view"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_string_view.html#pyarrow.types.is_string_view">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"variable-length string (utf-8) view"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_string_view</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_STRING_VIEW</span></div> |
| |
| |
| <div class="viewcode-block" id="is_date"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_date.html#pyarrow.types.is_date">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"date"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_date</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">_DATE_TYPES</span></div> |
| |
| |
| <div class="viewcode-block" id="is_date32"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_date32.html#pyarrow.types.is_date32">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"date32 (days)"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_date32</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DATE32</span></div> |
| |
| |
| <div class="viewcode-block" id="is_date64"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_date64.html#pyarrow.types.is_date64">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"date64 (milliseconds)"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_date64</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DATE64</span></div> |
| |
| |
| <div class="viewcode-block" id="is_map"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_map.html#pyarrow.types.is_map">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"map"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_map</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_MAP</span></div> |
| |
| |
| <div class="viewcode-block" id="is_decimal"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_decimal.html#pyarrow.types.is_decimal">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"decimal"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_decimal</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="ow">in</span> <span class="n">_DECIMAL_TYPES</span></div> |
| |
| |
| <div class="viewcode-block" id="is_decimal128"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_decimal128.html#pyarrow.types.is_decimal128">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"decimal128"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_decimal128</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DECIMAL128</span></div> |
| |
| |
| <div class="viewcode-block" id="is_decimal256"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_decimal256.html#pyarrow.types.is_decimal256">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"decimal256"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_decimal256</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DECIMAL256</span></div> |
| |
| |
| <div class="viewcode-block" id="is_dictionary"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_dictionary.html#pyarrow.types.is_dictionary">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"dictionary-encoded"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_dictionary</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_DICTIONARY</span></div> |
| |
| |
| <div class="viewcode-block" id="is_interval"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_interval.html#pyarrow.types.is_interval">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"interval"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_interval</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">t</span><span class="o">.</span><span class="n">id</span> <span class="o">==</span> <span class="n">lib</span><span class="o">.</span><span class="n">Type_INTERVAL_MONTH_DAY_NANO</span></div> |
| |
| |
| <div class="viewcode-block" id="is_primitive"><a class="viewcode-back" href="../../python/generated/pyarrow.types.is_primitive.html#pyarrow.types.is_primitive">[docs]</a><span class="nd">@doc</span><span class="p">(</span><span class="n">is_null</span><span class="p">,</span> <span class="n">datatype</span><span class="o">=</span><span class="s2">"primitive type"</span><span class="p">)</span> |
| <span class="k">def</span> <span class="nf">is_primitive</span><span class="p">(</span><span class="n">t</span><span class="p">):</span> |
| <span class="k">return</span> <span class="n">lib</span><span class="o">.</span><span class="n">_is_primitive</span><span class="p">(</span><span class="n">t</span><span class="o">.</span><span class="n">id</span><span class="p">)</span></div> |
| </pre></div> |
| |
| </article> |
| |
| |
| |
| |
| |
| <footer class="prev-next-footer"> |
| |
| <div class="prev-next-area"> |
| </div> |
| </footer> |
| |
| </div> |
| |
| |
| |
| <div class="bd-sidebar-secondary bd-toc"></div> |
| |
| |
| </div> |
| <footer class="bd-footer-content"> |
| |
| </footer> |
| |
| </main> |
| </div> |
| </div> |
| |
| <!-- Scripts loaded after <body> so the DOM is not blocked --> |
| <script src="../../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae"></script> |
| <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae"></script> |
| |
| <footer class="bd-footer"> |
| <div class="bd-footer__inner bd-page-width"> |
| |
| <div class="footer-items__start"> |
| |
| <div class="footer-item"> |
| |
| <p class="copyright"> |
| |
| © Copyright 2016-2024 Apache Software Foundation. |
| Apache Arrow, Arrow, Apache, the Apache feather logo, and the Apache Arrow project logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries. |
| <br/> |
| |
| </p> |
| </div> |
| |
| <div class="footer-item"> |
| |
| <p class="sphinx-version"> |
| Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0. |
| <br/> |
| </p> |
| </div> |
| |
| </div> |
| |
| |
| |
| <div class="footer-items__end"> |
| |
| <div class="footer-item"> |
| <p class="theme-version"> |
| Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.15.2. |
| </p></div> |
| |
| </div> |
| |
| </div> |
| |
| </footer> |
| </body> |
| </html> |
