Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathdates_api.html
More file actions
1027 lines (939 loc) · 88.4 KB
/
Copy pathdates_api.html
File metadata and controls
1027 lines (939 loc) · 88.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>dates — Matplotlib 2.1.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.1.0 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html"
/>
<link rel="search" title="Search" href="../search.html"
/>
<link rel="top" title="Matplotlib 2.1.0 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="dviread" href="dviread.html" />
<link rel="prev" title="container" href="container_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/dates_api.html" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v2.1.0). 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>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html"><img src="../_static/logo2.svg" width="540px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="dviread.html" title="dviread"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="container_api.html" title="container"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../gallery/index.html">examples</a>| </li>
<li><a href="../tutorials/index.html">tutorials</a>| </li>
<li><a href="pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><a href="https://www.numfocus.org">
<image src="https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A">
</a>
<br/>
<a href="http://depsy.org/package/python/matplotlib">
<img src="../_static/depsy_badge.svg">
</a>
<br/>
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
</a>
<br/>
<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"><span class="pre">matplotlib.dates</span></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>
<div class="relations">
<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></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/dates_api.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="dates">
<h1>dates<a class="headerlink" href="#dates" title="Permalink to this headline">¶</a></h1>
<img src="../_images/inheritance-36ae735e98a0b6edf8f91ba8d8c0103247c5195c.png" alt="Inheritance diagram of matplotlib.dates" usemap="#inheritance1bda3e63b5" class="inheritance"/>
<map id="inheritance1bda3e63b5" name="inheritance1bda3e63b5">
<area shape="rect" id="node1" href="#matplotlib.dates.AutoDateFormatter" target="_top" title="This class attempts to figure out the best format to use.  This is" alt="" coords="325,65,447,87"/>
<area shape="rect" id="node2" href="ticker_api.html#matplotlib.ticker.Formatter" target="_top" title="Create a string based on a tick value and location." alt="" coords="191,128,263,149"/>
<area shape="rect" id="node7" href="#matplotlib.dates.DateFormatter" target="_top" title="Tick location is seconds since the epoch.  Use a :func:`strftime`" alt="" coords="337,107,434,128"/>
<area shape="rect" id="node13" href="#matplotlib.dates.IndexDateFormatter" target="_top" title="Use with :class:`~matplotlib.ticker.IndexLocator` to cycle format" alt="" coords="322,148,449,169"/>
<area shape="rect" id="node3" href="#matplotlib.dates.AutoDateLocator" target="_top" title="On autoscale, this class picks the best" alt="" coords="498,127,607,148"/>
<area shape="rect" id="node4" href="#matplotlib.dates.DateLocator" target="_top" title="Determines the tick locations when plotting dates." alt="" coords="343,189,428,210"/>
<area shape="rect" id="node10" href="#matplotlib.dates.RRuleLocator" target="_top" title="RRuleLocator" alt="" coords="508,168,597,189"/>
<area shape="rect" id="node14" href="#matplotlib.dates.MicrosecondLocator" target="_top" title="Make ticks on occurances of each microsecond." alt="" coords="489,209,615,230"/>
<area shape="rect" id="node19" href="#matplotlib.dates.YearLocator" target="_top" title="Make ticks on a given day of each year that is a multiple of base." alt="" coords="512,250,593,271"/>
<area shape="rect" id="node5" href="units_api.html#matplotlib.units.ConversionInterface" target="_top" title="The minimal interface for a converter to take custom instances (or" alt="" coords="4,87,132,108"/>
<area shape="rect" id="node6" title="Converter for datetime.date and datetime.datetime data," alt="" coords="178,87,276,108"/>
<area shape="rect" id="node8" href="ticker_api.html#matplotlib.ticker.Locator" target="_top" title="Determine the tick locations;" alt="" coords="197,189,257,210"/>
<area shape="rect" id="node9" href="#matplotlib.dates.DayLocator" target="_top" title="Make ticks on occurances of each day of the month.  For example," alt="" coords="669,64,749,85"/>
<area shape="rect" id="node12" href="#matplotlib.dates.HourLocator" target="_top" title="Make ticks on occurances of each hour." alt="" coords="667,105,751,127"/>
<area shape="rect" id="node15" href="#matplotlib.dates.MinuteLocator" target="_top" title="Make ticks on occurances of each minute." alt="" coords="661,146,757,168"/>
<area shape="rect" id="node16" href="#matplotlib.dates.MonthLocator" target="_top" title="Make ticks on occurances of each month month, e.g., 1, 3, 12." alt="" coords="663,188,755,209"/>
<area shape="rect" id="node17" href="#matplotlib.dates.SecondLocator" target="_top" title="Make ticks on occurances of each second." alt="" coords="660,229,758,250"/>
<area shape="rect" id="node18" href="#matplotlib.dates.WeekdayLocator" target="_top" title="Make ticks on occurances of each weekday." alt="" coords="655,270,764,291"/>
<area shape="rect" id="node11" href="ticker_api.html#matplotlib.ticker.TickHelper" target="_top" title="TickHelper" alt="" coords="30,169,107,190"/>
<area shape="rect" id="node20" title="Use this class to parse date strings to matplotlib datenums when" alt="" coords="172,46,282,67"/>
<area shape="rect" id="node21" title="Use this class to parse date strings to matplotlib datenums when" alt="" coords="21,46,115,67"/>
</map>
<div class="section" id="module-matplotlib.dates">
<span id="matplotlib-dates"></span><h2><a class="reference internal" href="#module-matplotlib.dates" title="matplotlib.dates"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.dates</span></code></a><a class="headerlink" href="#module-matplotlib.dates" title="Permalink to this headline">¶</a></h2>
<p>Matplotlib provides sophisticated date plotting capabilities, standing on the
shoulders of python <a class="reference external" href="https://docs.python.org/2/library/datetime.html#module-datetime" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">datetime</span></code></a>, the add-on modules <code class="xref py py-mod docutils literal"><span class="pre">pytz</span></code> and
<code class="xref py py-mod docutils literal"><span class="pre">dateutil</span></code>. <code class="xref py py-class docutils literal"><span class="pre">datetime</span></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"><span class="pre">date2num()</span></code></a>, <a class="reference internal" href="#matplotlib.dates.num2date" title="matplotlib.dates.num2date"><code class="xref py py-func docutils literal"><span class="pre">num2date()</span></code></a> and <a class="reference internal" href="#matplotlib.dates.drange" title="matplotlib.dates.drange"><code class="xref py py-func docutils literal"><span class="pre">drange()</span></code></a> are used to facilitate
easy conversion to and from <a class="reference external" href="https://docs.python.org/2/library/datetime.html#module-datetime" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">datetime</span></code></a> and numeric ranges.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>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:</p>
<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="n">In</span> <span class="p">[</span><span class="mi">31</span><span class="p">]:</span><span class="n">date</span><span class="p">(</span><span class="mi">2006</span><span class="p">,</span><span class="mi">4</span><span class="p">,</span><span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">toordinal</span><span class="p">()</span> <span class="o">-</span> <span class="n">date</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">,</span><span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">toordinal</span><span class="p">()</span>
<span class="n">Out</span><span class="p">[</span><span class="mi">31</span><span class="p">]:</span><span class="mi">732401</span>
</pre></div>
</div>
</div>
<p>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"><span class="pre">matplotlib.ticker</span></code></a> for general information on tick locators
and formatters. These are described below.</p>
<p>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"><span class="pre">matplotlibrc</span></code> file. If you leave out a
<code class="xref py py-class docutils literal"><span class="pre">tz</span></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"><span class="pre">pytz.timezone</span></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"><span class="pre">num2date()</span></code></a>, <code class="xref py py-func docutils literal"><span class="pre">plot_date()</span></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"><span class="pre">pytz</span></code> and timezone handling.</p>
<p>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.</p>
<div class="section" id="date-tickers">
<h3>Date tickers<a class="headerlink" href="#date-tickers" title="Permalink to this headline">¶</a></h3>
<p>Most of the date tickers can locate single or multiple values. For
example:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># import constants for the days of the week</span>
<span class="kn">from</span> <span class="nn">matplotlib.dates</span> <span class="k">import</span> <span class="n">MO</span><span class="p">,</span> <span class="n">TU</span><span class="p">,</span> <span class="n">WE</span><span class="p">,</span> <span class="n">TH</span><span class="p">,</span> <span class="n">FR</span><span class="p">,</span> <span class="n">SA</span><span class="p">,</span> <span class="n">SU</span>
<span class="c1"># tick on mondays every week</span>
<span class="n">loc</span> <span class="o">=</span> <span class="n">WeekdayLocator</span><span class="p">(</span><span class="n">byweekday</span><span class="o">=</span><span class="n">MO</span><span class="p">,</span> <span class="n">tz</span><span class="o">=</span><span class="n">tz</span><span class="p">)</span>
<span class="c1"># tick on mondays and saturdays</span>
<span class="n">loc</span> <span class="o">=</span> <span class="n">WeekdayLocator</span><span class="p">(</span><span class="n">byweekday</span><span class="o">=</span><span class="p">(</span><span class="n">MO</span><span class="p">,</span> <span class="n">SA</span><span class="p">))</span>
</pre></div>
</div>
<p>In addition, most of the constructors take an interval argument:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># tick on mondays every second week</span>
<span class="n">loc</span> <span class="o">=</span> <span class="n">WeekdayLocator</span><span class="p">(</span><span class="n">byweekday</span><span class="o">=</span><span class="n">MO</span><span class="p">,</span> <span class="n">interval</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
</pre></div>
</div>
<p>The rrule locator allows completely general date ticking:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># tick every 5th easter</span>
<span class="n">rule</span> <span class="o">=</span> <span class="n">rrulewrapper</span><span class="p">(</span><span class="n">YEARLY</span><span class="p">,</span> <span class="n">byeaster</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">interval</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span>
<span class="n">loc</span> <span class="o">=</span> <span class="n">RRuleLocator</span><span class="p">(</span><span class="n">rule</span><span class="p">)</span>
</pre></div>
</div>
<p>Here are all the date tickers:</p>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="#matplotlib.dates.MinuteLocator" title="matplotlib.dates.MinuteLocator"><code class="xref py py-class docutils literal"><span class="pre">MinuteLocator</span></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"><span class="pre">HourLocator</span></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"><span class="pre">DayLocator</span></code></a>: locate specified 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"><span class="pre">WeekdayLocator</span></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"><span class="pre">MonthLocator</span></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"><span class="pre">YearLocator</span></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"><span class="pre">RRuleLocator</span></code></a>: locate using a
<code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.rrulewrapper</span></code>. The
<code class="xref py py-class docutils literal"><span class="pre">rrulewrapper</span></code> is a simple wrapper around a
<code class="xref py py-class docutils literal"><span class="pre">dateutil.rrule</span></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="../gallery/ticks_and_spines/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"><span class="pre">AutoDateLocator</span></code></a>: On autoscale, this class picks the best
<code class="xref py py-class docutils literal"><span class="pre">MultipleDateLocator</span></code> to set the view limits and the tick
locations.</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="date-formatters">
<h3>Date formatters<a class="headerlink" href="#date-formatters" title="Permalink to this headline">¶</a></h3>
<p>Here all all the date formatters:</p>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="#matplotlib.dates.AutoDateFormatter" title="matplotlib.dates.AutoDateFormatter"><code class="xref py py-class docutils literal"><span class="pre">AutoDateFormatter</span></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"><span class="pre">AutoDateLocator</span></code></a>.</li>
<li><a class="reference internal" href="#matplotlib.dates.DateFormatter" title="matplotlib.dates.DateFormatter"><code class="xref py py-class docutils literal"><span class="pre">DateFormatter</span></code></a>: use <code class="xref py py-func docutils literal"><span class="pre">strftime()</span></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"><span class="pre">IndexDateFormatter</span></code></a>: date plots with implicit <em>x</em>
indexing.</li>
</ul>
</div></blockquote>
<dl class="function">
<dt id="matplotlib.dates.date2num">
<code class="descclassname">matplotlib.dates.</code><code class="descname">date2num</code><span class="sig-paren">(</span><em>d</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.date2num" title="Permalink to this definition">¶</a></dt>
<dd><p>Converts datetime objects to Matplotlib dates.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>d</strong> : <code class="xref py py-class docutils literal"><span class="pre">datetime</span></code> or sequence of <code class="xref py py-class docutils literal"><span class="pre">datetime</span></code></p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">float or sequence of floats</p>
<blockquote class="last">
<div><p>Number of days (fraction part represents hours, minutes, seconds)
since 0001-01-01 00:00:00 UTC, plus one.</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>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.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.dates.num2date">
<code class="descclassname">matplotlib.dates.</code><code class="descname">num2date</code><span class="sig-paren">(</span><em>x</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.num2date" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>x</strong> : float or sequence of floats</p>
<blockquote>
<div><p>Number of days (fraction part represents hours, minutes, seconds)
since 0001-01-01 00:00:00 UTC, plus one.</p>
</div></blockquote>
<p><strong>tz</strong> : string, optional</p>
<blockquote>
<div><p>Timezone of <em>x</em> (defaults to rcparams TZ value).</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first"><code class="xref py py-class docutils literal"><span class="pre">datetime</span></code> or sequence of <code class="xref py py-class docutils literal"><span class="pre">datetime</span></code></p>
<blockquote>
<div><p>Dates are returned in timezone <em>tz</em></p>
</div></blockquote>
<p>If <em>x</em> is a sequence, a sequence of <code class="xref py py-class docutils literal"><span class="pre">datetime</span></code> objects will</p>
<p class="last">be returned.</p>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Notes</p>
<p>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.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.dates.num2timedelta">
<code class="descclassname">matplotlib.dates.</code><code class="descname">num2timedelta</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.num2timedelta" title="Permalink to this definition">¶</a></dt>
<dd><p>Converts number of days to a <code class="xref py py-class docutils literal"><span class="pre">timdelta</span></code> object.
If <em>x</em> is a sequence, a sequence of <code class="xref py py-class docutils literal"><span class="pre">timedelta</span></code> objects will
be returned.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>x</strong> : float, sequence of floats</p>
<blockquote>
<div><p>Number of days (fraction part represents hours, minutes, seconds)</p>
</div></blockquote>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last"><code class="xref py py-class docutils literal"><span class="pre">timedelta</span></code> or list[<code class="xref py py-class docutils literal"><span class="pre">timedelta</span></code>]</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="matplotlib.dates.drange">
<code class="descclassname">matplotlib.dates.</code><code class="descname">drange</code><span class="sig-paren">(</span><em>dstart</em>, <em>dend</em>, <em>delta</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.drange" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a date range as float Gregorian ordinals. <em>dstart</em> and
<em>dend</em> are <code class="xref py py-class docutils literal"><span class="pre">datetime</span></code> instances. <em>delta</em> is a
<a class="reference external" href="https://docs.python.org/2/library/datetime.html#datetime.timedelta" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">datetime.timedelta</span></code></a> instance.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.dates.epoch2num">
<code class="descclassname">matplotlib.dates.</code><code class="descname">epoch2num</code><span class="sig-paren">(</span><em>e</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.epoch2num" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert an epoch or sequence of epochs to the new date format,
that is days since 0001.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.dates.num2epoch">
<code class="descclassname">matplotlib.dates.</code><code class="descname">num2epoch</code><span class="sig-paren">(</span><em>d</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.num2epoch" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert days since 0001 to epoch. <em>d</em> can be a number or sequence.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.dates.mx2num">
<code class="descclassname">matplotlib.dates.</code><code class="descname">mx2num</code><span class="sig-paren">(</span><em>mxdates</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.mx2num" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert mx <code class="xref py py-class docutils literal"><span class="pre">datetime</span></code> instance (or sequence of mx
instances) to the new date format.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dates.DateFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">DateFormatter</code><span class="sig-paren">(</span><em>fmt</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DateFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>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"><span class="pre">strftime()</span></code></a>
format string.</p>
<p>Python only supports <a class="reference external" href="https://docs.python.org/2/library/datetime.html#module-datetime" title="(in Python v2.7)"><code class="xref py py-mod docutils literal"><span class="pre">datetime</span></code></a> <a class="reference internal" href="#matplotlib.dates.DateFormatter.strftime" title="matplotlib.dates.DateFormatter.strftime"><code class="xref py py-func docutils literal"><span class="pre">strftime()</span></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"><span class="pre">strftime()</span></code></a> code
below to include dates earlier than this year.</p>
<dl class="docutils">
<dt><em>fmt</em> is a <a class="reference internal" href="#matplotlib.dates.DateFormatter.strftime" title="matplotlib.dates.DateFormatter.strftime"><code class="xref py py-func docutils literal"><span class="pre">strftime()</span></code></a> format string; <em>tz</em> is the</dt>
<dd><code class="xref py py-class docutils literal"><span class="pre">tzinfo</span></code> instance.</dd>
</dl>
<dl class="attribute">
<dt id="matplotlib.dates.DateFormatter.illegal_s">
<code class="descname">illegal_s</code><em class="property"> = re.compile('((^|[^%])(%%)*%s)')</em><a class="headerlink" href="#matplotlib.dates.DateFormatter.illegal_s" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.dates.DateFormatter.set_tzinfo">
<code class="descname">set_tzinfo</code><span class="sig-paren">(</span><em>tz</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DateFormatter.set_tzinfo" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.dates.DateFormatter.strftime">
<code class="descname">strftime</code><span class="sig-paren">(</span><em>dt</em>, <em>fmt=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DateFormatter.strftime" title="Permalink to this definition">¶</a></dt>
<dd><p>Refer to documentation for datetime.strftime.</p>
<p><em>fmt</em> is a <a class="reference internal" href="#matplotlib.dates.DateFormatter.strftime" title="matplotlib.dates.DateFormatter.strftime"><code class="xref py py-func docutils literal"><span class="pre">strftime()</span></code></a> format string.</p>
<p>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.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.dates.DateFormatter.strftime_pre_1900">
<code class="descname">strftime_pre_1900</code><span class="sig-paren">(</span><em>dt</em>, <em>fmt=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DateFormatter.strftime_pre_1900" title="Permalink to this definition">¶</a></dt>
<dd><p>Call time.strftime for years before 1900 by rolling
forward a multiple of 28 years.</p>
<p><em>fmt</em> is a <a class="reference internal" href="#matplotlib.dates.DateFormatter.strftime" title="matplotlib.dates.DateFormatter.strftime"><code class="xref py py-func docutils literal"><span class="pre">strftime()</span></code></a> format string.</p>
<p>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.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dates.IndexDateFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">IndexDateFormatter</code><span class="sig-paren">(</span><em>t</em>, <em>fmt</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.IndexDateFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>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"><span class="pre">IndexLocator</span></code></a> to cycle format
strings by index.</p>
<p><em>t</em> is a sequence of dates (floating point days). <em>fmt</em> is a
<code class="xref py py-func docutils literal"><span class="pre">strftime()</span></code> format string.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dates.AutoDateFormatter">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">AutoDateFormatter</code><span class="sig-paren">(</span><em>locator</em>, <em>tz=None</em>, <em>defaultfmt='%Y-%m-%d'</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.AutoDateFormatter" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Formatter" title="matplotlib.ticker.Formatter"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Formatter</span></code></a></p>
<p>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"><span class="pre">AutoDateLocator</span></code></a>.</p>
<p>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:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="bp">self</span><span class="o">.</span><span class="n">scaled</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">DAYS_PER_YEAR</span><span class="p">:</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'date.autoformat.year'</span><span class="p">],</span>
<span class="n">DAYS_PER_MONTH</span><span class="p">:</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'date.autoformat.month'</span><span class="p">],</span>
<span class="mf">1.0</span><span class="p">:</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'date.autoformat.day'</span><span class="p">],</span>
<span class="mf">1.</span> <span class="o">/</span> <span class="n">HOURS_PER_DAY</span><span class="p">:</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'date.autoformat.hour'</span><span class="p">],</span>
<span class="mf">1.</span> <span class="o">/</span> <span class="p">(</span><span class="n">MINUTES_PER_DAY</span><span class="p">):</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'date.autoformat.minute'</span><span class="p">],</span>
<span class="mf">1.</span> <span class="o">/</span> <span class="p">(</span><span class="n">SEC_PER_DAY</span><span class="p">):</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'date.autoformat.second'</span><span class="p">],</span>
<span class="mf">1.</span> <span class="o">/</span> <span class="p">(</span><span class="n">MUSECONDS_PER_DAY</span><span class="p">):</span> <span class="n">rcParams</span><span class="p">[</span><span class="s1">'date.autoformat.microsecond'</span><span class="p">],</span>
<span class="p">}</span>
</pre></div>
</div>
<p>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:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">locator</span> <span class="o">=</span> <span class="n">AutoDateLocator</span><span class="p">()</span>
<span class="gp">>>> </span><span class="n">formatter</span> <span class="o">=</span> <span class="n">AutoDateFormatter</span><span class="p">(</span><span class="n">locator</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">formatter</span><span class="o">.</span><span class="n">scaled</span><span class="p">[</span><span class="mi">1</span><span class="o">/</span><span class="p">(</span><span class="mf">24.</span><span class="o">*</span><span class="mf">60.</span><span class="p">)]</span> <span class="o">=</span> <span class="s1">'%M:%S'</span> <span class="c1"># only show min and sec</span>
</pre></div>
</div>
<p>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"><span class="pre">FuncFormatter</span></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:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="k">def</span> <span class="nf">my_format_function</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">pos</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="gp">... </span> <span class="n">x</span> <span class="o">=</span> <span class="n">matplotlib</span><span class="o">.</span><span class="n">dates</span><span class="o">.</span><span class="n">num2date</span><span class="p">(</span><span class="n">x</span><span class="p">)</span>
<span class="gp">... </span> <span class="k">if</span> <span class="n">pos</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="gp">... </span> <span class="n">fmt</span> <span class="o">=</span> <span class="s1">'%D %H:%M:%S.</span><span class="si">%f</span><span class="s1">'</span>
<span class="gp">... </span> <span class="k">else</span><span class="p">:</span>
<span class="gp">... </span> <span class="n">fmt</span> <span class="o">=</span> <span class="s1">'%H:%M:%S.</span><span class="si">%f</span><span class="s1">'</span>
<span class="gp">... </span> <span class="n">label</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="n">fmt</span><span class="p">)</span>
<span class="gp">... </span> <span class="n">label</span> <span class="o">=</span> <span class="n">label</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">"0"</span><span class="p">)</span>
<span class="gp">... </span> <span class="n">label</span> <span class="o">=</span> <span class="n">label</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">"."</span><span class="p">)</span>
<span class="gp">... </span> <span class="k">return</span> <span class="n">label</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">matplotlib.ticker</span> <span class="k">import</span> <span class="n">FuncFormatter</span>
<span class="gp">>>> </span><span class="n">formatter</span><span class="o">.</span><span class="n">scaled</span><span class="p">[</span><span class="mi">1</span><span class="o">/</span><span class="p">(</span><span class="mf">24.</span><span class="o">*</span><span class="mf">60.</span><span class="p">)]</span> <span class="o">=</span> <span class="n">FuncFormatter</span><span class="p">(</span><span class="n">my_format_function</span><span class="p">)</span>
</pre></div>
</div>
<p>Autoformat the date labels. The default format is the one to use
if none of the values in <code class="docutils literal"><span class="pre">self.scaled</span></code> are greater than the unit
returned by <code class="docutils literal"><span class="pre">locator._get_unit()</span></code>.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dates.DateLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">DateLocator</code><span class="sig-paren">(</span><em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DateLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="ticker_api.html#matplotlib.ticker.Locator" title="matplotlib.ticker.Locator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.ticker.Locator</span></code></a></p>
<p>Determines the tick locations when plotting dates.</p>
<p><em>tz</em> is a <code class="xref py py-class docutils literal"><span class="pre">tzinfo</span></code> instance.</p>
<dl class="method">
<dt id="matplotlib.dates.DateLocator.datalim_to_dt">
<code class="descname">datalim_to_dt</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DateLocator.datalim_to_dt" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert axis data interval to datetime objects.</p>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.dates.DateLocator.hms0d">
<code class="descname">hms0d</code><em class="property"> = {'byhour': 0, 'byminute': 0, 'bysecond': 0}</em><a class="headerlink" href="#matplotlib.dates.DateLocator.hms0d" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.dates.DateLocator.nonsingular">
<code class="descname">nonsingular</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DateLocator.nonsingular" title="Permalink to this definition">¶</a></dt>
<dd><p>Given the proposed upper and lower extent, adjust the range
if it is too close to being singular (i.e. a range of ~0).</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.dates.DateLocator.set_tzinfo">
<code class="descname">set_tzinfo</code><span class="sig-paren">(</span><em>tz</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DateLocator.set_tzinfo" title="Permalink to this definition">¶</a></dt>
<dd><p>Set time zone info.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.dates.DateLocator.viewlim_to_dt">
<code class="descname">viewlim_to_dt</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DateLocator.viewlim_to_dt" title="Permalink to this definition">¶</a></dt>
<dd><p>Converts the view interval to datetime objects.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dates.RRuleLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">RRuleLocator</code><span class="sig-paren">(</span><em>o</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.RRuleLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.DateLocator" title="matplotlib.dates.DateLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.DateLocator</span></code></a></p>
<dl class="method">
<dt id="matplotlib.dates.RRuleLocator.autoscale">
<code class="descname">autoscale</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.RRuleLocator.autoscale" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the view limits to include the data range.</p>
</dd></dl>
<dl class="staticmethod">
<dt id="matplotlib.dates.RRuleLocator.get_unit_generic">
<em class="property">static </em><code class="descname">get_unit_generic</code><span class="sig-paren">(</span><em>freq</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.RRuleLocator.get_unit_generic" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.dates.RRuleLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.RRuleLocator.tick_values" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dates.AutoDateLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">AutoDateLocator</code><span class="sig-paren">(</span><em>tz=None</em>, <em>minticks=5</em>, <em>maxticks=None</em>, <em>interval_multiples=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.AutoDateLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.DateLocator" title="matplotlib.dates.DateLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.DateLocator</span></code></a></p>
<p>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"><span class="pre">DateLocator</span></code></a> to set the view limits and the tick
locations.</p>
<p><em>minticks</em> is the minimum number of ticks desired, which is used to
select the type of ticking (yearly, monthly, etc.).</p>
<p><em>maxticks</em> 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"><span class="pre">AutoDateFormatter</span></code></a>. Any frequency not specified in this
dictionary is given a default value.</p>
<p><em>tz</em> is a <code class="xref py py-class docutils literal"><span class="pre">tzinfo</span></code> instance.</p>
<p><em>interval_multiples</em> 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.</p>
<p>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:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="bp">self</span><span class="o">.</span><span class="n">intervald</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">YEARLY</span> <span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">20</span><span class="p">,</span> <span class="mi">40</span><span class="p">,</span> <span class="mi">50</span><span class="p">,</span> <span class="mi">100</span><span class="p">,</span> <span class="mi">200</span><span class="p">,</span> <span class="mi">400</span><span class="p">,</span> <span class="mi">500</span><span class="p">,</span>
<span class="mi">1000</span><span class="p">,</span> <span class="mi">2000</span><span class="p">,</span> <span class="mi">4000</span><span class="p">,</span> <span class="mi">5000</span><span class="p">,</span> <span class="mi">10000</span><span class="p">],</span>
<span class="n">MONTHLY</span> <span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">6</span><span class="p">],</span>
<span class="n">DAILY</span> <span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">7</span><span class="p">,</span> <span class="mi">14</span><span class="p">],</span>
<span class="n">HOURLY</span> <span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">6</span><span class="p">,</span> <span class="mi">12</span><span class="p">],</span>
<span class="n">MINUTELY</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">15</span><span class="p">,</span> <span class="mi">30</span><span class="p">],</span>
<span class="n">SECONDLY</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">15</span><span class="p">,</span> <span class="mi">30</span><span class="p">],</span>
<span class="n">MICROSECONDLY</span><span class="p">:</span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">10</span><span class="p">,</span> <span class="mi">20</span><span class="p">,</span> <span class="mi">50</span><span class="p">,</span> <span class="mi">100</span><span class="p">,</span> <span class="mi">200</span><span class="p">,</span> <span class="mi">500</span><span class="p">,</span> <span class="mi">1000</span><span class="p">,</span> <span class="mi">2000</span><span class="p">,</span>
<span class="mi">5000</span><span class="p">,</span> <span class="mi">10000</span><span class="p">,</span> <span class="mi">20000</span><span class="p">,</span> <span class="mi">50000</span><span class="p">,</span> <span class="mi">100000</span><span class="p">,</span> <span class="mi">200000</span><span class="p">,</span> <span class="mi">500000</span><span class="p">,</span>
<span class="mi">1000000</span><span class="p">],</span>
<span class="p">}</span>
</pre></div>
</div>
<p>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:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">locator</span> <span class="o">=</span> <span class="n">AutoDateLocator</span><span class="p">()</span>
<span class="n">locator</span><span class="o">.</span><span class="n">intervald</span><span class="p">[</span><span class="n">HOURLY</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="c1"># only show every 3 hours</span>
</pre></div>
</div>
<dl class="method">
<dt id="matplotlib.dates.AutoDateLocator.autoscale">
<code class="descname">autoscale</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.AutoDateLocator.autoscale" title="Permalink to this definition">¶</a></dt>
<dd><p>Try to choose the view limits intelligently.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.dates.AutoDateLocator.get_locator">
<code class="descname">get_locator</code><span class="sig-paren">(</span><em>dmin</em>, <em>dmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.AutoDateLocator.get_locator" title="Permalink to this definition">¶</a></dt>
<dd><p>Pick the best locator based on a distance.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.dates.AutoDateLocator.nonsingular">
<code class="descname">nonsingular</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.AutoDateLocator.nonsingular" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.dates.AutoDateLocator.refresh">
<code class="descname">refresh</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.AutoDateLocator.refresh" title="Permalink to this definition">¶</a></dt>
<dd><p>Refresh internal information based on current limits.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.dates.AutoDateLocator.set_axis">
<code class="descname">set_axis</code><span class="sig-paren">(</span><em>axis</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.AutoDateLocator.set_axis" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.dates.AutoDateLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.AutoDateLocator.tick_values" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dates.YearLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">YearLocator</code><span class="sig-paren">(</span><em>base=1</em>, <em>month=1</em>, <em>day=1</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.YearLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.DateLocator" title="matplotlib.dates.DateLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.DateLocator</span></code></a></p>
<p>Make ticks on a given day of each year that is a multiple of base.</p>
<p>Examples:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># Tick every year on Jan 1st</span>
<span class="n">locator</span> <span class="o">=</span> <span class="n">YearLocator</span><span class="p">()</span>
<span class="c1"># Tick every 5 years on July 4th</span>
<span class="n">locator</span> <span class="o">=</span> <span class="n">YearLocator</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="n">month</span><span class="o">=</span><span class="mi">7</span><span class="p">,</span> <span class="n">day</span><span class="o">=</span><span class="mi">4</span><span class="p">)</span>
</pre></div>
</div>
<p>Mark years that are multiple of base on a given month and day
(default jan 1).</p>
<dl class="method">
<dt id="matplotlib.dates.YearLocator.autoscale">
<code class="descname">autoscale</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.YearLocator.autoscale" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the view limits to include the data range.</p>
</dd></dl>
<dl class="method">
<dt id="matplotlib.dates.YearLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.YearLocator.tick_values" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dates.MonthLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">MonthLocator</code><span class="sig-paren">(</span><em>bymonth=None</em>, <em>bymonthday=1</em>, <em>interval=1</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.MonthLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurances of each month month, e.g., 1, 3, 12.</p>
<p>Mark every month in <em>bymonth</em>; <em>bymonth</em> can be an int or
sequence. Default is <code class="docutils literal"><span class="pre">range(1,13)</span></code>, i.e. every month.</p>
<p><em>interval</em> is the interval between each iteration. For
example, if <code class="docutils literal"><span class="pre">interval=2</span></code>, mark every second occurance.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dates.WeekdayLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">WeekdayLocator</code><span class="sig-paren">(</span><em>byweekday=1</em>, <em>interval=1</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.WeekdayLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurances of each weekday.</p>
<p>Mark every weekday in <em>byweekday</em>; <em>byweekday</em> can be a number or
sequence.</p>
<p>Elements of <em>byweekday</em> must be one of MO, TU, WE, TH, FR, SA,
SU, the constants from <code class="xref py py-mod docutils literal"><span class="pre">dateutil.rrule</span></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"><span class="pre">matplotlib.dates</span></code></a> namespace.</p>
<p><em>interval</em> specifies the number of weeks to skip. For example,
<code class="docutils literal"><span class="pre">interval=2</span></code> plots every second week.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dates.DayLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">DayLocator</code><span class="sig-paren">(</span><em>bymonthday=None</em>, <em>interval=1</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.DayLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurances of each day of the month. For example,
1, 15, 30.</p>
<p>Mark every day in <em>bymonthday</em>; <em>bymonthday</em> can be an int or
sequence.</p>
<p>Default is to tick every day of the month: <code class="docutils literal"><span class="pre">bymonthday=range(1,32)</span></code></p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dates.HourLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">HourLocator</code><span class="sig-paren">(</span><em>byhour=None</em>, <em>interval=1</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.HourLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurances of each hour.</p>
<p>Mark every hour in <em>byhour</em>; <em>byhour</em> can be an int or sequence.
Default is to tick every hour: <code class="docutils literal"><span class="pre">byhour=range(24)</span></code></p>
<p><em>interval</em> is the interval between each iteration. For
example, if <code class="docutils literal"><span class="pre">interval=2</span></code>, mark every second occurrence.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dates.MinuteLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">MinuteLocator</code><span class="sig-paren">(</span><em>byminute=None</em>, <em>interval=1</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.MinuteLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurances of each minute.</p>
<p>Mark every minute in <em>byminute</em>; <em>byminute</em> can be an int or
sequence. Default is to tick every minute: <code class="docutils literal"><span class="pre">byminute=range(60)</span></code></p>
<p><em>interval</em> is the interval between each iteration. For
example, if <code class="docutils literal"><span class="pre">interval=2</span></code>, mark every second occurrence.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dates.SecondLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">SecondLocator</code><span class="sig-paren">(</span><em>bysecond=None</em>, <em>interval=1</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.SecondLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.RRuleLocator" title="matplotlib.dates.RRuleLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.RRuleLocator</span></code></a></p>
<p>Make ticks on occurances of each second.</p>
<p>Mark every second in <em>bysecond</em>; <em>bysecond</em> can be an int or
sequence. Default is to tick every second: <code class="docutils literal"><span class="pre">bysecond</span> <span class="pre">=</span> <span class="pre">range(60)</span></code></p>
<p><em>interval</em> is the interval between each iteration. For
example, if <code class="docutils literal"><span class="pre">interval=2</span></code>, mark every second occurrence.</p>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dates.MicrosecondLocator">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">MicrosecondLocator</code><span class="sig-paren">(</span><em>interval=1</em>, <em>tz=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.MicrosecondLocator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#matplotlib.dates.DateLocator" title="matplotlib.dates.DateLocator"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.dates.DateLocator</span></code></a></p>
<p>Make ticks on occurances of each microsecond.</p>
<p><em>interval</em> is the interval between each iteration. For
example, if <code class="docutils literal"><span class="pre">interval=2</span></code>, mark every second microsecond.</p>
<dl class="method">
<dt id="matplotlib.dates.MicrosecondLocator.set_axis">
<code class="descname">set_axis</code><span class="sig-paren">(</span><em>axis</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.MicrosecondLocator.set_axis" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.dates.MicrosecondLocator.set_data_interval">
<code class="descname">set_data_interval</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.MicrosecondLocator.set_data_interval" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.dates.MicrosecondLocator.set_view_interval">
<code class="descname">set_view_interval</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.MicrosecondLocator.set_view_interval" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.dates.MicrosecondLocator.tick_values">
<code class="descname">tick_values</code><span class="sig-paren">(</span><em>vmin</em>, <em>vmax</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.MicrosecondLocator.tick_values" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dates.rrule">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">rrule</code><span class="sig-paren">(</span><em>freq</em>, <em>dtstart=None</em>, <em>interval=1</em>, <em>wkst=None</em>, <em>count=None</em>, <em>until=None</em>, <em>bysetpos=None</em>, <em>bymonth=None</em>, <em>bymonthday=None</em>, <em>byyearday=None</em>, <em>byeaster=None</em>, <em>byweekno=None</em>, <em>byweekday=None</em>, <em>byhour=None</em>, <em>byminute=None</em>, <em>bysecond=None</em>, <em>cache=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.rrule" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">dateutil.rrule.rrulebase</span></code></p>
<p>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:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">rrule</span><span class="p">(</span><span class="n">freq</span><span class="p">)</span>
</pre></div>
</div>
<p>Where freq must be one of YEARLY, MONTHLY, WEEKLY, DAILY, HOURLY, MINUTELY,
or SECONDLY.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>Per RFC section 3.3.10, recurrence instances falling on invalid dates
and times are ignored rather than coerced:</p>
<blockquote>
<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>
<p>This can lead to possibly surprising behavior when, for example, the
start date occurs at the end of the month:</p>
<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">dateutil.rrule</span> <span class="k">import</span> <span class="n">rrule</span><span class="p">,</span> <span class="n">MONTHLY</span>
<span class="gp">>>> </span><span class="kn">from</span> <span class="nn">datetime</span> <span class="k">import</span> <span class="n">datetime</span>
<span class="gp">>>> </span><span class="n">start_date</span> <span class="o">=</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2014</span><span class="p">,</span> <span class="mi">12</span><span class="p">,</span> <span class="mi">31</span><span class="p">)</span>
<span class="gp">>>> </span><span class="nb">list</span><span class="p">(</span><span class="n">rrule</span><span class="p">(</span><span class="n">freq</span><span class="o">=</span><span class="n">MONTHLY</span><span class="p">,</span> <span class="n">count</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">dtstart</span><span class="o">=</span><span class="n">start_date</span><span class="p">))</span>
<span class="gp">... </span>
<span class="go">[datetime.datetime(2014, 12, 31, 0, 0),</span>
<span class="go"> datetime.datetime(2015, 1, 31, 0, 0),</span>
<span class="go"> datetime.datetime(2015, 3, 31, 0, 0),</span>
<span class="go"> datetime.datetime(2015, 5, 31, 0, 0)]</span>
</pre></div>
</div>
</div>
<p>Additionally, it supports the following keyword arguments:</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>cache</strong> – 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><strong>dtstart</strong> – 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><strong>interval</strong> – 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><strong>wkst</strong> – 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><strong>count</strong> – <p>How many occurrences will be generated.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">As of version 2.5.0, the use of the <code class="docutils literal"><span class="pre">until</span></code> keyword together
with the <code class="docutils literal"><span class="pre">count</span></code> keyword is deprecated per RFC-2445 Sec. 4.3.10.</p>
</div>
</li>
<li><strong>until</strong> – <p>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"><span class="pre">until</span></code> parameter.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">As of version 2.5.0, the use of the <code class="docutils literal"><span class="pre">until</span></code> keyword together
with the <code class="docutils literal"><span class="pre">count</span></code> keyword is deprecated per RFC-2445 Sec. 4.3.10.</p>
</div>
</li>
<li><strong>bysetpos</strong> – 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><strong>bymonth</strong> – If given, it must be either an integer, or a sequence of integers,
meaning the months to apply the recurrence to.</li>
<li><strong>bymonthday</strong> – If given, it must be either an integer, or a sequence of integers,
meaning the month days to apply the recurrence to.</li>
<li><strong>byyearday</strong> – If given, it must be either an integer, or a sequence of integers,
meaning the year days to apply the recurrence to.</li>
<li><strong>byweekno</strong> – 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><strong>byweekday</strong> – 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><strong>byhour</strong> – If given, it must be either an integer, or a sequence of integers,
meaning the hours to apply the recurrence to.</li>
<li><strong>byminute</strong> – If given, it must be either an integer, or a sequence of integers,
meaning the minutes to apply the recurrence to.</li>
<li><strong>bysecond</strong> – If given, it must be either an integer, or a sequence of integers,
meaning the seconds to apply the recurrence to.</li>
<li><strong>byeaster</strong> – 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>
<dl class="method">
<dt id="matplotlib.dates.rrule.replace">
<code class="descname">replace</code><span class="sig-paren">(</span><em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.rrule.replace" title="Permalink to this definition">¶</a></dt>
<dd><p>Return new rrule with same attributes except for those attributes given new
values by whichever keyword arguments are specified.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="matplotlib.dates.relativedelta">
<em class="property">class </em><code class="descclassname">matplotlib.dates.</code><code class="descname">relativedelta</code><span class="sig-paren">(</span><em>dt1=None</em>, <em>dt2=None</em>, <em>years=0</em>, <em>months=0</em>, <em>days=0</em>, <em>leapdays=0</em>, <em>weeks=0</em>, <em>hours=0</em>, <em>minutes=0</em>, <em>seconds=0</em>, <em>microseconds=0</em>, <em>year=None</em>, <em>month=None</em>, <em>day=None</em>, <em>weekday=None</em>, <em>yearday=None</em>, <em>nlyearday=None</em>, <em>hour=None</em>, <em>minute=None</em>, <em>second=None</em>, <em>microsecond=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.relativedelta" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/2/library/functions.html#object" title="(in Python v2.7)"><code class="xref py py-class docutils literal"><span class="pre">object</span></code></a></p>
<p>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 <em>NOT</em> implement the same algorithm as
his work. Do <em>NOT</em> expect it to behave like mx.DateTime’s counterpart.</p>
<p>There are two different ways to build a relativedelta instance. The
first one is passing it two date/datetime classes:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">relativedelta</span><span class="p">(</span><span class="n">datetime1</span><span class="p">,</span> <span class="n">datetime2</span><span class="p">)</span>
</pre></div>
</div>
<p>The second one is passing it any number of the following keyword arguments:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">relativedelta</span><span class="p">(</span><span class="n">arg1</span><span class="o">=</span><span class="n">x</span><span class="p">,</span><span class="n">arg2</span><span class="o">=</span><span class="n">y</span><span class="p">,</span><span class="n">arg3</span><span class="o">=</span><span class="n">z</span><span class="o">...</span><span class="p">)</span>
<span class="n">year</span><span class="p">,</span> <span class="n">month</span><span class="p">,</span> <span class="n">day</span><span class="p">,</span> <span class="n">hour</span><span class="p">,</span> <span class="n">minute</span><span class="p">,</span> <span class="n">second</span><span class="p">,</span> <span class="n">microsecond</span><span class="p">:</span>
<span class="n">Absolute</span> <span class="n">information</span> <span class="p">(</span><span class="n">argument</span> <span class="ow">is</span> <span class="n">singular</span><span class="p">);</span> <span class="n">adding</span> <span class="ow">or</span> <span class="n">subtracting</span> <span class="n">a</span>
<span class="n">relativedelta</span> <span class="k">with</span> <span class="n">absolute</span> <span class="n">information</span> <span class="n">does</span> <span class="ow">not</span> <span class="n">perform</span> <span class="n">an</span> <span class="n">aritmetic</span>
<span class="n">operation</span><span class="p">,</span> <span class="n">but</span> <span class="n">rather</span> <span class="n">REPLACES</span> <span class="n">the</span> <span class="n">corresponding</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">the</span>
<span class="n">original</span> <span class="n">datetime</span> <span class="k">with</span> <span class="n">the</span> <span class="n">value</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="ow">in</span> <span class="n">relativedelta</span><span class="o">.</span>
<span class="n">years</span><span class="p">,</span> <span class="n">months</span><span class="p">,</span> <span class="n">weeks</span><span class="p">,</span> <span class="n">days</span><span class="p">,</span> <span class="n">hours</span><span class="p">,</span> <span class="n">minutes</span><span class="p">,</span> <span class="n">seconds</span><span class="p">,</span> <span class="n">microseconds</span><span class="p">:</span>
<span class="n">Relative</span> <span class="n">information</span><span class="p">,</span> <span class="n">may</span> <span class="n">be</span> <span class="n">negative</span> <span class="p">(</span><span class="n">argument</span> <span class="ow">is</span> <span class="n">plural</span><span class="p">);</span> <span class="n">adding</span>
<span class="ow">or</span> <span class="n">subtracting</span> <span class="n">a</span> <span class="n">relativedelta</span> <span class="k">with</span> <span class="n">relative</span> <span class="n">information</span> <span class="n">performs</span>
<span class="n">the</span> <span class="n">corresponding</span> <span class="n">aritmetic</span> <span class="n">operation</span> <span class="n">on</span> <span class="n">the</span> <span class="n">original</span> <span class="n">datetime</span> <span class="n">value</span>
<span class="k">with</span> <span class="n">the</span> <span class="n">information</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">relativedelta</span><span class="o">.</span>
<span class="n">weekday</span><span class="p">:</span>
<span class="n">One</span> <span class="n">of</span> <span class="n">the</span> <span class="n">weekday</span> <span class="n">instances</span> <span class="p">(</span><span class="n">MO</span><span class="p">,</span> <span class="n">TU</span><span class="p">,</span> <span class="n">etc</span><span class="p">)</span><span class="o">.</span> <span class="n">These</span> <span class="n">instances</span> <span class="n">may</span>
<span class="n">receive</span> <span class="n">a</span> <span class="n">parameter</span> <span class="n">N</span><span class="p">,</span> <span class="n">specifying</span> <span class="n">the</span> <span class="n">Nth</span> <span class="n">weekday</span><span class="p">,</span> <span class="n">which</span> <span class="n">could</span>
<span class="n">be</span> <span class="n">positive</span> <span class="ow">or</span> <span class="n">negative</span> <span class="p">(</span><span class="n">like</span> <span class="n">MO</span><span class="p">(</span><span class="o">+</span><span class="mi">1</span><span class="p">)</span> <span class="ow">or</span> <span class="n">MO</span><span class="p">(</span><span class="o">-</span><span class="mi">2</span><span class="p">)</span><span class="o">.</span> <span class="n">Not</span> <span class="n">specifying</span>
<span class="n">it</span> <span class="ow">is</span> <span class="n">the</span> <span class="n">same</span> <span class="k">as</span> <span class="n">specifying</span> <span class="o">+</span><span class="mf">1.</span> <span class="n">You</span> <span class="n">can</span> <span class="n">also</span> <span class="n">use</span> <span class="n">an</span> <span class="n">integer</span><span class="p">,</span>
<span class="n">where</span> <span class="mi">0</span><span class="o">=</span><span class="n">MO</span><span class="o">.</span>
<span class="n">leapdays</span><span class="p">:</span>
<span class="n">Will</span> <span class="n">add</span> <span class="n">given</span> <span class="n">days</span> <span class="n">to</span> <span class="n">the</span> <span class="n">date</span> <span class="n">found</span><span class="p">,</span> <span class="k">if</span> <span class="n">year</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">leap</span>
<span class="n">year</span><span class="p">,</span> <span class="ow">and</span> <span class="n">the</span> <span class="n">date</span> <span class="n">found</span> <span class="ow">is</span> <span class="n">post</span> <span class="mi">28</span> <span class="n">of</span> <span class="n">february</span><span class="o">.</span>
<span class="n">yearday</span><span class="p">,</span> <span class="n">nlyearday</span><span class="p">:</span>
<span class="n">Set</span> <span class="n">the</span> <span class="n">yearday</span> <span class="ow">or</span> <span class="n">the</span> <span class="n">non</span><span class="o">-</span><span class="n">leap</span> <span class="n">year</span> <span class="n">day</span> <span class="p">(</span><span class="n">jump</span> <span class="n">leap</span> <span class="n">days</span><span class="p">)</span><span class="o">.</span>
<span class="n">These</span> <span class="n">are</span> <span class="n">converted</span> <span class="n">to</span> <span class="n">day</span><span class="o">/</span><span class="n">month</span><span class="o">/</span><span class="n">leapdays</span> <span class="n">information</span><span class="o">.</span>
</pre></div>
</div>
<p>Here is the behavior of operations with relativedelta:</p>
<ol class="arabic simple">
<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>
<dl class="method">
<dt id="matplotlib.dates.relativedelta.normalized">
<code class="descname">normalized</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.relativedelta.normalized" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a version of this object represented entirely using integer
values for the relative attributes.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">relativedelta</span><span class="p">(</span><span class="n">days</span><span class="o">=</span><span class="mf">1.5</span><span class="p">,</span> <span class="n">hours</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span><span class="o">.</span><span class="n">normalized</span><span class="p">()</span>
<span class="go">relativedelta(days=1, hours=14)</span>
</pre></div>
</div>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<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"><span class="pre">dateutil.relativedelta.relativedelta</span></code> object.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="matplotlib.dates.relativedelta.weeks">
<code class="descname">weeks</code><a class="headerlink" href="#matplotlib.dates.relativedelta.weeks" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="function">
<dt id="matplotlib.dates.seconds">
<code class="descclassname">matplotlib.dates.</code><code class="descname">seconds</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.seconds" title="Permalink to this definition">¶</a></dt>
<dd><p>Return seconds as days.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.dates.minutes">
<code class="descclassname">matplotlib.dates.</code><code class="descname">minutes</code><span class="sig-paren">(</span><em>m</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.minutes" title="Permalink to this definition">¶</a></dt>
<dd><p>Return minutes as days.</p>
</dd></dl>
<dl class="function">
<dt id="matplotlib.dates.hours">
<code class="descclassname">matplotlib.dates.</code><code class="descname">hours</code><span class="sig-paren">(</span><em>h</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.dates.hours" title="Permalink to this definition">¶</a></dt>
<dd><p>Return hours as days.</p>
</dd></dl>
<dl class="function">
You can’t perform that action at this time.