matplotlib.github.com/2.0.2/api/dates_api.html at main · matplotlib/matplotlib.github.com

History

970 lines (883 loc) · 85.3 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>dates — Matplotlib 2.0.2 documentation</title>

type="text/css" />

type="text/css" />

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '2.0.2',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true,

SOURCELINK_SUFFIX: '.txt'

};

</script>

title="Search within Matplotlib 2.0.2 documentation"

href="../_static/opensearch.xml"/>

</head>

<body>

<div id="unreleased-message"> You are reading an old version of the documentation (v2.0.2). For the latest version see <a href="https://matplotlib.org/stable/api/dates_api.html">https://matplotlib.org/stable/api/dates_api.html</a></div>

</map>

</div>

<h3>Navigation</h3>

<ul>

<a href="../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="dviread.html" title="dviread"

accesskey="N">next</a> |</li>

<a href="container_api.html" title="container"

accesskey="P">previous</a> |</li>

<li><a href="../examples/index.html">examples</a>| </li>

<li><a href="../gallery.html">gallery</a>| </li>

<li><a href="pyplot_summary.html">pyplot</a>| </li>

<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>

</ul>

</div>

</a>

Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">

</a>

<h3><a href="../contents.html">Table Of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">dates</a><ul>

<li><a class="reference internal" href="#module-matplotlib.dates"><code class="docutils literal">matplotlib.dates</code></a><ul>

<li><a class="reference internal" href="#date-tickers">Date tickers</a></li>

<li><a class="reference internal" href="#date-formatters">Date formatters</a></li>

</ul>

</li>

</ul>

</li>

</ul>

<h3>Related Topics</h3>

<ul>

<li><a href="../contents.html">Documentation overview</a><ul>

<li><a href="index.html">The Matplotlib API</a><ul>

<li>Previous: <a href="container_api.html" title="previous chapter">container</a></li>

<li>Next: <a href="dviread.html" title="next chapter">dviread</a></li>

</ul></li>

</ul>

</div>

<li><a href="../_sources/api/dates_api.rst.txt"

rel="nofollow">Show Source</a></li>

</ul>

</div>

<h3>Quick search</h3>

</form>

</div>

</div>

<h1>dates<a class="headerlink" href="#dates" title="Permalink to this headline">¶</a></h1>

</map>

<h2><a class="reference internal" href="#module-matplotlib.dates" title="matplotlib.dates"><code class="xref py py-mod docutils literal">matplotlib.dates</code></a><a class="headerlink" href="#module-matplotlib.dates" title="Permalink to this headline">¶</a></h2>

Matplotlib provides sophisticated date plotting capabilities, standing on the

shoulders of python <code class="xref py py-mod docutils literal">datetime</code>, the add-on modules <code class="xref py py-mod docutils literal">pytz</code> and

<code class="xref py py-mod docutils literal">dateutil</code>. <code class="xref py py-class docutils literal">datetime</code> objects are converted to floating point

numbers which represent time in days since 0001-01-01 UTC, plus 1. For

example, 0001-01-01, 06:00 is 1.25, not 0.25. The helper functions

<a class="reference internal" href="#matplotlib.dates.date2num" title="matplotlib.dates.date2num"><code class="xref py py-func docutils literal">date2num()</code></a>, <a class="reference internal" href="#matplotlib.dates.num2date" title="matplotlib.dates.num2date"><code class="xref py py-func docutils literal">num2date()</code></a> and <a class="reference internal" href="#matplotlib.dates.drange" title="matplotlib.dates.drange"><code class="xref py py-func docutils literal">drange()</code></a> are used to facilitate

easy conversion to and from <code class="xref py py-mod docutils literal">datetime</code> and numeric ranges.

Note

Like Python’s datetime, mpl uses the Gregorian calendar for all

conversions between dates and floating point numbers. This practice

is not universal, and calendar differences can cause confusing

differences between what Python and mpl give as the number of days

since 0001-01-01 and what other software and databases yield. For

example, the US Naval Observatory uses a calendar that switches

from Julian to Gregorian in October, 1582. Hence, using their

calculator, the number of days between 0001-01-01 and 2006-04-01 is

732403, whereas using the Gregorian calendar via the datetime

module we find:

<div class="last highlight-default"><div class="highlight"><pre>In [31]:date(2006,4,1).toordinal() - date(1,1,1).toordinal()

Out[31]:732401

</pre></div>

</div>

A wide range of specific and general purpose date tick locators and

formatters are provided in this module. See

<a class="reference internal" href="ticker_api.html#module-matplotlib.ticker" title="matplotlib.ticker"><code class="xref py py-mod docutils literal">matplotlib.ticker</code></a> for general information on tick locators

and formatters. These are described below.

All the matplotlib date converters, tickers and formatters are

timezone aware, and the default timezone is given by the timezone

parameter in your <code class="file docutils literal">matplotlibrc</code> file. If you leave out a

<code class="xref py py-class docutils literal">tz</code> timezone instance, the default from your rc file will be

assumed. If you want to use a custom time zone, pass a

<code class="xref py py-class docutils literal">pytz.timezone</code> instance with the tz keyword argument to

<a class="reference internal" href="#matplotlib.dates.num2date" title="matplotlib.dates.num2date"><code class="xref py py-func docutils literal">num2date()</code></a>, <code class="xref py py-func docutils literal">plot_date()</code>, and any custom date tickers or

locators you create. See <a class="reference external" href="http://pythonhosted.org/pytz/">pytz</a> for

information on <code class="xref py py-mod docutils literal">pytz</code> and timezone handling.

The <a class="reference external" href="https://dateutil.readthedocs.io/en/stable/">dateutil module</a> provides

additional code to handle date ticking, making it easy to place ticks

on any kinds of dates. See examples below.

<h3>Date tickers<a class="headerlink" href="#date-tickers" title="Permalink to this headline">¶</a></h3>

Most of the date tickers can locate single or multiple values. For

example:

<div class="highlight-default"><div class="highlight"><pre># import constants for the days of the week

from matplotlib.dates import MO, TU, WE, TH, FR, SA, SU

# tick on mondays every week

loc = WeekdayLocator(byweekday=MO, tz=tz)

# tick on mondays and saturdays

loc = WeekdayLocator(byweekday=(MO, SA))

</pre></div>

</div>

In addition, most of the constructors take an interval argument:

<div class="highlight-default"><div class="highlight"><pre># tick on mondays every second week

loc = WeekdayLocator(byweekday=MO, interval=2)

</pre></div>

</div>

The rrule locator allows completely general date ticking:

<div class="highlight-default"><div class="highlight"><pre># tick every 5th easter

rule = rrulewrapper(YEARLY, byeaster=1, interval=5)

loc = RRuleLocator(rule)

</pre></div>

</div>

Here are all the date tickers:

<li><a class="reference internal" href="#matplotlib.dates.MinuteLocator" title="matplotlib.dates.MinuteLocator"><code class="xref py py-class docutils literal">MinuteLocator</code></a>: locate minutes</li>

<li><a class="reference internal" href="#matplotlib.dates.HourLocator" title="matplotlib.dates.HourLocator"><code class="xref py py-class docutils literal">HourLocator</code></a>: locate hours</li>

<li><a class="reference internal" href="#matplotlib.dates.DayLocator" title="matplotlib.dates.DayLocator"><code class="xref py py-class docutils literal">DayLocator</code></a>: locate specifed days of the month</li>

<li><a class="reference internal" href="#matplotlib.dates.WeekdayLocator" title="matplotlib.dates.WeekdayLocator"><code class="xref py py-class docutils literal">WeekdayLocator</code></a>: Locate days of the week, e.g., MO, TU</li>

<li><a class="reference internal" href="#matplotlib.dates.MonthLocator" title="matplotlib.dates.MonthLocator"><code class="xref py py-class docutils literal">MonthLocator</code></a>: locate months, e.g., 7 for july</li>

<li><a class="reference internal" href="#matplotlib.dates.YearLocator" title="matplotlib.dates.YearLocator"><code class="xref py py-class docutils literal">YearLocator</code></a>: locate years that are multiples of base</li>

<li><a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><code class="xref py py-class docutils literal">RRuleLocator</code></a>: locate using a

<code class="xref py py-class docutils literal">matplotlib.dates.rrulewrapper</code>. The

<code class="xref py py-class docutils literal">rrulewrapper</code> is a simple wrapper around a

<code class="xref py py-class docutils literal">dateutil.rrule</code> (<a class="reference external" href="https://dateutil.readthedocs.io/en/stable/">dateutil</a>) which allow almost

arbitrary date tick specifications. See <a class="reference external" href="../examples/pylab_examples/date_demo_rrule.html">rrule example</a>.</li>

<li><a class="reference internal" href="#matplotlib.dates.AutoDateLocator" title="matplotlib.dates.AutoDateLocator"><code class="xref py py-class docutils literal">AutoDateLocator</code></a>: On autoscale, this class picks the best

<code class="xref py py-class docutils literal">MultipleDateLocator</code> to set the view limits and the tick

locations.</li>

</ul>

</div></blockquote>

</div>

<h3>Date formatters<a class="headerlink" href="#date-formatters" title="Permalink to this headline">¶</a></h3>

Here all all the date formatters:

<li><a class="reference internal" href="#matplotlib.dates.AutoDateFormatter" title="matplotlib.dates.AutoDateFormatter"><code class="xref py py-class docutils literal">AutoDateFormatter</code></a>: attempts to figure out the best format

to use. This is most useful when used with the <a class="reference internal" href="#matplotlib.dates.AutoDateLocator" title="matplotlib.dates.AutoDateLocator"><code class="xref py py-class docutils literal">AutoDateLocator</code></a>.</li>

<li><a class="reference internal" href="#matplotlib.dates.DateFormatter" title="matplotlib.dates.DateFormatter"><code class="xref py py-class docutils literal">DateFormatter</code></a>: use <code class="xref py py-func docutils literal">strftime()</code> format strings</li>

<li><a class="reference internal" href="#matplotlib.dates.IndexDateFormatter" title="matplotlib.dates.IndexDateFormatter"><code class="xref py py-class docutils literal">IndexDateFormatter</code></a>: date plots with implicit x

indexing.</li>

</ul>

</div></blockquote>

<code class="descclassname">matplotlib.dates.</code><code class="descname">date2num</code>(d)<a class="headerlink" href="#matplotlib.dates.date2num" title="Permalink to this definition">¶</a></dt>

<dd>d is either a <code class="xref py py-class docutils literal">datetime</code> instance or a sequence of datetimes.

Return value is a floating point number (or sequence of floats)

which gives the number of days (fraction part represents hours,

minutes, seconds) since 0001-01-01 00:00:00 UTC, plus one.

The addition of one here is a historical artifact. Also, note

that the Gregorian calendar is assumed; this is not universal

practice. For details, see the module docstring.

</dd></dl>

<code class="descclassname">matplotlib.dates.</code><code class="descname">num2date</code>(x, tz=None)<a class="headerlink" href="#matplotlib.dates.num2date" title="Permalink to this definition">¶</a></dt>

<dd>x is a float value which gives the number of days

(fraction part represents hours, minutes, seconds) since

0001-01-01 00:00:00 UTC plus one.

The addition of one here is a historical artifact. Also, note

that the Gregorian calendar is assumed; this is not universal

practice. For details, see the module docstring.

Return value is a <code class="xref py py-class docutils literal">datetime</code> instance in timezone tz (default to

rcparams TZ value).

If x is a sequence, a sequence of <code class="xref py py-class docutils literal">datetime</code> objects will

be returned.

</dd></dl>

<code class="descclassname">matplotlib.dates.</code><code class="descname">drange</code>(dstart, dend, delta)<a class="headerlink" href="#matplotlib.dates.drange" title="Permalink to this definition">¶</a></dt>

<dd>Return a date range as float Gregorian ordinals. dstart and

dend are <code class="xref py py-class docutils literal">datetime</code> instances. delta is a

<code class="xref py py-class docutils literal">datetime.timedelta</code> instance.

</dd></dl>

<code class="descclassname">matplotlib.dates.</code><code class="descname">epoch2num</code>(e)<a class="headerlink" href="#matplotlib.dates.epoch2num" title="Permalink to this definition">¶</a></dt>

<dd>Convert an epoch or sequence of epochs to the new date format,

that is days since 0001.

</dd></dl>

<code class="descclassname">matplotlib.dates.</code><code class="descname">num2epoch</code>(d)<a class="headerlink" href="#matplotlib.dates.num2epoch" title="Permalink to this definition">¶</a></dt>

<dd>Convert days since 0001 to epoch. d can be a number or sequence.

</dd></dl>

<code class="descclassname">matplotlib.dates.</code><code class="descname">mx2num</code>(mxdates)<a class="headerlink" href="#matplotlib.dates.mx2num" title="Permalink to this definition">¶</a></dt>

<dd>Convert mx <code class="xref py py-class docutils literal">datetime</code> instance (or sequence of mx

instances) to the new date format.

</dd></dl>

class <code class="descclassname">matplotlib.dates.</code><code class="descname">DateFormatter</code>(fmt, tz=None)<a class="headerlink" href="#matplotlib.dates.DateFormatter" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal">matplotlib.ticker.Formatter</code></a>

Tick location is seconds since the epoch. Use a <a class="reference internal" href="#matplotlib.dates.DateFormatter.strftime" title="matplotlib.dates.DateFormatter.strftime"><code class="xref py py-func docutils literal">strftime()</code></a>

format string.

Python only supports <code class="xref py py-mod docutils literal">datetime</code> <a class="reference internal" href="#matplotlib.dates.DateFormatter.strftime" title="matplotlib.dates.DateFormatter.strftime"><code class="xref py py-func docutils literal">strftime()</code></a> formatting

for years greater than 1900. Thanks to Andrew Dalke, Dalke

Scientific Software who contributed the <a class="reference internal" href="#matplotlib.dates.DateFormatter.strftime" title="matplotlib.dates.DateFormatter.strftime"><code class="xref py py-func docutils literal">strftime()</code></a> code

below to include dates earlier than this year.

<dt>fmt is a <a class="reference internal" href="#matplotlib.dates.DateFormatter.strftime" title="matplotlib.dates.DateFormatter.strftime"><code class="xref py py-func docutils literal">strftime()</code></a> format string; tz is the</dt>

<dd><code class="xref py py-class docutils literal">tzinfo</code> instance.</dd>

</dl>

<code class="descname">illegal_s</code> = re.compile('((^|[^%])(%%)*%s)')<a class="headerlink" href="#matplotlib.dates.DateFormatter.illegal_s" title="Permalink to this definition">¶</a></dt>

<code class="descname">set_tzinfo</code>(tz)<a class="headerlink" href="#matplotlib.dates.DateFormatter.set_tzinfo" title="Permalink to this definition">¶</a></dt>

<code class="descname">strftime</code>(dt, fmt=None)<a class="headerlink" href="#matplotlib.dates.DateFormatter.strftime" title="Permalink to this definition">¶</a></dt>

<dd>Refer to documentation for datetime.strftime.

fmt is a <a class="reference internal" href="#matplotlib.dates.DateFormatter.strftime" title="matplotlib.dates.DateFormatter.strftime"><code class="xref py py-func docutils literal">strftime()</code></a> format string.

Warning: For years before 1900, depending upon the current

locale it is possible that the year displayed with %x might

be incorrect. For years before 100, %y and %Y will yield

zero-padded strings.

</dd></dl>

<code class="descname">strftime_pre_1900</code>(dt, fmt=None)<a class="headerlink" href="#matplotlib.dates.DateFormatter.strftime_pre_1900" title="Permalink to this definition">¶</a></dt>

<dd>Call time.strftime for years before 1900 by rolling

forward a multiple of 28 years.

Dalke: I hope I did this math right. Every 28 years the

calendar repeats, except through century leap years excepting

the 400 year leap years. But only if you’re using the Gregorian

calendar.

</dd></dl>

class <code class="descclassname">matplotlib.dates.</code><code class="descname">IndexDateFormatter</code>(t, fmt, tz=None)<a class="headerlink" href="#matplotlib.dates.IndexDateFormatter" title="Permalink to this definition">¶</a></dt>

Use with <a class="reference internal" href="ticker_api.html#matplotlib.ticker.IndexLocator" title="matplotlib.ticker.IndexLocator"><code class="xref py py-class docutils literal">IndexLocator</code></a> to cycle format

strings by index.

t is a sequence of dates (floating point days). fmt is a

<code class="xref py py-func docutils literal">strftime()</code> format string.

</dd></dl>

class <code class="descclassname">matplotlib.dates.</code><code class="descname">AutoDateFormatter</code>(locator, tz=None, defaultfmt='%Y-%m-%d')<a class="headerlink" href="#matplotlib.dates.AutoDateFormatter" title="Permalink to this definition">¶</a></dt>

This class attempts to figure out the best format to use. This is

most useful when used with the <a class="reference internal" href="#matplotlib.dates.AutoDateLocator" title="matplotlib.dates.AutoDateLocator"><code class="xref py py-class docutils literal">AutoDateLocator</code></a>.

The AutoDateFormatter has a scale dictionary that maps the scale

of the tick (the distance in days between one major tick) and a

format string. The default looks like this:

<div class="highlight-default"><div class="highlight"><pre>self.scaled = {

DAYS_PER_YEAR: rcParams['date.autoformat.year'],

DAYS_PER_MONTH: rcParams['date.autoformat.month'],

1.0: rcParams['date.autoformat.day'],

1. / HOURS_PER_DAY: rcParams['date.autoformat.hour'],

1. / (MINUTES_PER_DAY): rcParams['date.autoformat.minute'],

1. / (SEC_PER_DAY): rcParams['date.autoformat.second'],

1. / (MUSECONDS_PER_DAY): rcParams['date.autoformat.microsecond'],

}

</pre></div>

</div>

The algorithm picks the key in the dictionary that is >= the

current scale and uses that format string. You can customize this

dictionary by doing:

<div class="highlight-default"><div class="highlight"><pre>>>> locator = AutoDateLocator()

>>> formatter = AutoDateFormatter(locator)

>>> formatter.scaled[1/(24.*60.)] = '%M:%S' # only show min and sec

</pre></div>

</div>

A custom <a class="reference internal" href="ticker_api.html#matplotlib.ticker.FuncFormatter" title="matplotlib.ticker.FuncFormatter"><code class="xref py py-class docutils literal">FuncFormatter</code></a> can also be used.

The following example shows how to use a custom format function to strip

trailing zeros from decimal seconds and adds the date to the first

ticklabel:

<div class="highlight-default"><div class="highlight"><pre>>>> def my_format_function(x, pos=None):

... x = matplotlib.dates.num2date(x)

... if pos == 0:

... fmt = '%D %H:%M:%S.%f'

... else:

... fmt = '%H:%M:%S.%f'

... label = x.strftime(fmt)

... label = label.rstrip("0")

... return label

>>> from matplotlib.ticker import FuncFormatter

>>> formatter.scaled[1/(24.*60.)] = FuncFormatter(my_format_function)

</pre></div>

</div>

Autoformat the date labels. The default format is the one to use

if none of the values in <code class="docutils literal">self.scaled</code> are greater than the unit

returned by <code class="docutils literal">locator._get_unit()</code>.

</dd></dl>

class <code class="descclassname">matplotlib.dates.</code><code class="descname">DateLocator</code>(tz=None)<a class="headerlink" href="#matplotlib.dates.DateLocator" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal">matplotlib.ticker.Locator</code></a>

Determines the tick locations when plotting dates.

tz is a <code class="xref py py-class docutils literal">tzinfo</code> instance.

<code class="descname">datalim_to_dt</code>()<a class="headerlink" href="#matplotlib.dates.DateLocator.datalim_to_dt" title="Permalink to this definition">¶</a></dt>

<dd>Convert axis data interval to datetime objects.

</dd></dl>

<code class="descname">hms0d</code> = {'byhour': 0, 'byminute': 0, 'bysecond': 0}<a class="headerlink" href="#matplotlib.dates.DateLocator.hms0d" title="Permalink to this definition">¶</a></dt>

<code class="descname">nonsingular</code>(vmin, vmax)<a class="headerlink" href="#matplotlib.dates.DateLocator.nonsingular" title="Permalink to this definition">¶</a></dt>

<dd>Given the proposed upper and lower extent, adjust the range

if it is too close to being singular (i.e. a range of ~0).

</dd></dl>

<code class="descname">set_tzinfo</code>(tz)<a class="headerlink" href="#matplotlib.dates.DateLocator.set_tzinfo" title="Permalink to this definition">¶</a></dt>

<dd>Set time zone info.

</dd></dl>

<code class="descname">viewlim_to_dt</code>()<a class="headerlink" href="#matplotlib.dates.DateLocator.viewlim_to_dt" title="Permalink to this definition">¶</a></dt>

<dd>Converts the view interval to datetime objects.

</dd></dl>

class <code class="descclassname">matplotlib.dates.</code><code class="descname">RRuleLocator</code>(o, tz=None)<a class="headerlink" href="#matplotlib.dates.RRuleLocator" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="#matplotlib.dates.DateLocator" title="matplotlib.dates.DateLocator"><code class="xref py py-class docutils literal">matplotlib.dates.DateLocator</code></a>

<code class="descname">autoscale</code>()<a class="headerlink" href="#matplotlib.dates.RRuleLocator.autoscale" title="Permalink to this definition">¶</a></dt>

<dd>Set the view limits to include the data range.

</dd></dl>

static <code class="descname">get_unit_generic</code>(freq)<a class="headerlink" href="#matplotlib.dates.RRuleLocator.get_unit_generic" title="Permalink to this definition">¶</a></dt>

<code class="descname">tick_values</code>(vmin, vmax)<a class="headerlink" href="#matplotlib.dates.RRuleLocator.tick_values" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <code class="descclassname">matplotlib.dates.</code><code class="descname">AutoDateLocator</code>(tz=None, minticks=5, maxticks=None, interval_multiples=False)<a class="headerlink" href="#matplotlib.dates.AutoDateLocator" title="Permalink to this definition">¶</a></dt>

On autoscale, this class picks the best

<a class="reference internal" href="#matplotlib.dates.DateLocator" title="matplotlib.dates.DateLocator"><code class="xref py py-class docutils literal">DateLocator</code></a> to set the view limits and the tick

locations.

minticks is the minimum number of ticks desired, which is used to

select the type of ticking (yearly, monthly, etc.).

maxticks is the maximum number of ticks desired, which controls

any interval between ticks (ticking every other, every 3, etc.).

For really fine-grained control, this can be a dictionary mapping

individual rrule frequency constants (YEARLY, MONTHLY, etc.)

to their own maximum number of ticks. This can be used to keep

the number of ticks appropriate to the format chosen in

<a class="reference internal" href="#matplotlib.dates.AutoDateFormatter" title="matplotlib.dates.AutoDateFormatter"><code class="xref py py-class docutils literal">AutoDateFormatter</code></a>. Any frequency not specified in this

dictionary is given a default value.

tz is a <code class="xref py py-class docutils literal">tzinfo</code> instance.

interval_multiples is a boolean that indicates whether ticks

should be chosen to be multiple of the interval. This will lock

ticks to ‘nicer’ locations. For example, this will force the

ticks to be at hours 0,6,12,18 when hourly ticking is done at

6 hour intervals.

The AutoDateLocator has an interval dictionary that maps the

frequency of the tick (a constant from dateutil.rrule) and a

multiple allowed for that ticking. The default looks like this:

<div class="highlight-default"><div class="highlight"><pre>self.intervald = {

YEARLY : [1, 2, 4, 5, 10, 20, 40, 50, 100, 200, 400, 500,

1000, 2000, 4000, 5000, 10000],

MONTHLY : [1, 2, 3, 4, 6],

DAILY : [1, 2, 3, 7, 14],

HOURLY : [1, 2, 3, 4, 6, 12],

MINUTELY: [1, 5, 10, 15, 30],

SECONDLY: [1, 5, 10, 15, 30],

MICROSECONDLY: [1, 2, 5, 10, 20, 50, 100, 200, 500, 1000, 2000,

5000, 10000, 20000, 50000, 100000, 200000, 500000,

1000000],

}

</pre></div>

</div>

The interval is used to specify multiples that are appropriate for

the frequency of ticking. For instance, every 7 days is sensible

for daily ticks, but for minutes/seconds, 15 or 30 make sense.

You can customize this dictionary by doing:

<div class="highlight-default"><div class="highlight"><pre>locator = AutoDateLocator()

locator.intervald[HOURLY] = [3] # only show every 3 hours

</pre></div>

</div>

<code class="descname">autoscale</code>()<a class="headerlink" href="#matplotlib.dates.AutoDateLocator.autoscale" title="Permalink to this definition">¶</a></dt>

<dd>Try to choose the view limits intelligently.

</dd></dl>

<code class="descname">get_locator</code>(dmin, dmax)<a class="headerlink" href="#matplotlib.dates.AutoDateLocator.get_locator" title="Permalink to this definition">¶</a></dt>

<dd>Pick the best locator based on a distance.

</dd></dl>

<code class="descname">nonsingular</code>(vmin, vmax)<a class="headerlink" href="#matplotlib.dates.AutoDateLocator.nonsingular" title="Permalink to this definition">¶</a></dt>

<code class="descname">refresh</code>()<a class="headerlink" href="#matplotlib.dates.AutoDateLocator.refresh" title="Permalink to this definition">¶</a></dt>

<dd>Refresh internal information based on current limits.

</dd></dl>

<code class="descname">tick_values</code>(vmin, vmax)<a class="headerlink" href="#matplotlib.dates.AutoDateLocator.tick_values" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <code class="descclassname">matplotlib.dates.</code><code class="descname">YearLocator</code>(base=1, month=1, day=1, tz=None)<a class="headerlink" href="#matplotlib.dates.YearLocator" title="Permalink to this definition">¶</a></dt>

Make ticks on a given day of each year that is a multiple of base.

Examples:

<div class="highlight-default"><div class="highlight"><pre># Tick every year on Jan 1st

locator = YearLocator()

# Tick every 5 years on July 4th

locator = YearLocator(5, month=7, day=4)

</pre></div>

</div>

Mark years that are multiple of base on a given month and day

(default jan 1).

<code class="descname">autoscale</code>()<a class="headerlink" href="#matplotlib.dates.YearLocator.autoscale" title="Permalink to this definition">¶</a></dt>

<dd>Set the view limits to include the data range.

</dd></dl>

<code class="descname">tick_values</code>(vmin, vmax)<a class="headerlink" href="#matplotlib.dates.YearLocator.tick_values" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <code class="descclassname">matplotlib.dates.</code><code class="descname">MonthLocator</code>(bymonth=None, bymonthday=1, interval=1, tz=None)<a class="headerlink" href="#matplotlib.dates.MonthLocator" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><code class="xref py py-class docutils literal">matplotlib.dates.RRuleLocator</code></a>

Make ticks on occurances of each month month, e.g., 1, 3, 12.

Mark every month in bymonth; bymonth can be an int or

sequence. Default is <code class="docutils literal">range(1,13)</code>, i.e. every month.

interval is the interval between each iteration. For

example, if <code class="docutils literal">interval=2</code>, mark every second occurance.

</dd></dl>

class <code class="descclassname">matplotlib.dates.</code><code class="descname">WeekdayLocator</code>(byweekday=1, interval=1, tz=None)<a class="headerlink" href="#matplotlib.dates.WeekdayLocator" title="Permalink to this definition">¶</a></dt>

Make ticks on occurances of each weekday.

Mark every weekday in byweekday; byweekday can be a number or

sequence.

Elements of byweekday must be one of MO, TU, WE, TH, FR, SA,

SU, the constants from <code class="xref py py-mod docutils literal">dateutil.rrule</code>, which have been

imported into the <a class="reference internal" href="#module-matplotlib.dates" title="matplotlib.dates"><code class="xref py py-mod docutils literal">matplotlib.dates</code></a> namespace.

interval specifies the number of weeks to skip. For example,

<code class="docutils literal">interval=2</code> plots every second week.

</dd></dl>

class <code class="descclassname">matplotlib.dates.</code><code class="descname">DayLocator</code>(bymonthday=None, interval=1, tz=None)<a class="headerlink" href="#matplotlib.dates.DayLocator" title="Permalink to this definition">¶</a></dt>

Make ticks on occurances of each day of the month. For example,

1, 15, 30.

Mark every day in bymonthday; bymonthday can be an int or

sequence.

Default is to tick every day of the month: <code class="docutils literal">bymonthday=range(1,32)</code>

</dd></dl>

class <code class="descclassname">matplotlib.dates.</code><code class="descname">HourLocator</code>(byhour=None, interval=1, tz=None)<a class="headerlink" href="#matplotlib.dates.HourLocator" title="Permalink to this definition">¶</a></dt>

Make ticks on occurances of each hour.

Mark every hour in byhour; byhour can be an int or sequence.

Default is to tick every hour: <code class="docutils literal">byhour=range(24)</code>

interval is the interval between each iteration. For

example, if <code class="docutils literal">interval=2</code>, mark every second occurrence.

</dd></dl>

class <code class="descclassname">matplotlib.dates.</code><code class="descname">MinuteLocator</code>(byminute=None, interval=1, tz=None)<a class="headerlink" href="#matplotlib.dates.MinuteLocator" title="Permalink to this definition">¶</a></dt>

Make ticks on occurances of each minute.

Mark every minute in byminute; byminute can be an int or

sequence. Default is to tick every minute: <code class="docutils literal">byminute=range(60)</code>

interval is the interval between each iteration. For

example, if <code class="docutils literal">interval=2</code>, mark every second occurrence.

</dd></dl>

class <code class="descclassname">matplotlib.dates.</code><code class="descname">SecondLocator</code>(bysecond=None, interval=1, tz=None)<a class="headerlink" href="#matplotlib.dates.SecondLocator" title="Permalink to this definition">¶</a></dt>

Make ticks on occurances of each second.

Mark every second in bysecond; bysecond can be an int or

sequence. Default is to tick every second: <code class="docutils literal">bysecond = range(60)</code>

interval is the interval between each iteration. For

example, if <code class="docutils literal">interval=2</code>, mark every second occurrence.

</dd></dl>

class <code class="descclassname">matplotlib.dates.</code><code class="descname">MicrosecondLocator</code>(interval=1, tz=None)<a class="headerlink" href="#matplotlib.dates.MicrosecondLocator" title="Permalink to this definition">¶</a></dt>

Make ticks on occurances of each microsecond.

interval is the interval between each iteration. For

example, if <code class="docutils literal">interval=2</code>, mark every second microsecond.

<code class="descname">set_data_interval</code>(vmin, vmax)<a class="headerlink" href="#matplotlib.dates.MicrosecondLocator.set_data_interval" title="Permalink to this definition">¶</a></dt>

<code class="descname">set_view_interval</code>(vmin, vmax)<a class="headerlink" href="#matplotlib.dates.MicrosecondLocator.set_view_interval" title="Permalink to this definition">¶</a></dt>

<code class="descname">tick_values</code>(vmin, vmax)<a class="headerlink" href="#matplotlib.dates.MicrosecondLocator.tick_values" title="Permalink to this definition">¶</a></dt>

</dd></dl>

class <code class="descclassname">matplotlib.dates.</code><code class="descname">rrule</code>(freq, dtstart=None, interval=1, wkst=None, count=None, until=None, bysetpos=None, bymonth=None, bymonthday=None, byyearday=None, byeaster=None, byweekno=None, byweekday=None, byhour=None, byminute=None, bysecond=None, cache=False)<a class="headerlink" href="#matplotlib.dates.rrule" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <code class="xref py py-class docutils literal">dateutil.rrule.rrulebase</code>

That’s the base of the rrule operation. It accepts all the keywords

defined in the RFC as its constructor parameters (except byday,

which was renamed to byweekday) and more. The constructor prototype is:

<div class="highlight-default"><div class="highlight"><pre>rrule(freq)

</pre></div>

</div>

Where freq must be one of YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY,

or SECONDLY.

Note

Per RFC section 3.3.10, recurrence instances falling on invalid dates

and times are ignored rather than coerced:

<div>Recurrence rules may generate recurrence instances with an invalid

date (e.g., February 30) or nonexistent local time (e.g., 1:30 AM

on a day where the local time is moved forward by an hour at 1:00

AM). Such recurrence instances MUST be ignored and MUST NOT be

counted as part of the recurrence set.</div></blockquote>

This can lead to possibly surprising behavior when, for example, the

start date occurs at the end of the month:

<div class="last highlight-default"><div class="highlight"><pre>>>> from dateutil.rrule import rrule, MONTHLY

>>> from datetime import datetime

>>> start_date = datetime(2014, 12, 31)

>>> list(rrule(freq=MONTHLY, count=4, dtstart=start_date))

...

[datetime.datetime(2014, 12, 31, 0, 0),

datetime.datetime(2015, 1, 31, 0, 0),

datetime.datetime(2015, 3, 31, 0, 0),

datetime.datetime(2015, 5, 31, 0, 0)]

</pre></div>

</div>

Additionally, it supports the following keyword arguments:

<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">

<li>cache – If given, it must be a boolean value specifying to enable or disable

caching of results. If you will use the same rrule instance multiple

times, enabling caching will improve the performance considerably.</li>

<li>dtstart – The recurrence start. Besides being the base for the recurrence,

missing parameters in the final recurrence instances will also be

extracted from this date. If not given, datetime.now() will be used

instead.</li>

<li>interval – The interval between each freq iteration. For example, when using

YEARLY, an interval of 2 means once every two years, but with HOURLY,

it means once every two hours. The default interval is 1.</li>

<li>wkst – The week start day. Must be one of the MO, TU, WE constants, or an

integer, specifying the first day of the week. This will affect

recurrences based on weekly periods. The default week start is got

from calendar.firstweekday(), and may be modified by

calendar.setfirstweekday().</li>

<li>count – How many occurrences will be generated.

Note

As of version 2.5.0, the use of the <code class="docutils literal">until</code> keyword together

with the <code class="docutils literal">count</code> keyword is deprecated per RFC-2445 Sec. 4.3.10.

</div>

</li>

<li>until – If given, this must be a datetime instance, that will specify the

limit of the recurrence. The last recurrence in the rule is the greatest

datetime that is less than or equal to the value specified in the

<code class="docutils literal">until</code> parameter.

Note

As of version 2.5.0, the use of the <code class="docutils literal">until</code> keyword together

with the <code class="docutils literal">count</code> keyword is deprecated per RFC-2445 Sec. 4.3.10.

</div>

</li>

<li>bysetpos – If given, it must be either an integer, or a sequence of integers,

positive or negative. Each given integer will specify an occurrence

number, corresponding to the nth occurrence of the rule inside the

frequency period. For example, a bysetpos of -1 if combined with a

MONTHLY frequency, and a byweekday of (MO, TU, WE, TH, FR), will

result in the last work day of every month.</li>

<li>bymonth – If given, it must be either an integer, or a sequence of integers,

meaning the months to apply the recurrence to.</li>

<li>bymonthday – If given, it must be either an integer, or a sequence of integers,

meaning the month days to apply the recurrence to.</li>

<li>byyearday – If given, it must be either an integer, or a sequence of integers,

meaning the year days to apply the recurrence to.</li>

<li>byweekno – If given, it must be either an integer, or a sequence of integers,

meaning the week numbers to apply the recurrence to. Week numbers

have the meaning described in ISO8601, that is, the first week of

the year is that containing at least four days of the new year.</li>

<li>byweekday – If given, it must be either an integer (0 == MO), a sequence of

integers, one of the weekday constants (MO, TU, etc), or a sequence

of these constants. When given, these variables will define the

weekdays where the recurrence will be applied. It’s also possible to

use an argument n for the weekday instances, which will mean the nth

occurrence of this weekday in the period. For example, with MONTHLY,

or with YEARLY and BYMONTH, using FR(+1) in byweekday will specify the

first friday of the month where the recurrence happens. Notice that in

the RFC documentation, this is specified as BYDAY, but was renamed to

avoid the ambiguity of that keyword.</li>

<li>byhour – If given, it must be either an integer, or a sequence of integers,

meaning the hours to apply the recurrence to.</li>

<li>byminute – If given, it must be either an integer, or a sequence of integers,

meaning the minutes to apply the recurrence to.</li>

<li>bysecond – If given, it must be either an integer, or a sequence of integers,

meaning the seconds to apply the recurrence to.</li>

<li>byeaster – If given, it must be either an integer, or a sequence of integers,

positive or negative. Each integer will define an offset from the

Easter Sunday. Passing the offset 0 to byeaster will yield the Easter

Sunday itself. This is an extension to the RFC specification.</li>

</ul>

</td>

</tr>

</tbody>

</table>

<code class="descname">replace</code>(**kwargs)<a class="headerlink" href="#matplotlib.dates.rrule.replace" title="Permalink to this definition">¶</a></dt>

<dd>Return new rrule with same attributes except for those attributes given new

values by whichever keyword arguments are specified.

</dd></dl>

class <code class="descclassname">matplotlib.dates.</code><code class="descname">relativedelta</code>(dt1=None, dt2=None, years=0, months=0, days=0, leapdays=0, weeks=0, hours=0, minutes=0, seconds=0, microseconds=0, year=None, month=None, day=None, weekday=None, yearday=None, nlyearday=None, hour=None, minute=None, second=None, microsecond=None)<a class="headerlink" href="#matplotlib.dates.relativedelta" title="Permalink to this definition">¶</a></dt>

<dd>Bases: <code class="xref py py-class docutils literal">object</code>

The relativedelta type is based on the specification of the excellent

work done by M.-A. Lemburg in his

<a class="reference external" href="http://www.egenix.com/files/python/mxDateTime.html">mx.DateTime</a> extension.

However, notice that this type does NOT implement the same algorithm as

his work. Do NOT expect it to behave like mx.DateTime’s counterpart.

There are two different ways to build a relativedelta instance. The

first one is passing it two date/datetime classes:

<div class="highlight-default"><div class="highlight"><pre>relativedelta(datetime1, datetime2)

</pre></div>

</div>

The second one is passing it any number of the following keyword arguments:

<div class="highlight-default"><div class="highlight"><pre>relativedelta(arg1=x,arg2=y,arg3=z...)

year, month, day, hour, minute, second, microsecond:

Absolute information (argument is singular); adding or subtracting a

relativedelta with absolute information does not perform an aritmetic

operation, but rather REPLACES the corresponding value in the

original datetime with the value(s) in relativedelta.

years, months, weeks, days, hours, minutes, seconds, microseconds:

Relative information, may be negative (argument is plural); adding

or subtracting a relativedelta with relative information performs

the corresponding aritmetic operation on the original datetime value

with the information in the relativedelta.

weekday:

One of the weekday instances (MO, TU, etc). These instances may

receive a parameter N, specifying the Nth weekday, which could

be positive or negative (like MO(+1) or MO(-2). Not specifying

it is the same as specifying +1. You can also use an integer,

where 0=MO.

leapdays:

Will add given days to the date found, if year is a leap

year, and the date found is post 28 of february.

yearday, nlyearday:

Set the yearday or the non-leap year day (jump leap days).

These are converted to day/month/leapdays information.

</pre></div>

</div>

Here is the behavior of operations with relativedelta:

<li>Calculate the absolute year, using the ‘year’ argument, or the

original datetime year, if the argument is not present.</li>

<li>Add the relative ‘years’ argument to the absolute year.</li>

<li>Do steps 1 and 2 for month/months.</li>

<li>Calculate the absolute day, using the ‘day’ argument, or the

original datetime day, if the argument is not present. Then,

subtract from the day until it fits in the year and month

found after their operations.</li>

<li>Add the relative ‘days’ argument to the absolute day. Notice

that the ‘weeks’ argument is multiplied by 7 and added to

‘days’.</li>

<li>Do steps 1 and 2 for hour/hours, minute/minutes, second/seconds,

microsecond/microseconds.</li>

<li>If the ‘weekday’ argument is present, calculate the weekday,

with the given (wday, nth) tuple. wday is the index of the

weekday (0-6, 0=Mon), and nth is the number of weeks to add

forward or backward, depending on its signal. Notice that if

the calculated date is already Monday, for example, using

(0, 1) or (0, -1) won’t change the day.</li>

</ol>

<code class="descname">normalized</code>()<a class="headerlink" href="#matplotlib.dates.relativedelta.normalized" title="Permalink to this definition">¶</a></dt>

<dd>Return a version of this object represented entirely using integer

values for the relative attributes.

<div class="highlight-default"><div class="highlight"><pre>>>> relativedelta(days=1.5, hours=2).normalized()

relativedelta(days=1, hours=14)

</pre></div>

</div>

<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Returns a <code class="xref py py-class docutils literal">dateutil.relativedelta.relativedelta</code> object.</td>

</tr>

</tbody>

</table>

</dd></dl>

<code class="descname">weeks</code><a class="headerlink" href="#matplotlib.dates.relativedelta.weeks" title="Permalink to this definition">¶</a></dt>

</dd></dl>

<code class="descclassname">matplotlib.dates.</code><code class="descname">seconds</code>(s)<a class="headerlink" href="#matplotlib.dates.seconds" title="Permalink to this definition">¶</a></dt>

<dd>Return seconds as days.

</dd></dl>

<code class="descclassname">matplotlib.dates.</code><code class="descname">minutes</code>(m)<a class="headerlink" href="#matplotlib.dates.minutes" title="Permalink to this definition">¶</a></dt>

<dd>Return minutes as days.

</dd></dl>

<code class="descclassname">matplotlib.dates.</code><code class="descname">hours</code>(h)<a class="headerlink" href="#matplotlib.dates.hours" title="Permalink to this definition">¶</a></dt>

<dd>Return hours as days.

</dd></dl>

<code class="descclassname">matplotlib.dates.</code><code class="descname">weeks</code>(w)<a class="headerlink" href="#matplotlib.dates.weeks" title="Permalink to this definition">¶</a></dt>

<dd>Return weeks as days.

</dd></dl>

</div>

</div>

Last updated on May 10, 2017.

Created using <a

href="http://sphinx-doc.org/">Sphinx</a> 1.5.5.

</div>

</body>

</footer>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

dates_api.html

Latest commit

History

dates_api.html

File metadata and controls