Google Git
Sign in
apache / spark-website / bf09c083b54ac9a00c74c79b8b38346b2fdd0a59 / . / site / docs / 3.3.3 / api / python / reference / pyspark.pandas / api / pyspark.pandas.date_range.html
blob: 1bfb642083eb0c29a42b385256820313e56b24c7 [file] [log] [blame]
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>pyspark.pandas.date_range &#8212; PySpark 3.3.3 documentation</title>
<link rel="stylesheet" href="../../../_static/css/index.73d71520a4ca3b99cfee5594769eaaae.css">
<link rel="stylesheet"
href="../../../_static/vendor/fontawesome/5.13.0/css/all.min.css">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
<link rel="preload" as="font" type="font/woff2" crossorigin
href="../../../_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
<link rel="stylesheet"
href="../../../_static/vendor/open-sans_all/1.44.1/index.css">
<link rel="stylesheet"
href="../../../_static/vendor/lato_latin-ext/1.44.1/index.css">
<link rel="stylesheet" href="../../../_static/basic.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../../../_static/css/pyspark.css" />
<link rel="preload" as="script" href="../../../_static/js/index.3da636dd464baa7582d2.js">
<script id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script>
<script src="../../../_static/jquery.js"></script>
<script src="../../../_static/underscore.js"></script>
<script src="../../../_static/doctools.js"></script>
<script src="../../../_static/language_data.js"></script>
<script src="../../../_static/copybutton.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["$", "$"], ["\\(", "\\)"]], "processEscapes": true, "ignoreClass": "document", "processClass": "math|output_area"}})</script>
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="pyspark.pandas.to_timedelta" href="pyspark.pandas.to_timedelta.html" />
<link rel="prev" title="pyspark.pandas.to_datetime" href="pyspark.pandas.to_datetime.html" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="docsearch:language" content="en" />
</head>
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
<nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main">
<div class="container-xl">
<a class="navbar-brand" href="../../../index.html">
<img src="../../../_static/spark-logo-reverse.png" class="logo" alt="logo" />
</a>
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-menu" aria-controls="navbar-menu" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar-menu" class="col-lg-9 collapse navbar-collapse">
<ul id="navbar-main-elements" class="navbar-nav mr-auto">
<li class="nav-item ">
<a class="nav-link" href="../../../getting_started/index.html">Getting Started</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../../../user_guide/index.html">User Guide</a>
</li>
<li class="nav-item active">
<a class="nav-link" href="../../index.html">API Reference</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../../../development/index.html">Development</a>
</li>
<li class="nav-item ">
<a class="nav-link" href="../../../migration_guide/index.html">Migration Guide</a>
</li>
</ul>
<ul class="navbar-nav">
</ul>
</div>
</div>
</nav>
<div class="container-xl">
<div class="row">
<div class="col-12 col-md-3 bd-sidebar"><form class="bd-search d-flex align-items-center" action="../../../search.html" method="get">
<i class="icon fas fa-search"></i>
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
</form>
<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
<div class="bd-toc-item active">
<ul class="nav bd-sidenav">
<li class="">
<a href="../../pyspark.sql/index.html">Spark SQL</a>
</li>
<li class="active">
<a href="../index.html">Pandas API on Spark</a>
<ul>
<li class="">
<a href="../io.html">Input/Output</a>
</li>
<li class="active">
<a href="../general_functions.html">General functions</a>
</li>
<li class="">
<a href="../series.html">Series</a>
</li>
<li class="">
<a href="../frame.html">DataFrame</a>
</li>
<li class="">
<a href="../indexing.html">Index objects</a>
</li>
<li class="">
<a href="../window.html">Window</a>
</li>
<li class="">
<a href="../groupby.html">GroupBy</a>
</li>
<li class="">
<a href="../ml.html">Machine Learning utilities</a>
</li>
<li class="">
<a href="../extensions.html">Extensions</a>
</li>
</ul>
</li>
<li class="">
<a href="../../pyspark.ss/index.html">Structured Streaming</a>
</li>
<li class="">
<a href="../../pyspark.ml.html">MLlib (DataFrame-based)</a>
</li>
<li class="">
<a href="../../pyspark.streaming.html">Spark Streaming</a>
</li>
<li class="">
<a href="../../pyspark.mllib.html">MLlib (RDD-based)</a>
</li>
<li class="">
<a href="../../pyspark.html">Spark Core</a>
</li>
<li class="">
<a href="../../pyspark.resource.html">Resource Management</a>
</li>
</ul>
</nav>
</div>
<div class="d-none d-xl-block col-xl-2 bd-toc">
<nav id="bd-toc-nav">
<ul class="nav section-nav flex-column">
</ul>
</nav>
</div>
<main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
<div>
<div class="section" id="pyspark-pandas-date-range">
<h1>pyspark.pandas.date_range<a class="headerlink" href="#pyspark-pandas-date-range" title="Permalink to this headline">¶</a></h1>
<dl class="py function">
<dt id="pyspark.pandas.date_range">
<code class="sig-prename descclassname">pyspark.pandas.</code><code class="sig-name descname">date_range</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">start</span><span class="p">:</span> <span class="n">Union<span class="p">[</span>str<span class="p">, </span>Any<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">end</span><span class="p">:</span> <span class="n">Union<span class="p">[</span>str<span class="p">, </span>Any<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">periods</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>int<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">freq</span><span class="p">:</span> <span class="n">Union[str, pandas._libs.tslibs.offsets.DateOffset, None]</span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">tz</span><span class="p">:</span> <span class="n">Union[str, datetime.tzinfo, None]</span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">normalize</span><span class="p">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="default_value">False</span></em>, <em class="sig-param"><span class="n">name</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>str<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="n">closed</span><span class="p">:</span> <span class="n">Optional<span class="p">[</span>str<span class="p">]</span></span> <span class="o">=</span> <span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span></em><span class="sig-paren">)</span> &#x2192; pyspark.pandas.indexes.datetimes.DatetimeIndex<a class="reference internal" href="../../../_modules/pyspark/pandas/namespace.html#date_range"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyspark.pandas.date_range" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a fixed frequency DatetimeIndex.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><dl class="simple">
<dt><strong>start</strong><span class="classifier">str or datetime-like, optional</span></dt><dd><p>Left bound for generating dates.</p>
</dd>
<dt><strong>end</strong><span class="classifier">str or datetime-like, optional</span></dt><dd><p>Right bound for generating dates.</p>
</dd>
<dt><strong>periods</strong><span class="classifier">int, optional</span></dt><dd><p>Number of periods to generate.</p>
</dd>
<dt><strong>freq</strong><span class="classifier">str or DateOffset, default ‘D’</span></dt><dd><p>Frequency strings can have multiples, e.g. ‘5H’.</p>
</dd>
<dt><strong>tz</strong><span class="classifier">str or tzinfo, optional</span></dt><dd><p>Time zone name for returning localized DatetimeIndex, for example
‘Asia/Hong_Kong’. By default, the resulting DatetimeIndex is
timezone-naive.</p>
</dd>
<dt><strong>normalize</strong><span class="classifier">bool, default False</span></dt><dd><p>Normalize start/end dates to midnight before generating date range.</p>
</dd>
<dt><strong>name</strong><span class="classifier">str, default None</span></dt><dd><p>Name of the resulting DatetimeIndex.</p>
</dd>
<dt><strong>closed</strong><span class="classifier">{None, ‘left’, ‘right’}, optional</span></dt><dd><p>Make the interval closed with respect to the given frequency to
the ‘left’, ‘right’, or both sides (None, the default).</p>
</dd>
<dt><strong>**kwargs</strong></dt><dd><p>For compatibility. Has no effect on the result.</p>
</dd>
</dl>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><dl class="simple">
<dt><strong>rng</strong><span class="classifier">DatetimeIndex</span></dt><dd></dd>
</dl>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<dl class="simple">
<dt><a class="reference internal" href="pyspark.pandas.DatetimeIndex.html#pyspark.pandas.DatetimeIndex" title="pyspark.pandas.DatetimeIndex"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DatetimeIndex</span></code></a></dt><dd><p>An immutable container for datetimes.</p>
</dd>
</dl>
</div>
<p class="rubric">Notes</p>
<p>Of the four parameters <code class="docutils literal notranslate"><span class="pre">start</span></code>, <code class="docutils literal notranslate"><span class="pre">end</span></code>, <code class="docutils literal notranslate"><span class="pre">periods</span></code>, and <code class="docutils literal notranslate"><span class="pre">freq</span></code>,
exactly three must be specified. If <code class="docutils literal notranslate"><span class="pre">freq</span></code> is omitted, the resulting
<code class="docutils literal notranslate"><span class="pre">DatetimeIndex</span></code> will have <code class="docutils literal notranslate"><span class="pre">periods</span></code> linearly spaced elements between
<code class="docutils literal notranslate"><span class="pre">start</span></code> and <code class="docutils literal notranslate"><span class="pre">end</span></code> (closed on both sides).</p>
<p>To learn more about the frequency strings, please see <a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases">this link</a>.</p>
<p class="rubric">Examples</p>
<p><strong>Specifying the values</strong></p>
<p>The next four examples generate the same <cite>DatetimeIndex</cite>, but vary
the combination of <cite>start</cite>, <cite>end</cite> and <cite>periods</cite>.</p>
<p>Specify <cite>start</cite> and <cite>end</cite>, with the default daily frequency.</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ps</span><span class="o">.</span><span class="n">date_range</span><span class="p">(</span><span class="n">start</span><span class="o">=</span><span class="s1">&#39;1/1/2018&#39;</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s1">&#39;1/08/2018&#39;</span><span class="p">)</span>
<span class="go">DatetimeIndex([&#39;2018-01-01&#39;, &#39;2018-01-02&#39;, &#39;2018-01-03&#39;, &#39;2018-01-04&#39;,</span>
<span class="go"> &#39;2018-01-05&#39;, &#39;2018-01-06&#39;, &#39;2018-01-07&#39;, &#39;2018-01-08&#39;],</span>
<span class="go"> dtype=&#39;datetime64[ns]&#39;, freq=None)</span>
</pre></div>
</div>
<p>Specify <cite>start</cite> and <cite>periods</cite>, the number of periods (days).</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ps</span><span class="o">.</span><span class="n">date_range</span><span class="p">(</span><span class="n">start</span><span class="o">=</span><span class="s1">&#39;1/1/2018&#39;</span><span class="p">,</span> <span class="n">periods</span><span class="o">=</span><span class="mi">8</span><span class="p">)</span>
<span class="go">DatetimeIndex([&#39;2018-01-01&#39;, &#39;2018-01-02&#39;, &#39;2018-01-03&#39;, &#39;2018-01-04&#39;,</span>
<span class="go"> &#39;2018-01-05&#39;, &#39;2018-01-06&#39;, &#39;2018-01-07&#39;, &#39;2018-01-08&#39;],</span>
<span class="go"> dtype=&#39;datetime64[ns]&#39;, freq=None)</span>
</pre></div>
</div>
<p>Specify <cite>end</cite> and <cite>periods</cite>, the number of periods (days).</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ps</span><span class="o">.</span><span class="n">date_range</span><span class="p">(</span><span class="n">end</span><span class="o">=</span><span class="s1">&#39;1/1/2018&#39;</span><span class="p">,</span> <span class="n">periods</span><span class="o">=</span><span class="mi">8</span><span class="p">)</span>
<span class="go">DatetimeIndex([&#39;2017-12-25&#39;, &#39;2017-12-26&#39;, &#39;2017-12-27&#39;, &#39;2017-12-28&#39;,</span>
<span class="go"> &#39;2017-12-29&#39;, &#39;2017-12-30&#39;, &#39;2017-12-31&#39;, &#39;2018-01-01&#39;],</span>
<span class="go"> dtype=&#39;datetime64[ns]&#39;, freq=None)</span>
</pre></div>
</div>
<p>Specify <cite>start</cite>, <cite>end</cite>, and <cite>periods</cite>; the frequency is generated
automatically (linearly spaced).</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ps</span><span class="o">.</span><span class="n">date_range</span><span class="p">(</span>
<span class="gp">... </span> <span class="n">start</span><span class="o">=</span><span class="s1">&#39;2018-04-24&#39;</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s1">&#39;2018-04-27&#39;</span><span class="p">,</span> <span class="n">periods</span><span class="o">=</span><span class="mi">3</span>
<span class="gp">... </span><span class="p">)</span>
<span class="go">DatetimeIndex([&#39;2018-04-24 00:00:00&#39;, &#39;2018-04-25 12:00:00&#39;,</span>
<span class="go"> &#39;2018-04-27 00:00:00&#39;],</span>
<span class="go"> dtype=&#39;datetime64[ns]&#39;, freq=None)</span>
</pre></div>
</div>
<p><strong>Other Parameters</strong></p>
<p>Changed the <cite>freq</cite> (frequency) to <code class="docutils literal notranslate"><span class="pre">'M'</span></code> (month end frequency).</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ps</span><span class="o">.</span><span class="n">date_range</span><span class="p">(</span><span class="n">start</span><span class="o">=</span><span class="s1">&#39;1/1/2018&#39;</span><span class="p">,</span> <span class="n">periods</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">freq</span><span class="o">=</span><span class="s1">&#39;M&#39;</span><span class="p">)</span>
<span class="go">DatetimeIndex([&#39;2018-01-31&#39;, &#39;2018-02-28&#39;, &#39;2018-03-31&#39;, &#39;2018-04-30&#39;,</span>
<span class="go"> &#39;2018-05-31&#39;],</span>
<span class="go"> dtype=&#39;datetime64[ns]&#39;, freq=None)</span>
</pre></div>
</div>
<p>Multiples are allowed</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ps</span><span class="o">.</span><span class="n">date_range</span><span class="p">(</span><span class="n">start</span><span class="o">=</span><span class="s1">&#39;1/1/2018&#39;</span><span class="p">,</span> <span class="n">periods</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">freq</span><span class="o">=</span><span class="s1">&#39;3M&#39;</span><span class="p">)</span>
<span class="go">DatetimeIndex([&#39;2018-01-31&#39;, &#39;2018-04-30&#39;, &#39;2018-07-31&#39;, &#39;2018-10-31&#39;,</span>
<span class="go"> &#39;2019-01-31&#39;],</span>
<span class="go"> dtype=&#39;datetime64[ns]&#39;, freq=None)</span>
</pre></div>
</div>
<p><cite>freq</cite> can also be specified as an Offset object.</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ps</span><span class="o">.</span><span class="n">date_range</span><span class="p">(</span>
<span class="gp">... </span> <span class="n">start</span><span class="o">=</span><span class="s1">&#39;1/1/2018&#39;</span><span class="p">,</span> <span class="n">periods</span><span class="o">=</span><span class="mi">5</span><span class="p">,</span> <span class="n">freq</span><span class="o">=</span><span class="n">pd</span><span class="o">.</span><span class="n">offsets</span><span class="o">.</span><span class="n">MonthEnd</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
<span class="gp">... </span><span class="p">)</span>
<span class="go">DatetimeIndex([&#39;2018-01-31&#39;, &#39;2018-04-30&#39;, &#39;2018-07-31&#39;, &#39;2018-10-31&#39;,</span>
<span class="go"> &#39;2019-01-31&#39;],</span>
<span class="go"> dtype=&#39;datetime64[ns]&#39;, freq=None)</span>
</pre></div>
</div>
<p><cite>closed</cite> controls whether to include <cite>start</cite> and <cite>end</cite> that are on the
boundary. The default includes boundary points on either end.</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ps</span><span class="o">.</span><span class="n">date_range</span><span class="p">(</span>
<span class="gp">... </span> <span class="n">start</span><span class="o">=</span><span class="s1">&#39;2017-01-01&#39;</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s1">&#39;2017-01-04&#39;</span><span class="p">,</span> <span class="n">closed</span><span class="o">=</span><span class="kc">None</span>
<span class="gp">... </span><span class="p">)</span>
<span class="go">DatetimeIndex([&#39;2017-01-01&#39;, &#39;2017-01-02&#39;, &#39;2017-01-03&#39;, &#39;2017-01-04&#39;],</span>
<span class="go"> dtype=&#39;datetime64[ns]&#39;, freq=None)</span>
</pre></div>
</div>
<p>Use <code class="docutils literal notranslate"><span class="pre">closed='left'</span></code> to exclude <cite>end</cite> if it falls on the boundary.</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ps</span><span class="o">.</span><span class="n">date_range</span><span class="p">(</span>
<span class="gp">... </span> <span class="n">start</span><span class="o">=</span><span class="s1">&#39;2017-01-01&#39;</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s1">&#39;2017-01-04&#39;</span><span class="p">,</span> <span class="n">closed</span><span class="o">=</span><span class="s1">&#39;left&#39;</span>
<span class="gp">... </span><span class="p">)</span>
<span class="go">DatetimeIndex([&#39;2017-01-01&#39;, &#39;2017-01-02&#39;, &#39;2017-01-03&#39;], dtype=&#39;datetime64[ns]&#39;, freq=None)</span>
</pre></div>
</div>
<p>Use <code class="docutils literal notranslate"><span class="pre">closed='right'</span></code> to exclude <cite>start</cite> if it falls on the boundary.</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ps</span><span class="o">.</span><span class="n">date_range</span><span class="p">(</span>
<span class="gp">... </span> <span class="n">start</span><span class="o">=</span><span class="s1">&#39;2017-01-01&#39;</span><span class="p">,</span> <span class="n">end</span><span class="o">=</span><span class="s1">&#39;2017-01-04&#39;</span><span class="p">,</span> <span class="n">closed</span><span class="o">=</span><span class="s1">&#39;right&#39;</span>
<span class="gp">... </span><span class="p">)</span>
<span class="go">DatetimeIndex([&#39;2017-01-02&#39;, &#39;2017-01-03&#39;, &#39;2017-01-04&#39;], dtype=&#39;datetime64[ns]&#39;, freq=None)</span>
</pre></div>
</div>
</dd></dl>
</div>
</div>
<div class='prev-next-bottom'>
<a class='left-prev' id="prev-link" href="pyspark.pandas.to_datetime.html" title="previous page">pyspark.pandas.to_datetime</a>
<a class='right-next' id="next-link" href="pyspark.pandas.to_timedelta.html" title="next page">pyspark.pandas.to_timedelta</a>
</div>
</main>
</div>
</div>
<script src="../../../_static/js/index.3da636dd464baa7582d2.js"></script>
<footer class="footer mt-5 mt-md-0">
<div class="container">
<p>
&copy; Copyright .<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.0.4.<br/>
</p>
</div>
</footer>
</body>
</html>