-
Notifications
You must be signed in to change notification settings - Fork 52
/
sample.html
1349 lines (1288 loc) · 132 KB
/
sample.html
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>7.2. re — Regular expression operations — Python v2.7.1 documentation</title>
<link rel="stylesheet" href="re_files/default.css" type="text/css">
<link rel="stylesheet" href="re_files/pygments.css" type="text/css">
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.7.1',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="re_files/jquery.js"></script>
<script type="text/javascript" src="re_files/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml" title="Search within Python v2.7.1 documentation" href="http://docs.python.org/_static/opensearch.xml">
<link rel="author" title="About these documents" href="http://docs.python.org/about.html">
<link rel="copyright" title="Copyright" href="http://docs.python.org/copyright.html">
<link rel="top" title="Python v2.7.1 documentation" href="http://docs.python.org/index.html">
<link rel="up" title="7. String Services" href="http://docs.python.org/library/strings.html">
<link rel="next" title="7.3. struct — Interpret strings as packed binary data" href="http://docs.python.org/library/struct.html">
<link rel="prev" title="7.1. string — Common string operations" href="http://docs.python.org/library/string.html">
<link rel="shortcut icon" type="image/png" href="re_files/py.png">
</head><body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px;">
<a href="http://docs.python.org/genindex.html" title="General Index" accesskey="I">index</a></li>
<li class="right">
<a href="http://docs.python.org/modindex.html" title="Global Module Index" accesskey="M">modules</a> |</li>
<li class="right">
<a href="http://docs.python.org/library/struct.html" title="7.3. struct — Interpret strings as packed binary data" accesskey="N">next</a> |</li>
<li class="right">
<a href="http://docs.python.org/library/string.html" title="7.1. string — Common string operations" accesskey="P">previous</a> |</li>
<li><img src="re_files/py.png" alt="" style="vertical-align: middle; margin-top: -1px;"></li>
<li><a href="http://docs.python.org/index.html">Python v2.7.1 documentation</a> »</li>
<li><a href="http://docs.python.org/library/index.html">The Python Standard Library</a> »</li>
<li><a href="http://docs.python.org/library/strings.html" accesskey="U">7. String Services</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-re">
<h1>7.2. <tt class="xref docutils literal"><span class="pre">re</span></tt> — Regular expression operations<a class="headerlink" href="#module-re" title="Permalink to this headline">¶</a></h1>
<p>This module provides regular expression matching operations similar to
those found in Perl. Both patterns and strings to be searched can be
Unicode strings as well as 8-bit strings.</p>
<p>Regular expressions use the backslash character (<tt class="docutils literal"><span class="pre">'\'</span></tt>) to indicate
special forms or to allow special characters to be used without invoking
their special meaning. This collides with Python’s usage of the same
character for the same purpose in string literals; for example, to match
a literal backslash, one might have to write <tt class="docutils literal"><span class="pre">'\\\\'</span></tt> as the pattern
string, because the regular expression must be <tt class="docutils literal"><span class="pre">\\</span></tt>, and each
backslash must be expressed as <tt class="docutils literal"><span class="pre">\\</span></tt> inside a regular Python string
literal.</p>
<p>The solution is to use Python’s raw string notation for regular expression
patterns; backslashes are not handled in any special way in a string literal
prefixed with <tt class="docutils literal"><span class="pre">'r'</span></tt>. So <tt class="docutils literal"><span class="pre">r"\n"</span></tt> is a two-character string containing
<tt class="docutils literal"><span class="pre">'\'</span></tt> and <tt class="docutils literal"><span class="pre">'n'</span></tt>, while <tt class="docutils literal"><span class="pre">"\n"</span></tt> is a one-character string containing a
newline. Usually patterns will be expressed in Python code using this raw
string notation.</p>
<p>It is important to note that most regular expression operations are available as
module-level functions and <a title="re.RegexObject" class="reference internal" href="#re.RegexObject"><tt class="xref docutils literal"><span class="pre">RegexObject</span></tt></a> methods. The functions are
shortcuts that don’t require you to compile a regex object first, but miss some
fine-tuning parameters.</p>
<div class="admonition-see-also admonition seealso">
<p class="first admonition-title">See also</p>
<dl class="last docutils">
<dt>Mastering Regular Expressions</dt>
<dd>Book on regular expressions by Jeffrey Friedl, published by O’Reilly. The
second edition of the book no longer covers Python at all, but the first
edition covered writing good regular expression patterns in great detail.</dd>
</dl>
</div>
<div class="section" id="regular-expression-syntax">
<span id="re-syntax"></span><h2>7.2.1. Regular Expression Syntax<a class="headerlink" href="#regular-expression-syntax" title="Permalink to this headline">¶</a></h2>
<p>A regular expression (or RE) specifies a set of strings that matches it; the
functions in this module let you check if a particular string matches a given
regular expression (or if a given regular expression matches a particular
string, which comes down to the same thing).</p>
<p>Regular expressions can be concatenated to form new regular expressions; if <em>A</em>
and <em>B</em> are both regular expressions, then <em>AB</em> is also a regular expression.
In general, if a string <em>p</em> matches <em>A</em> and another string <em>q</em> matches <em>B</em>, the
string <em>pq</em> will match AB. This holds unless <em>A</em> or <em>B</em> contain low precedence
operations; boundary conditions between <em>A</em> and <em>B</em>; or have numbered group
references. Thus, complex expressions can easily be constructed from simpler
primitive expressions like the ones described here. For details of the theory
and implementation of regular expressions, consult the Friedl book referenced
above, or almost any textbook about compiler construction.</p>
<p>A brief explanation of the format of regular expressions follows. For further
information and a gentler presentation, consult the <a class="reference external" href="http://docs.python.org/howto/regex.html#regex-howto"><em>Regular Expression HOWTO</em></a>.</p>
<p>Regular expressions can contain both special and ordinary characters. Most
ordinary characters, like <tt class="docutils literal"><span class="pre">'A'</span></tt>, <tt class="docutils literal"><span class="pre">'a'</span></tt>, or <tt class="docutils literal"><span class="pre">'0'</span></tt>, are the simplest regular
expressions; they simply match themselves. You can concatenate ordinary
characters, so <tt class="docutils literal"><span class="pre">last</span></tt> matches the string <tt class="docutils literal"><span class="pre">'last'</span></tt>. (In the rest of this
section, we’ll write RE’s in <tt class="docutils literal"><span class="pre">this</span> <span class="pre">special</span> <span class="pre">style</span></tt>, usually without quotes, and
strings to be matched <tt class="docutils literal"><span class="pre">'in</span> <span class="pre">single</span> <span class="pre">quotes'</span></tt>.)</p>
<p>Some characters, like <tt class="docutils literal"><span class="pre">'|'</span></tt> or <tt class="docutils literal"><span class="pre">'('</span></tt>, are special. Special
characters either stand for classes of ordinary characters, or affect
how the regular expressions around them are interpreted. Regular
expression pattern strings may not contain null bytes, but can specify
the null byte using the <tt class="docutils literal"><span class="pre">\number</span></tt> notation, e.g., <tt class="docutils literal"><span class="pre">'\x00'</span></tt>.</p>
<p>The special characters are:</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">'.'</span></tt></dt>
<dd>(Dot.) In the default mode, this matches any character except a newline. If
the <a title="re.DOTALL" class="reference internal" href="#re.DOTALL"><tt class="xref docutils literal"><span class="pre">DOTALL</span></tt></a> flag has been specified, this matches any character
including a newline.</dd>
<dt><tt class="docutils literal"><span class="pre">'^'</span></tt></dt>
<dd>(Caret.) Matches the start of the string, and in <a title="re.MULTILINE" class="reference internal" href="#re.MULTILINE"><tt class="xref docutils literal"><span class="pre">MULTILINE</span></tt></a> mode also
matches immediately after each newline.</dd>
<dt><tt class="docutils literal"><span class="pre">'$'</span></tt></dt>
<dd>Matches the end of the string or just before the newline at the end of the
string, and in <a title="re.MULTILINE" class="reference internal" href="#re.MULTILINE"><tt class="xref docutils literal"><span class="pre">MULTILINE</span></tt></a> mode also matches before a newline. <tt class="docutils literal"><span class="pre">foo</span></tt>
matches both ‘foo’ and ‘foobar’, while the regular expression <tt class="docutils literal"><span class="pre">foo$</span></tt> matches
only ‘foo’. More interestingly, searching for <tt class="docutils literal"><span class="pre">foo.$</span></tt> in <tt class="docutils literal"><span class="pre">'foo1\nfoo2\n'</span></tt>
matches ‘foo2’ normally, but ‘foo1’ in <a title="re.MULTILINE" class="reference internal" href="#re.MULTILINE"><tt class="xref docutils literal"><span class="pre">MULTILINE</span></tt></a> mode; searching for
a single <tt class="docutils literal"><span class="pre">$</span></tt> in <tt class="docutils literal"><span class="pre">'foo\n'</span></tt> will find two (empty) matches: one just before
the newline, and one at the end of the string.</dd>
<dt><tt class="docutils literal"><span class="pre">'*'</span></tt></dt>
<dd>Causes the resulting RE to match 0 or more repetitions of the preceding RE, as
many repetitions as are possible. <tt class="docutils literal"><span class="pre">ab*</span></tt> will match ‘a’, ‘ab’, or ‘a’ followed
by any number of ‘b’s.</dd>
<dt><tt class="docutils literal"><span class="pre">'+'</span></tt></dt>
<dd>Causes the resulting RE to match 1 or more repetitions of the preceding RE.
<tt class="docutils literal"><span class="pre">ab+</span></tt> will match ‘a’ followed by any non-zero number of ‘b’s; it will not
match just ‘a’.</dd>
<dt><tt class="docutils literal"><span class="pre">'?'</span></tt></dt>
<dd>Causes the resulting RE to match 0 or 1 repetitions of the preceding RE.
<tt class="docutils literal"><span class="pre">ab?</span></tt> will match either ‘a’ or ‘ab’.</dd>
<dt><tt class="docutils literal"><span class="pre">*?</span></tt>, <tt class="docutils literal"><span class="pre">+?</span></tt>, <tt class="docutils literal"><span class="pre">??</span></tt></dt>
<dd>The <tt class="docutils literal"><span class="pre">'*'</span></tt>, <tt class="docutils literal"><span class="pre">'+'</span></tt>, and <tt class="docutils literal"><span class="pre">'?'</span></tt> qualifiers are all <em>greedy</em>; they match
as much text as possible. Sometimes this behaviour isn’t desired; if the RE
<tt class="docutils literal"><span class="pre"><.*></span></tt> is matched against <tt class="docutils literal"><span class="pre">'<H1>title</H1>'</span></tt>, it will match the entire
string, and not just <tt class="docutils literal"><span class="pre">'<H1>'</span></tt>. Adding <tt class="docutils literal"><span class="pre">'?'</span></tt> after the qualifier makes it
perform the match in <em>non-greedy</em> or <em>minimal</em> fashion; as <em>few</em>
characters as possible will be matched. Using <tt class="docutils literal"><span class="pre">.*?</span></tt> in the previous
expression will match only <tt class="docutils literal"><span class="pre">'<H1>'</span></tt>.</dd>
<dt><tt class="docutils literal"><span class="pre">{m}</span></tt></dt>
<dd>Specifies that exactly <em>m</em> copies of the previous RE should be matched; fewer
matches cause the entire RE not to match. For example, <tt class="docutils literal"><span class="pre">a{6}</span></tt> will match
exactly six <tt class="docutils literal"><span class="pre">'a'</span></tt> characters, but not five.</dd>
<dt><tt class="docutils literal"><span class="pre">{m,n}</span></tt></dt>
<dd>Causes the resulting RE to match from <em>m</em> to <em>n</em> repetitions of the preceding
RE, attempting to match as many repetitions as possible. For example,
<tt class="docutils literal"><span class="pre">a{3,5}</span></tt> will match from 3 to 5 <tt class="docutils literal"><span class="pre">'a'</span></tt> characters. Omitting <em>m</em> specifies a
lower bound of zero, and omitting <em>n</em> specifies an infinite upper bound. As an
example, <tt class="docutils literal"><span class="pre">a{4,}b</span></tt> will match <tt class="docutils literal"><span class="pre">aaaab</span></tt> or a thousand <tt class="docutils literal"><span class="pre">'a'</span></tt> characters
followed by a <tt class="docutils literal"><span class="pre">b</span></tt>, but not <tt class="docutils literal"><span class="pre">aaab</span></tt>. The comma may not be omitted or the
modifier would be confused with the previously described form.</dd>
<dt><tt class="docutils literal"><span class="pre">{m,n}?</span></tt></dt>
<dd>Causes the resulting RE to match from <em>m</em> to <em>n</em> repetitions of the preceding
RE, attempting to match as <em>few</em> repetitions as possible. This is the
non-greedy version of the previous qualifier. For example, on the
6-character string <tt class="docutils literal"><span class="pre">'aaaaaa'</span></tt>, <tt class="docutils literal"><span class="pre">a{3,5}</span></tt> will match 5 <tt class="docutils literal"><span class="pre">'a'</span></tt> characters,
while <tt class="docutils literal"><span class="pre">a{3,5}?</span></tt> will only match 3 characters.</dd>
<dt><tt class="docutils literal"><span class="pre">'\'</span></tt></dt>
<dd><p class="first">Either escapes special characters (permitting you to match characters like
<tt class="docutils literal"><span class="pre">'*'</span></tt>, <tt class="docutils literal"><span class="pre">'?'</span></tt>, and so forth), or signals a special sequence; special
sequences are discussed below.</p>
<p class="last">If you’re not using a raw string to express the pattern, remember that Python
also uses the backslash as an escape sequence in string literals; if the escape
sequence isn’t recognized by Python’s parser, the backslash and subsequent
character are included in the resulting string. However, if Python would
recognize the resulting sequence, the backslash should be repeated twice. This
is complicated and hard to understand, so it’s highly recommended that you use
raw strings for all but the simplest expressions.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">[]</span></tt></dt>
<dd><p class="first">Used to indicate a set of characters. Characters can be listed individually, or
a range of characters can be indicated by giving two characters and separating
them by a <tt class="docutils literal"><span class="pre">'-'</span></tt>. Special characters are not active inside sets. For example,
<tt class="docutils literal"><span class="pre">[akm$]</span></tt> will match any of the characters <tt class="docutils literal"><span class="pre">'a'</span></tt>, <tt class="docutils literal"><span class="pre">'k'</span></tt>,
<tt class="docutils literal"><span class="pre">'m'</span></tt>, or <tt class="docutils literal"><span class="pre">'$'</span></tt>; <tt class="docutils literal"><span class="pre">[a-z]</span></tt> will match any lowercase letter, and
<tt class="docutils literal"><span class="pre">[a-zA-Z0-9]</span></tt> matches any letter or digit. Character classes such
as <tt class="docutils literal"><span class="pre">\w</span></tt> or <tt class="docutils literal"><span class="pre">\S</span></tt> (defined below) are also acceptable inside a
range, although the characters they match depends on whether <a title="re.LOCALE" class="reference internal" href="#re.LOCALE"><tt class="xref docutils literal"><span class="pre">LOCALE</span></tt></a>
or <a title="re.UNICODE" class="reference internal" href="#re.UNICODE"><tt class="xref docutils literal"><span class="pre">UNICODE</span></tt></a> mode is in force. If you want to include a
<tt class="docutils literal"><span class="pre">']'</span></tt> or a <tt class="docutils literal"><span class="pre">'-'</span></tt> inside a set, precede it with a backslash, or
place it as the first character. The pattern <tt class="docutils literal"><span class="pre">[]]</span></tt> will match
<tt class="docutils literal"><span class="pre">']'</span></tt>, for example.</p>
<p>You can match the characters not within a range by <em>complementing</em> the set.
This is indicated by including a <tt class="docutils literal"><span class="pre">'^'</span></tt> as the first character of the set;
<tt class="docutils literal"><span class="pre">'^'</span></tt> elsewhere will simply match the <tt class="docutils literal"><span class="pre">'^'</span></tt> character. For example,
<tt class="docutils literal"><span class="pre">[^5]</span></tt> will match any character except <tt class="docutils literal"><span class="pre">'5'</span></tt>, and <tt class="docutils literal"><span class="pre">[^^]</span></tt> will match any
character except <tt class="docutils literal"><span class="pre">'^'</span></tt>.</p>
<p class="last">Note that inside <tt class="docutils literal"><span class="pre">[]</span></tt> the special forms and special characters lose
their meanings and only the syntaxes described here are valid. For
example, <tt class="docutils literal"><span class="pre">+</span></tt>, <tt class="docutils literal"><span class="pre">*</span></tt>, <tt class="docutils literal"><span class="pre">(</span></tt>, <tt class="docutils literal"><span class="pre">)</span></tt>, and so on are treated as
literals inside <tt class="docutils literal"><span class="pre">[]</span></tt>, and backreferences cannot be used inside
<tt class="docutils literal"><span class="pre">[]</span></tt>.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">'|'</span></tt></dt>
<dd><tt class="docutils literal"><span class="pre">A|B</span></tt>, where A and B can be arbitrary REs, creates a regular expression that
will match either A or B. An arbitrary number of REs can be separated by the
<tt class="docutils literal"><span class="pre">'|'</span></tt> in this way. This can be used inside groups (see below) as well. As
the target string is scanned, REs separated by <tt class="docutils literal"><span class="pre">'|'</span></tt> are tried from left to
right. When one pattern completely matches, that branch is accepted. This means
that once <tt class="docutils literal"><span class="pre">A</span></tt> matches, <tt class="docutils literal"><span class="pre">B</span></tt> will not be tested further, even if it would
produce a longer overall match. In other words, the <tt class="docutils literal"><span class="pre">'|'</span></tt> operator is never
greedy. To match a literal <tt class="docutils literal"><span class="pre">'|'</span></tt>, use <tt class="docutils literal"><span class="pre">\|</span></tt>, or enclose it inside a
character class, as in <tt class="docutils literal"><span class="pre">[|]</span></tt>.</dd>
<dt><tt class="docutils literal"><span class="pre">(...)</span></tt></dt>
<dd>Matches whatever regular expression is inside the parentheses, and indicates the
start and end of a group; the contents of a group can be retrieved after a match
has been performed, and can be matched later in the string with the <tt class="docutils literal"><span class="pre">\number</span></tt>
special sequence, described below. To match the literals <tt class="docutils literal"><span class="pre">'('</span></tt> or <tt class="docutils literal"><span class="pre">')'</span></tt>,
use <tt class="docutils literal"><span class="pre">\(</span></tt> or <tt class="docutils literal"><span class="pre">\)</span></tt>, or enclose them inside a character class: <tt class="docutils literal"><span class="pre">[(]</span> <span class="pre">[)]</span></tt>.</dd>
<dt><tt class="docutils literal"><span class="pre">(?...)</span></tt></dt>
<dd>This is an extension notation (a <tt class="docutils literal"><span class="pre">'?'</span></tt> following a <tt class="docutils literal"><span class="pre">'('</span></tt> is not meaningful
otherwise). The first character after the <tt class="docutils literal"><span class="pre">'?'</span></tt> determines what the meaning
and further syntax of the construct is. Extensions usually do not create a new
group; <tt class="docutils literal"><span class="pre">(?P<name>...)</span></tt> is the only exception to this rule. Following are the
currently supported extensions.</dd>
<dt><tt class="docutils literal"><span class="pre">(?iLmsux)</span></tt></dt>
<dd><p class="first">(One or more letters from the set <tt class="docutils literal"><span class="pre">'i'</span></tt>, <tt class="docutils literal"><span class="pre">'L'</span></tt>, <tt class="docutils literal"><span class="pre">'m'</span></tt>, <tt class="docutils literal"><span class="pre">'s'</span></tt>,
<tt class="docutils literal"><span class="pre">'u'</span></tt>, <tt class="docutils literal"><span class="pre">'x'</span></tt>.) The group matches the empty string; the letters
set the corresponding flags: <a title="re.I" class="reference internal" href="#re.I"><tt class="xref docutils literal"><span class="pre">re.I</span></tt></a> (ignore case),
<a title="re.L" class="reference internal" href="#re.L"><tt class="xref docutils literal"><span class="pre">re.L</span></tt></a> (locale dependent), <a title="re.M" class="reference internal" href="#re.M"><tt class="xref docutils literal"><span class="pre">re.M</span></tt></a> (multi-line),
<a title="re.S" class="reference internal" href="#re.S"><tt class="xref docutils literal"><span class="pre">re.S</span></tt></a> (dot matches all), <a title="re.U" class="reference internal" href="#re.U"><tt class="xref docutils literal"><span class="pre">re.U</span></tt></a> (Unicode dependent),
and <a title="re.X" class="reference internal" href="#re.X"><tt class="xref docutils literal"><span class="pre">re.X</span></tt></a> (verbose), for the entire regular expression. (The
flags are described in <a class="reference internal" href="#contents-of-module-re"><em>Module Contents</em></a>.) This
is useful if you wish to include the flags as part of the regular
expression, instead of passing a <em>flag</em> argument to the
<a title="re.compile" class="reference internal" href="#re.compile"><tt class="xref docutils literal"><span class="pre">re.compile()</span></tt></a> function.</p>
<p class="last">Note that the <tt class="docutils literal"><span class="pre">(?x)</span></tt> flag changes how the expression is parsed. It should be
used first in the expression string, or after one or more whitespace characters.
If there are non-whitespace characters before the flag, the results are
undefined.</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">(?:...)</span></tt></dt>
<dd>A non-capturing version of regular parentheses. Matches whatever regular
expression is inside the parentheses, but the substring matched by the group
<em>cannot</em> be retrieved after performing a match or referenced later in the
pattern.</dd>
<dt><tt class="docutils literal"><span class="pre">(?P<name>...)</span></tt></dt>
<dd><p class="first">Similar to regular parentheses, but the substring matched by the group is
accessible within the rest of the regular expression via the symbolic group
name <em>name</em>. Group names must be valid Python identifiers, and each group
name must be defined only once within a regular expression. A symbolic group
is also a numbered group, just as if the group were not named. So the group
named <tt class="docutils literal"><span class="pre">id</span></tt> in the example below can also be referenced as the numbered group
<tt class="docutils literal"><span class="pre">1</span></tt>.</p>
<p class="last">For example, if the pattern is <tt class="docutils literal"><span class="pre">(?P<id>[a-zA-Z_]\w*)</span></tt>, the group can be
referenced by its name in arguments to methods of match objects, such as
<tt class="docutils literal"><span class="pre">m.group('id')</span></tt> or <tt class="docutils literal"><span class="pre">m.end('id')</span></tt>, and also by name in the regular
expression itself (using <tt class="docutils literal"><span class="pre">(?P=id)</span></tt>) and replacement text given to
<tt class="docutils literal"><span class="pre">.sub()</span></tt> (using <tt class="docutils literal"><span class="pre">\g<id></span></tt>).</p>
</dd>
<dt><tt class="docutils literal"><span class="pre">(?P=name)</span></tt></dt>
<dd>Matches whatever text was matched by the earlier group named <em>name</em>.</dd>
<dt><tt class="docutils literal"><span class="pre">(?#...)</span></tt></dt>
<dd>A comment; the contents of the parentheses are simply ignored.</dd>
<dt><tt class="docutils literal"><span class="pre">(?=...)</span></tt></dt>
<dd>Matches if <tt class="docutils literal"><span class="pre">...</span></tt> matches next, but doesn’t consume any of the string. This is
called a lookahead assertion. For example, <tt class="docutils literal"><span class="pre">Isaac</span> <span class="pre">(?=Asimov)</span></tt> will match
<tt class="docutils literal"><span class="pre">'Isaac</span> <span class="pre">'</span></tt> only if it’s followed by <tt class="docutils literal"><span class="pre">'Asimov'</span></tt>.</dd>
<dt><tt class="docutils literal"><span class="pre">(?!...)</span></tt></dt>
<dd>Matches if <tt class="docutils literal"><span class="pre">...</span></tt> doesn’t match next. This is a negative lookahead assertion.
For example, <tt class="docutils literal"><span class="pre">Isaac</span> <span class="pre">(?!Asimov)</span></tt> will match <tt class="docutils literal"><span class="pre">'Isaac</span> <span class="pre">'</span></tt> only if it’s <em>not</em>
followed by <tt class="docutils literal"><span class="pre">'Asimov'</span></tt>.</dd>
<dt><tt class="docutils literal"><span class="pre">(?<=...)</span></tt></dt>
<dd><p class="first">Matches if the current position in the string is preceded by a match for <tt class="docutils literal"><span class="pre">...</span></tt>
that ends at the current position. This is called a <em>positive lookbehind
assertion</em>. <tt class="docutils literal"><span class="pre">(?<=abc)def</span></tt> will find a match in <tt class="docutils literal"><span class="pre">abcdef</span></tt>, since the
lookbehind will back up 3 characters and check if the contained pattern matches.
The contained pattern must only match strings of some fixed length, meaning that
<tt class="docutils literal"><span class="pre">abc</span></tt> or <tt class="docutils literal"><span class="pre">a|b</span></tt> are allowed, but <tt class="docutils literal"><span class="pre">a*</span></tt> and <tt class="docutils literal"><span class="pre">a{3,4}</span></tt> are not. Note that
patterns which start with positive lookbehind assertions will never match at the
beginning of the string being searched; you will most likely want to use the
<a title="re.search" class="reference internal" href="#re.search"><tt class="xref docutils literal"><span class="pre">search()</span></tt></a> function rather than the <a title="re.match" class="reference internal" href="#re.match"><tt class="xref docutils literal"><span class="pre">match()</span></tt></a> function:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">re</span>
<span class="gp">>>> </span><span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s">'(?<=abc)def'</span><span class="p">,</span> <span class="s">'abcdef'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="go">'def'</span>
</pre></div>
</div>
<p>This example looks for a word following a hyphen:</p>
<div class="last highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s">'(?<=-)\w+'</span><span class="p">,</span> <span class="s">'spam-egg'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span>
<span class="go">'egg'</span>
</pre></div>
</div>
</dd>
<dt><tt class="docutils literal"><span class="pre">(?<!...)</span></tt></dt>
<dd>Matches if the current position in the string is not preceded by a match for
<tt class="docutils literal"><span class="pre">...</span></tt>. This is called a <em>negative lookbehind assertion</em>. Similar to
positive lookbehind assertions, the contained pattern must only match strings of
some fixed length. Patterns which start with negative lookbehind assertions may
match at the beginning of the string being searched.</dd>
<dt><tt class="docutils literal"><span class="pre">(?(id/name)yes-pattern|no-pattern)</span></tt></dt>
<dd><p class="first">Will try to match with <tt class="docutils literal"><span class="pre">yes-pattern</span></tt> if the group with given <em>id</em> or <em>name</em>
exists, and with <tt class="docutils literal"><span class="pre">no-pattern</span></tt> if it doesn’t. <tt class="docutils literal"><span class="pre">no-pattern</span></tt> is optional and
can be omitted. For example, <tt class="docutils literal"><span class="pre">(<)?(\w+@\w+(?:\.\w+)+)(?(1)>)</span></tt> is a poor email
matching pattern, which will match with <tt class="docutils literal"><span class="pre">'<[email protected]>'</span></tt> as well as
<tt class="docutils literal"><span class="pre">'[email protected]'</span></tt>, but not with <tt class="docutils literal"><span class="pre">'<[email protected]'</span></tt>.</p>
<p class="last versionadded">
<span class="versionmodified">New in version 2.4.</span></p>
</dd>
</dl>
<p>The special sequences consist of <tt class="docutils literal"><span class="pre">'\'</span></tt> and a character from the list below.
If the ordinary character is not on the list, then the resulting RE will match
the second character. For example, <tt class="docutils literal"><span class="pre">\$</span></tt> matches the character <tt class="docutils literal"><span class="pre">'$'</span></tt>.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">\number</span></tt></dt>
<dd>Matches the contents of the group of the same number. Groups are numbered
starting from 1. For example, <tt class="docutils literal"><span class="pre">(.+)</span> <span class="pre">\1</span></tt> matches <tt class="docutils literal"><span class="pre">'the</span> <span class="pre">the'</span></tt> or <tt class="docutils literal"><span class="pre">'55</span> <span class="pre">55'</span></tt>,
but not <tt class="docutils literal"><span class="pre">'the</span> <span class="pre">end'</span></tt> (note the space after the group). This special sequence
can only be used to match one of the first 99 groups. If the first digit of
<em>number</em> is 0, or <em>number</em> is 3 octal digits long, it will not be interpreted as
a group match, but as the character with octal value <em>number</em>. Inside the
<tt class="docutils literal"><span class="pre">'['</span></tt> and <tt class="docutils literal"><span class="pre">']'</span></tt> of a character class, all numeric escapes are treated as
characters.</dd>
<dt><tt class="docutils literal"><span class="pre">\A</span></tt></dt>
<dd>Matches only at the start of the string.</dd>
<dt><tt class="docutils literal"><span class="pre">\b</span></tt></dt>
<dd>Matches the empty string, but only at the beginning or end of a word. A word is
defined as a sequence of alphanumeric or underscore characters, so the end of a
word is indicated by whitespace or a non-alphanumeric, non-underscore character.
Note that <tt class="docutils literal"><span class="pre">\b</span></tt> is defined as the boundary between <tt class="docutils literal"><span class="pre">\w</span></tt> and <tt class="docutils literal"><span class="pre">\W</span></tt>, so the
precise set of characters deemed to be alphanumeric depends on the values of the
<tt class="docutils literal"><span class="pre">UNICODE</span></tt> and <tt class="docutils literal"><span class="pre">LOCALE</span></tt> flags. Inside a character range, <tt class="docutils literal"><span class="pre">\b</span></tt> represents
the backspace character, for compatibility with Python’s string literals.</dd>
<dt><tt class="docutils literal"><span class="pre">\B</span></tt></dt>
<dd>Matches the empty string, but only when it is <em>not</em> at the beginning or end of a
word. This is just the opposite of <tt class="docutils literal"><span class="pre">\b</span></tt>, so is also subject to the settings
of <tt class="docutils literal"><span class="pre">LOCALE</span></tt> and <tt class="docutils literal"><span class="pre">UNICODE</span></tt>.</dd>
<dt><tt class="docutils literal"><span class="pre">\d</span></tt></dt>
<dd>When the <a title="re.UNICODE" class="reference internal" href="#re.UNICODE"><tt class="xref docutils literal"><span class="pre">UNICODE</span></tt></a> flag is not specified, matches any decimal digit; this
is equivalent to the set <tt class="docutils literal"><span class="pre">[0-9]</span></tt>. With <a title="re.UNICODE" class="reference internal" href="#re.UNICODE"><tt class="xref docutils literal"><span class="pre">UNICODE</span></tt></a>, it will match
whatever is classified as a decimal digit in the Unicode character properties
database.</dd>
<dt><tt class="docutils literal"><span class="pre">\D</span></tt></dt>
<dd>When the <a title="re.UNICODE" class="reference internal" href="#re.UNICODE"><tt class="xref docutils literal"><span class="pre">UNICODE</span></tt></a> flag is not specified, matches any non-digit
character; this is equivalent to the set <tt class="docutils literal"><span class="pre">[^0-9]</span></tt>. With <a title="re.UNICODE" class="reference internal" href="#re.UNICODE"><tt class="xref docutils literal"><span class="pre">UNICODE</span></tt></a>, it
will match anything other than character marked as digits in the Unicode
character properties database.</dd>
<dt><tt class="docutils literal"><span class="pre">\s</span></tt></dt>
<dd>When the <a title="re.LOCALE" class="reference internal" href="#re.LOCALE"><tt class="xref docutils literal"><span class="pre">LOCALE</span></tt></a> and <a title="re.UNICODE" class="reference internal" href="#re.UNICODE"><tt class="xref docutils literal"><span class="pre">UNICODE</span></tt></a> flags are not specified, matches
any whitespace character; this is equivalent to the set <tt class="docutils literal"><span class="pre">[</span> <span class="pre">\t\n\r\f\v]</span></tt>. With
<a title="re.LOCALE" class="reference internal" href="#re.LOCALE"><tt class="xref docutils literal"><span class="pre">LOCALE</span></tt></a>, it will match this set plus whatever characters are defined as
space for the current locale. If <a title="re.UNICODE" class="reference internal" href="#re.UNICODE"><tt class="xref docutils literal"><span class="pre">UNICODE</span></tt></a> is set, this will match the
characters <tt class="docutils literal"><span class="pre">[</span> <span class="pre">\t\n\r\f\v]</span></tt> plus whatever is classified as space in the Unicode
character properties database.</dd>
<dt><tt class="docutils literal"><span class="pre">\S</span></tt></dt>
<dd>When the <a title="re.LOCALE" class="reference internal" href="#re.LOCALE"><tt class="xref docutils literal"><span class="pre">LOCALE</span></tt></a> and <a title="re.UNICODE" class="reference internal" href="#re.UNICODE"><tt class="xref docutils literal"><span class="pre">UNICODE</span></tt></a> flags are not specified, matches
any non-whitespace character; this is equivalent to the set <tt class="docutils literal"><span class="pre">[^</span> <span class="pre">\t\n\r\f\v]</span></tt>
With <a title="re.LOCALE" class="reference internal" href="#re.LOCALE"><tt class="xref docutils literal"><span class="pre">LOCALE</span></tt></a>, it will match any character not in this set, and not
defined as space in the current locale. If <a title="re.UNICODE" class="reference internal" href="#re.UNICODE"><tt class="xref docutils literal"><span class="pre">UNICODE</span></tt></a> is set, this will
match anything other than <tt class="docutils literal"><span class="pre">[</span> <span class="pre">\t\n\r\f\v]</span></tt> and characters marked as space in
the Unicode character properties database.</dd>
<dt><tt class="docutils literal"><span class="pre">\w</span></tt></dt>
<dd>When the <a title="re.LOCALE" class="reference internal" href="#re.LOCALE"><tt class="xref docutils literal"><span class="pre">LOCALE</span></tt></a> and <a title="re.UNICODE" class="reference internal" href="#re.UNICODE"><tt class="xref docutils literal"><span class="pre">UNICODE</span></tt></a> flags are not specified, matches
any alphanumeric character and the underscore; this is equivalent to the set
<tt class="docutils literal"><span class="pre">[a-zA-Z0-9_]</span></tt>. With <a title="re.LOCALE" class="reference internal" href="#re.LOCALE"><tt class="xref docutils literal"><span class="pre">LOCALE</span></tt></a>, it will match the set <tt class="docutils literal"><span class="pre">[0-9_]</span></tt> plus
whatever characters are defined as alphanumeric for the current locale. If
<a title="re.UNICODE" class="reference internal" href="#re.UNICODE"><tt class="xref docutils literal"><span class="pre">UNICODE</span></tt></a> is set, this will match the characters <tt class="docutils literal"><span class="pre">[0-9_]</span></tt> plus whatever
is classified as alphanumeric in the Unicode character properties database.</dd>
<dt><tt class="docutils literal"><span class="pre">\W</span></tt></dt>
<dd>When the <a title="re.LOCALE" class="reference internal" href="#re.LOCALE"><tt class="xref docutils literal"><span class="pre">LOCALE</span></tt></a> and <a title="re.UNICODE" class="reference internal" href="#re.UNICODE"><tt class="xref docutils literal"><span class="pre">UNICODE</span></tt></a> flags are not specified, matches
any non-alphanumeric character; this is equivalent to the set <tt class="docutils literal"><span class="pre">[^a-zA-Z0-9_]</span></tt>.
With <a title="re.LOCALE" class="reference internal" href="#re.LOCALE"><tt class="xref docutils literal"><span class="pre">LOCALE</span></tt></a>, it will match any character not in the set <tt class="docutils literal"><span class="pre">[0-9_]</span></tt>, and
not defined as alphanumeric for the current locale. If <a title="re.UNICODE" class="reference internal" href="#re.UNICODE"><tt class="xref docutils literal"><span class="pre">UNICODE</span></tt></a> is set,
this will match anything other than <tt class="docutils literal"><span class="pre">[0-9_]</span></tt> and characters marked as
alphanumeric in the Unicode character properties database.</dd>
<dt><tt class="docutils literal"><span class="pre">\Z</span></tt></dt>
<dd>Matches only at the end of the string.</dd>
</dl>
<p>Most of the standard escapes supported by Python string literals are also
accepted by the regular expression parser:</p>
<div class="highlight-python"><pre>\a \b \f \n
\r \t \v \x
\\</pre>
</div>
<p>Octal escapes are included in a limited form: If the first digit is a 0, or if
there are three octal digits, it is considered an octal escape. Otherwise, it is
a group reference. As for string literals, octal escapes are always at most
three digits in length.</p>
</div>
<div class="section" id="matching-vs-searching">
<span id="matching-searching"></span><h2>7.2.2. Matching vs Searching<a class="headerlink" href="#matching-vs-searching" title="Permalink to this headline">¶</a></h2>
<p>Python offers two different primitive operations based on regular expressions:
<strong>match</strong> checks for a match only at the beginning of the string, while
<strong>search</strong> checks for a match anywhere in the string (this is what Perl does
by default).</p>
<p>Note that match may differ from search even when using a regular expression
beginning with <tt class="docutils literal"><span class="pre">'^'</span></tt>: <tt class="docutils literal"><span class="pre">'^'</span></tt> matches only at the start of the string, or in
<a title="re.MULTILINE" class="reference internal" href="#re.MULTILINE"><tt class="xref docutils literal"><span class="pre">MULTILINE</span></tt></a> mode also immediately following a newline. The “match”
operation succeeds only if the pattern matches at the start of the string
regardless of mode, or at the starting position given by the optional <em>pos</em>
argument regardless of whether a newline precedes it.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">"c"</span><span class="p">,</span> <span class="s">"abcdef"</span><span class="p">)</span> <span class="c"># No match</span>
<span class="gp">>>> </span><span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s">"c"</span><span class="p">,</span> <span class="s">"abcdef"</span><span class="p">)</span> <span class="c"># Match</span>
<span class="go"><_sre.SRE_Match object at ...></span>
</pre></div>
</div>
</div>
<div class="section" id="module-contents">
<span id="contents-of-module-re"></span><h2>7.2.3. Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2>
<p>The module defines several functions, constants, and an exception. Some of the
functions are simplified versions of the full featured methods for compiled
regular expressions. Most non-trivial applications always use the compiled
form.</p>
<dl class="function">
<dt id="re.compile">
<tt class="descclassname">re.</tt><tt class="descname">compile</tt><big>(</big><em>pattern</em><span class="optional">[</span>, <em>flags</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.compile" title="Permalink to this definition">¶</a></dt>
<dd><p>Compile a regular expression pattern into a regular expression object, which
can be used for matching using its <a title="re.match" class="reference internal" href="#re.match"><tt class="xref docutils literal"><span class="pre">match()</span></tt></a> and <a title="re.search" class="reference internal" href="#re.search"><tt class="xref docutils literal"><span class="pre">search()</span></tt></a> methods,
described below.</p>
<p>The expression’s behaviour can be modified by specifying a <em>flags</em> value.
Values can be any of the following variables, combined using bitwise OR (the
<tt class="docutils literal"><span class="pre">|</span></tt> operator).</p>
<p>The sequence</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">prog</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">pattern</span><span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">prog</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">string</span><span class="p">)</span>
</pre></div>
</div>
<p>is equivalent to</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">result</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">pattern</span><span class="p">,</span> <span class="n">string</span><span class="p">)</span>
</pre></div>
</div>
<p>but using <a title="re.compile" class="reference internal" href="#re.compile"><tt class="xref docutils literal"><span class="pre">re.compile()</span></tt></a> and saving the resulting regular expression
object for reuse is more efficient when the expression will be used several
times in a single program.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The compiled versions of the most recent patterns passed to
<a title="re.match" class="reference internal" href="#re.match"><tt class="xref docutils literal"><span class="pre">re.match()</span></tt></a>, <a title="re.search" class="reference internal" href="#re.search"><tt class="xref docutils literal"><span class="pre">re.search()</span></tt></a> or <a title="re.compile" class="reference internal" href="#re.compile"><tt class="xref docutils literal"><span class="pre">re.compile()</span></tt></a> are cached, so
programs that use only a few regular expressions at a time needn’t worry
about compiling regular expressions.</p>
</div>
</dd></dl>
<dl class="data">
<dt id="re.I">
<tt class="descclassname">re.</tt><tt class="descname">I</tt><a class="headerlink" href="#re.I" title="Permalink to this definition">¶</a></dt>
<dt id="re.IGNORECASE">
<tt class="descclassname">re.</tt><tt class="descname">IGNORECASE</tt><a class="headerlink" href="#re.IGNORECASE" title="Permalink to this definition">¶</a></dt>
<dd>Perform case-insensitive matching; expressions like <tt class="docutils literal"><span class="pre">[A-Z]</span></tt> will match
lowercase letters, too. This is not affected by the current locale.</dd></dl>
<dl class="data">
<dt id="re.L">
<tt class="descclassname">re.</tt><tt class="descname">L</tt><a class="headerlink" href="#re.L" title="Permalink to this definition">¶</a></dt>
<dt id="re.LOCALE">
<tt class="descclassname">re.</tt><tt class="descname">LOCALE</tt><a class="headerlink" href="#re.LOCALE" title="Permalink to this definition">¶</a></dt>
<dd>Make <tt class="docutils literal"><span class="pre">\w</span></tt>, <tt class="docutils literal"><span class="pre">\W</span></tt>, <tt class="docutils literal"><span class="pre">\b</span></tt>, <tt class="docutils literal"><span class="pre">\B</span></tt>, <tt class="docutils literal"><span class="pre">\s</span></tt> and <tt class="docutils literal"><span class="pre">\S</span></tt> dependent on the
current locale.</dd></dl>
<dl class="data">
<dt id="re.M">
<tt class="descclassname">re.</tt><tt class="descname">M</tt><a class="headerlink" href="#re.M" title="Permalink to this definition">¶</a></dt>
<dt id="re.MULTILINE">
<tt class="descclassname">re.</tt><tt class="descname">MULTILINE</tt><a class="headerlink" href="#re.MULTILINE" title="Permalink to this definition">¶</a></dt>
<dd>When specified, the pattern character <tt class="docutils literal"><span class="pre">'^'</span></tt> matches at the beginning of the
string and at the beginning of each line (immediately following each newline);
and the pattern character <tt class="docutils literal"><span class="pre">'$'</span></tt> matches at the end of the string and at the
end of each line (immediately preceding each newline). By default, <tt class="docutils literal"><span class="pre">'^'</span></tt>
matches only at the beginning of the string, and <tt class="docutils literal"><span class="pre">'$'</span></tt> only at the end of the
string and immediately before the newline (if any) at the end of the string.</dd></dl>
<dl class="data">
<dt id="re.S">
<tt class="descclassname">re.</tt><tt class="descname">S</tt><a class="headerlink" href="#re.S" title="Permalink to this definition">¶</a></dt>
<dt id="re.DOTALL">
<tt class="descclassname">re.</tt><tt class="descname">DOTALL</tt><a class="headerlink" href="#re.DOTALL" title="Permalink to this definition">¶</a></dt>
<dd>Make the <tt class="docutils literal"><span class="pre">'.'</span></tt> special character match any character at all, including a
newline; without this flag, <tt class="docutils literal"><span class="pre">'.'</span></tt> will match anything <em>except</em> a newline.</dd></dl>
<dl class="data">
<dt id="re.U">
<tt class="descclassname">re.</tt><tt class="descname">U</tt><a class="headerlink" href="#re.U" title="Permalink to this definition">¶</a></dt>
<dt id="re.UNICODE">
<tt class="descclassname">re.</tt><tt class="descname">UNICODE</tt><a class="headerlink" href="#re.UNICODE" title="Permalink to this definition">¶</a></dt>
<dd><p>Make <tt class="docutils literal"><span class="pre">\w</span></tt>, <tt class="docutils literal"><span class="pre">\W</span></tt>, <tt class="docutils literal"><span class="pre">\b</span></tt>, <tt class="docutils literal"><span class="pre">\B</span></tt>, <tt class="docutils literal"><span class="pre">\d</span></tt>, <tt class="docutils literal"><span class="pre">\D</span></tt>, <tt class="docutils literal"><span class="pre">\s</span></tt> and <tt class="docutils literal"><span class="pre">\S</span></tt> dependent
on the Unicode character properties database.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.0.</span></p>
</dd></dl>
<dl class="data">
<dt id="re.X">
<tt class="descclassname">re.</tt><tt class="descname">X</tt><a class="headerlink" href="#re.X" title="Permalink to this definition">¶</a></dt>
<dt id="re.VERBOSE">
<tt class="descclassname">re.</tt><tt class="descname">VERBOSE</tt><a class="headerlink" href="#re.VERBOSE" title="Permalink to this definition">¶</a></dt>
<dd><p>This flag allows you to write regular expressions that look nicer. Whitespace
within the pattern is ignored, except when in a character class or preceded by
an unescaped backslash, and, when a line contains a <tt class="docutils literal"><span class="pre">'#'</span></tt> neither in a
character class or preceded by an unescaped backslash, all characters from the
leftmost such <tt class="docutils literal"><span class="pre">'#'</span></tt> through the end of the line are ignored.</p>
<p>That means that the two following regular expression objects that match a
decimal number are functionally equal:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">a</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">r"""\d + # the integral part</span>
<span class="s"> \. # the decimal point</span>
<span class="s"> \d * # some fractional digits"""</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">X</span><span class="p">)</span>
<span class="n">b</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">r"\d+\.\d*"</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
<dl class="function">
<dt id="re.search">
<tt class="descclassname">re.</tt><tt class="descname">search</tt><big>(</big><em>pattern</em>, <em>string</em><span class="optional">[</span>, <em>flags</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.search" title="Permalink to this definition">¶</a></dt>
<dd>Scan through <em>string</em> looking for a location where the regular expression
<em>pattern</em> produces a match, and return a corresponding <a title="re.MatchObject" class="reference internal" href="#re.MatchObject"><tt class="xref docutils literal"><span class="pre">MatchObject</span></tt></a>
instance. Return <tt class="xref docutils literal"><span class="pre">None</span></tt> if no position in the string matches the pattern; note
that this is different from finding a zero-length match at some point in the
string.</dd></dl>
<dl class="function">
<dt id="re.match">
<tt class="descclassname">re.</tt><tt class="descname">match</tt><big>(</big><em>pattern</em>, <em>string</em><span class="optional">[</span>, <em>flags</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.match" title="Permalink to this definition">¶</a></dt>
<dd><p>If zero or more characters at the beginning of <em>string</em> match the regular
expression <em>pattern</em>, return a corresponding <a title="re.MatchObject" class="reference internal" href="#re.MatchObject"><tt class="xref docutils literal"><span class="pre">MatchObject</span></tt></a> instance.
Return <tt class="xref docutils literal"><span class="pre">None</span></tt> if the string does not match the pattern; note that this is
different from a zero-length match.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If you want to locate a match anywhere in <em>string</em>, use <a title="re.search" class="reference internal" href="#re.search"><tt class="xref docutils literal"><span class="pre">search()</span></tt></a>
instead.</p>
</div>
</dd></dl>
<dl class="function">
<dt id="re.split">
<tt class="descclassname">re.</tt><tt class="descname">split</tt><big>(</big><em>pattern</em>, <em>string</em><span class="optional">[</span>, <em>maxsplit=0</em>, <em>flags=0</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.split" title="Permalink to this definition">¶</a></dt>
<dd><p>Split <em>string</em> by the occurrences of <em>pattern</em>. If capturing parentheses are
used in <em>pattern</em>, then the text of all groups in the pattern are also returned
as part of the resulting list. If <em>maxsplit</em> is nonzero, at most <em>maxsplit</em>
splits occur, and the remainder of the string is returned as the final element
of the list. (Incompatibility note: in the original Python 1.5 release,
<em>maxsplit</em> was ignored. This has been fixed in later releases.)</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'\W+'</span><span class="p">,</span> <span class="s">'Words, words, words.'</span><span class="p">)</span>
<span class="go">['Words', 'words', 'words', '']</span>
<span class="gp">>>> </span><span class="n">re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'(\W+)'</span><span class="p">,</span> <span class="s">'Words, words, words.'</span><span class="p">)</span>
<span class="go">['Words', ', ', 'words', ', ', 'words', '.', '']</span>
<span class="gp">>>> </span><span class="n">re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'\W+'</span><span class="p">,</span> <span class="s">'Words, words, words.'</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span>
<span class="go">['Words', 'words, words.']</span>
<span class="gp">>>> </span><span class="n">re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'[a-f]+'</span><span class="p">,</span> <span class="s">'0a3B9'</span><span class="p">,</span> <span class="n">flags</span><span class="o">=</span><span class="n">re</span><span class="o">.</span><span class="n">IGNORECASE</span><span class="p">)</span>
<span class="go">['0', '3', '9']</span>
</pre></div>
</div>
<p>If there are capturing groups in the separator and it matches at the start of
the string, the result will start with an empty string. The same holds for
the end of the string:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'(\W+)'</span><span class="p">,</span> <span class="s">'...words, words...'</span><span class="p">)</span>
<span class="go">['', '...', 'words', ', ', 'words', '...', '']</span>
</pre></div>
</div>
<p>That way, separator components are always found at the same relative
indices within the result list (e.g., if there’s one capturing group
in the separator, the 0th, the 2nd and so forth).</p>
<p>Note that <em>split</em> will never split a string on an empty pattern match.
For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">'x*'</span><span class="p">,</span> <span class="s">'foo'</span><span class="p">)</span>
<span class="go">['foo']</span>
<span class="gp">>>> </span><span class="n">re</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s">"(?m)^$"</span><span class="p">,</span> <span class="s">"foo</span><span class="se">\n\n</span><span class="s">bar</span><span class="se">\n</span><span class="s">"</span><span class="p">)</span>
<span class="go">['foo\n\nbar\n']</span>
</pre></div>
</div>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.7: </span>Added the optional flags argument.</p>
</dd></dl>
<dl class="function">
<dt id="re.findall">
<tt class="descclassname">re.</tt><tt class="descname">findall</tt><big>(</big><em>pattern</em>, <em>string</em><span class="optional">[</span>, <em>flags</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.findall" title="Permalink to this definition">¶</a></dt>
<dd><p>Return all non-overlapping matches of <em>pattern</em> in <em>string</em>, as a list of
strings. The <em>string</em> is scanned left-to-right, and matches are returned in
the order found. If one or more groups are present in the pattern, return a
list of groups; this will be a list of tuples if the pattern has more than
one group. Empty matches are included in the result unless they touch the
beginning of another match.</p>
<p class="versionadded">
<span class="versionmodified">New in version 1.5.2.</span></p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.4: </span>Added the optional flags argument.</p>
</dd></dl>
<dl class="function">
<dt id="re.finditer">
<tt class="descclassname">re.</tt><tt class="descname">finditer</tt><big>(</big><em>pattern</em>, <em>string</em><span class="optional">[</span>, <em>flags</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.finditer" title="Permalink to this definition">¶</a></dt>
<dd><p>Return an <a class="reference external" href="http://docs.python.org/glossary.html#term-iterator"><em class="xref">iterator</em></a> yielding <a title="re.MatchObject" class="reference internal" href="#re.MatchObject"><tt class="xref docutils literal"><span class="pre">MatchObject</span></tt></a> instances over all
non-overlapping matches for the RE <em>pattern</em> in <em>string</em>. The <em>string</em> is
scanned left-to-right, and matches are returned in the order found. Empty
matches are included in the result unless they touch the beginning of another
match.</p>
<p class="versionadded">
<span class="versionmodified">New in version 2.2.</span></p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.4: </span>Added the optional flags argument.</p>
</dd></dl>
<dl class="function">
<dt id="re.sub">
<tt class="descclassname">re.</tt><tt class="descname">sub</tt><big>(</big><em>pattern</em>, <em>repl</em>, <em>string</em><span class="optional">[</span>, <em>count</em>, <em>flags</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.sub" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the string obtained by replacing the leftmost non-overlapping occurrences
of <em>pattern</em> in <em>string</em> by the replacement <em>repl</em>. If the pattern isn’t found,
<em>string</em> is returned unchanged. <em>repl</em> can be a string or a function; if it is
a string, any backslash escapes in it are processed. That is, <tt class="docutils literal"><span class="pre">\n</span></tt> is
converted to a single newline character, <tt class="docutils literal"><span class="pre">\r</span></tt> is converted to a linefeed, and
so forth. Unknown escapes such as <tt class="docutils literal"><span class="pre">\j</span></tt> are left alone. Backreferences, such
as <tt class="docutils literal"><span class="pre">\6</span></tt>, are replaced with the substring matched by group 6 in the pattern.
For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s">r'def\s+([a-zA-Z_][a-zA-Z_0-9]*)\s*\(\s*\):'</span><span class="p">,</span>
<span class="gp">... </span> <span class="s">r'static PyObject*\npy_\1(void)\n{'</span><span class="p">,</span>
<span class="gp">... </span> <span class="s">'def myfunc():'</span><span class="p">)</span>
<span class="go">'static PyObject*\npy_myfunc(void)\n{'</span>
</pre></div>
</div>
<p>If <em>repl</em> is a function, it is called for every non-overlapping occurrence of
<em>pattern</em>. The function takes a single match object argument, and returns the
replacement string. For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="k">def</span> <span class="nf">dashrepl</span><span class="p">(</span><span class="n">matchobj</span><span class="p">):</span>
<span class="gp">... </span> <span class="k">if</span> <span class="n">matchobj</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="o">==</span> <span class="s">'-'</span><span class="p">:</span> <span class="k">return</span> <span class="s">' '</span>
<span class="gp">... </span> <span class="k">else</span><span class="p">:</span> <span class="k">return</span> <span class="s">'-'</span>
<span class="gp">>>> </span><span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s">'-{1,2}'</span><span class="p">,</span> <span class="n">dashrepl</span><span class="p">,</span> <span class="s">'pro----gram-files'</span><span class="p">)</span>
<span class="go">'pro--gram files'</span>
<span class="gp">>>> </span><span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="s">r'\sAND\s'</span><span class="p">,</span> <span class="s">' & '</span><span class="p">,</span> <span class="s">'Baked Beans And Spam'</span><span class="p">,</span> <span class="n">flags</span><span class="o">=</span><span class="n">re</span><span class="o">.</span><span class="n">IGNORECASE</span><span class="p">)</span>
<span class="go">'Baked Beans & Spam'</span>
</pre></div>
</div>
<p>The pattern may be a string or an RE object.</p>
<p>The optional argument <em>count</em> is the maximum number of pattern occurrences to be
replaced; <em>count</em> must be a non-negative integer. If omitted or zero, all
occurrences will be replaced. Empty matches for the pattern are replaced only
when not adjacent to a previous match, so <tt class="docutils literal"><span class="pre">sub('x*',</span> <span class="pre">'-',</span> <span class="pre">'abc')</span></tt> returns
<tt class="docutils literal"><span class="pre">'-a-b-c-'</span></tt>.</p>
<p>In addition to character escapes and backreferences as described above,
<tt class="docutils literal"><span class="pre">\g<name></span></tt> will use the substring matched by the group named <tt class="docutils literal"><span class="pre">name</span></tt>, as
defined by the <tt class="docutils literal"><span class="pre">(?P<name>...)</span></tt> syntax. <tt class="docutils literal"><span class="pre">\g<number></span></tt> uses the corresponding
group number; <tt class="docutils literal"><span class="pre">\g<2></span></tt> is therefore equivalent to <tt class="docutils literal"><span class="pre">\2</span></tt>, but isn’t ambiguous
in a replacement such as <tt class="docutils literal"><span class="pre">\g<2>0</span></tt>. <tt class="docutils literal"><span class="pre">\20</span></tt> would be interpreted as a
reference to group 20, not a reference to group 2 followed by the literal
character <tt class="docutils literal"><span class="pre">'0'</span></tt>. The backreference <tt class="docutils literal"><span class="pre">\g<0></span></tt> substitutes in the entire
substring matched by the RE.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.7: </span>Added the optional flags argument.</p>
</dd></dl>
<dl class="function">
<dt id="re.subn">
<tt class="descclassname">re.</tt><tt class="descname">subn</tt><big>(</big><em>pattern</em>, <em>repl</em>, <em>string</em><span class="optional">[</span>, <em>count</em>, <em>flags</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.subn" title="Permalink to this definition">¶</a></dt>
<dd><p>Perform the same operation as <a title="re.sub" class="reference internal" href="#re.sub"><tt class="xref docutils literal"><span class="pre">sub()</span></tt></a>, but return a tuple <tt class="docutils literal"><span class="pre">(new_string,</span>
<span class="pre">number_of_subs_made)</span></tt>.</p>
<p class="versionchanged">
<span class="versionmodified">Changed in version 2.7: </span>Added the optional flags argument.</p>
</dd></dl>
<dl class="function">
<dt id="re.escape">
<tt class="descclassname">re.</tt><tt class="descname">escape</tt><big>(</big><em>string</em><big>)</big><a class="headerlink" href="#re.escape" title="Permalink to this definition">¶</a></dt>
<dd>Return <em>string</em> with all non-alphanumerics backslashed; this is useful if you
want to match an arbitrary literal string that may have regular expression
metacharacters in it.</dd></dl>
<dl class="function">
<dt id="re.purge">
<tt class="descclassname">re.</tt><tt class="descname">purge</tt><big>(</big><big>)</big><a class="headerlink" href="#re.purge" title="Permalink to this definition">¶</a></dt>
<dd>Clear the regular expression cache.</dd></dl>
<dl class="exception">
<dt id="re.error">
<em class="property">exception </em><tt class="descclassname">re.</tt><tt class="descname">error</tt><a class="headerlink" href="#re.error" title="Permalink to this definition">¶</a></dt>
<dd>Exception raised when a string passed to one of the functions here is not a
valid regular expression (for example, it might contain unmatched parentheses)
or when some other error occurs during compilation or matching. It is never an
error if a string contains no match for a pattern.</dd></dl>
</div>
<div class="section" id="regular-expression-objects">
<span id="re-objects"></span><h2>7.2.4. Regular Expression Objects<a class="headerlink" href="#regular-expression-objects" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="re.RegexObject">
<em class="property">class </em><tt class="descclassname">re.</tt><tt class="descname">RegexObject</tt><a class="headerlink" href="#re.RegexObject" title="Permalink to this definition">¶</a></dt>
<dd><p>The <a title="re.RegexObject" class="reference internal" href="#re.RegexObject"><tt class="xref docutils literal"><span class="pre">RegexObject</span></tt></a> class supports the following methods and attributes:</p>
<dl class="method">
<dt id="re.RegexObject.search">
<tt class="descname">search</tt><big>(</big><em>string</em><span class="optional">[</span>, <em>pos</em><span class="optional">[</span>, <em>endpos</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.RegexObject.search" title="Permalink to this definition">¶</a></dt>
<dd><p>Scan through <em>string</em> looking for a location where this regular expression
produces a match, and return a corresponding <a title="re.MatchObject" class="reference internal" href="#re.MatchObject"><tt class="xref docutils literal"><span class="pre">MatchObject</span></tt></a> instance.
Return <tt class="xref docutils literal"><span class="pre">None</span></tt> if no position in the string matches the pattern; note that this
is different from finding a zero-length match at some point in the string.</p>
<p>The optional second parameter <em>pos</em> gives an index in the string where the
search is to start; it defaults to <tt class="docutils literal"><span class="pre">0</span></tt>. This is not completely equivalent to
slicing the string; the <tt class="docutils literal"><span class="pre">'^'</span></tt> pattern character matches at the real beginning
of the string and at positions just after a newline, but not necessarily at the
index where the search is to start.</p>
<p>The optional parameter <em>endpos</em> limits how far the string will be searched; it
will be as if the string is <em>endpos</em> characters long, so only the characters
from <em>pos</em> to <tt class="docutils literal"><span class="pre">endpos</span> <span class="pre">-</span> <span class="pre">1</span></tt> will be searched for a match. If <em>endpos</em> is less
than <em>pos</em>, no match will be found, otherwise, if <em>rx</em> is a compiled regular
expression object, <tt class="docutils literal"><span class="pre">rx.search(string,</span> <span class="pre">0,</span> <span class="pre">50)</span></tt> is equivalent to
<tt class="docutils literal"><span class="pre">rx.search(string[:50],</span> <span class="pre">0)</span></tt>.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">pattern</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">"d"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">pattern</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s">"dog"</span><span class="p">)</span> <span class="c"># Match at index 0</span>
<span class="go"><_sre.SRE_Match object at ...></span>
<span class="gp">>>> </span><span class="n">pattern</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s">"dog"</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="c"># No match; search doesn't include the "d"</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="re.RegexObject.match">
<tt class="descname">match</tt><big>(</big><em>string</em><span class="optional">[</span>, <em>pos</em><span class="optional">[</span>, <em>endpos</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.RegexObject.match" title="Permalink to this definition">¶</a></dt>
<dd><p>If zero or more characters at the <em>beginning</em> of <em>string</em> match this regular
expression, return a corresponding <a title="re.MatchObject" class="reference internal" href="#re.MatchObject"><tt class="xref docutils literal"><span class="pre">MatchObject</span></tt></a> instance. Return
<tt class="xref docutils literal"><span class="pre">None</span></tt> if the string does not match the pattern; note that this is different
from a zero-length match.</p>
<p>The optional <em>pos</em> and <em>endpos</em> parameters have the same meaning as for the
<a title="re.RegexObject.search" class="reference internal" href="#re.RegexObject.search"><tt class="xref docutils literal"><span class="pre">search()</span></tt></a> method.</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If you want to locate a match anywhere in <em>string</em>, use
<a title="re.RegexObject.search" class="reference internal" href="#re.RegexObject.search"><tt class="xref docutils literal"><span class="pre">search()</span></tt></a> instead.</p>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">pattern</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">"o"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">pattern</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">"dog"</span><span class="p">)</span> <span class="c"># No match as "o" is not at the start of "dog".</span>
<span class="gp">>>> </span><span class="n">pattern</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">"dog"</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> <span class="c"># Match as "o" is the 2nd character of "dog".</span>
<span class="go"><_sre.SRE_Match object at ...></span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="re.RegexObject.split">
<tt class="descname">split</tt><big>(</big><em>string</em><span class="optional">[</span>, <em>maxsplit=0</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.RegexObject.split" title="Permalink to this definition">¶</a></dt>
<dd>Identical to the <a title="re.split" class="reference internal" href="#re.split"><tt class="xref docutils literal"><span class="pre">split()</span></tt></a> function, using the compiled pattern.</dd></dl>
<dl class="method">
<dt id="re.RegexObject.findall">
<tt class="descname">findall</tt><big>(</big><em>string</em><span class="optional">[</span>, <em>pos</em><span class="optional">[</span>, <em>endpos</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.RegexObject.findall" title="Permalink to this definition">¶</a></dt>
<dd>Similar to the <a title="re.findall" class="reference internal" href="#re.findall"><tt class="xref docutils literal"><span class="pre">findall()</span></tt></a> function, using the compiled pattern, but
also accepts optional <em>pos</em> and <em>endpos</em> parameters that limit the search
region like for <a title="re.match" class="reference internal" href="#re.match"><tt class="xref docutils literal"><span class="pre">match()</span></tt></a>.</dd></dl>
<dl class="method">
<dt id="re.RegexObject.finditer">
<tt class="descname">finditer</tt><big>(</big><em>string</em><span class="optional">[</span>, <em>pos</em><span class="optional">[</span>, <em>endpos</em><span class="optional">]</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.RegexObject.finditer" title="Permalink to this definition">¶</a></dt>
<dd>Similar to the <a title="re.finditer" class="reference internal" href="#re.finditer"><tt class="xref docutils literal"><span class="pre">finditer()</span></tt></a> function, using the compiled pattern, but
also accepts optional <em>pos</em> and <em>endpos</em> parameters that limit the search
region like for <a title="re.match" class="reference internal" href="#re.match"><tt class="xref docutils literal"><span class="pre">match()</span></tt></a>.</dd></dl>
<dl class="method">
<dt id="re.RegexObject.sub">
<tt class="descname">sub</tt><big>(</big><em>repl</em>, <em>string</em><span class="optional">[</span>, <em>count=0</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.RegexObject.sub" title="Permalink to this definition">¶</a></dt>
<dd>Identical to the <a title="re.sub" class="reference internal" href="#re.sub"><tt class="xref docutils literal"><span class="pre">sub()</span></tt></a> function, using the compiled pattern.</dd></dl>
<dl class="method">
<dt id="re.RegexObject.subn">
<tt class="descname">subn</tt><big>(</big><em>repl</em>, <em>string</em><span class="optional">[</span>, <em>count=0</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.RegexObject.subn" title="Permalink to this definition">¶</a></dt>
<dd>Identical to the <a title="re.subn" class="reference internal" href="#re.subn"><tt class="xref docutils literal"><span class="pre">subn()</span></tt></a> function, using the compiled pattern.</dd></dl>
<dl class="attribute">
<dt id="re.RegexObject.flags">
<tt class="descname">flags</tt><a class="headerlink" href="#re.RegexObject.flags" title="Permalink to this definition">¶</a></dt>
<dd>The flags argument used when the RE object was compiled, or <tt class="docutils literal"><span class="pre">0</span></tt> if no flags
were provided.</dd></dl>
<dl class="attribute">
<dt id="re.RegexObject.groups">
<tt class="descname">groups</tt><a class="headerlink" href="#re.RegexObject.groups" title="Permalink to this definition">¶</a></dt>
<dd>The number of capturing groups in the pattern.</dd></dl>
<dl class="attribute">
<dt id="re.RegexObject.groupindex">
<tt class="descname">groupindex</tt><a class="headerlink" href="#re.RegexObject.groupindex" title="Permalink to this definition">¶</a></dt>
<dd>A dictionary mapping any symbolic group names defined by <tt class="docutils literal"><span class="pre">(?P<id>)</span></tt> to group
numbers. The dictionary is empty if no symbolic groups were used in the
pattern.</dd></dl>
<dl class="attribute">
<dt id="re.RegexObject.pattern">
<tt class="descname">pattern</tt><a class="headerlink" href="#re.RegexObject.pattern" title="Permalink to this definition">¶</a></dt>
<dd>The pattern string from which the RE object was compiled.</dd></dl>
</dd></dl>
</div>
<div class="section" id="match-objects">
<span id="id1"></span><h2>7.2.5. Match Objects<a class="headerlink" href="#match-objects" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="re.MatchObject">
<em class="property">class </em><tt class="descclassname">re.</tt><tt class="descname">MatchObject</tt><a class="headerlink" href="#re.MatchObject" title="Permalink to this definition">¶</a></dt>
<dd><p>Match Objects always have a boolean value of <a title="True" class="reference external" href="http://docs.python.org/library/constants.html#True"><tt class="xref xref docutils literal"><span class="pre">True</span></tt></a>, so that you can test
whether e.g. <a title="re.match" class="reference internal" href="#re.match"><tt class="xref docutils literal"><span class="pre">match()</span></tt></a> resulted in a match with a simple if statement. They
support the following methods and attributes:</p>
<dl class="method">
<dt id="re.MatchObject.expand">
<tt class="descname">expand</tt><big>(</big><em>template</em><big>)</big><a class="headerlink" href="#re.MatchObject.expand" title="Permalink to this definition">¶</a></dt>
<dd>Return the string obtained by doing backslash substitution on the template
string <em>template</em>, as done by the <a title="re.RegexObject.sub" class="reference internal" href="#re.RegexObject.sub"><tt class="xref docutils literal"><span class="pre">sub()</span></tt></a> method. Escapes
such as <tt class="docutils literal"><span class="pre">\n</span></tt> are converted to the appropriate characters, and numeric
backreferences (<tt class="docutils literal"><span class="pre">\1</span></tt>, <tt class="docutils literal"><span class="pre">\2</span></tt>) and named backreferences (<tt class="docutils literal"><span class="pre">\g<1></span></tt>,
<tt class="docutils literal"><span class="pre">\g<name></span></tt>) are replaced by the contents of the corresponding group.</dd></dl>
<dl class="method">
<dt id="re.MatchObject.group">
<tt class="descname">group</tt><big>(</big><span class="optional">[</span><em>group1</em>, <em>...</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.MatchObject.group" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns one or more subgroups of the match. If there is a single argument, the
result is a single string; if there are multiple arguments, the result is a
tuple with one item per argument. Without arguments, <em>group1</em> defaults to zero
(the whole match is returned). If a <em>groupN</em> argument is zero, the corresponding
return value is the entire matching string; if it is in the inclusive range
[1..99], it is the string matching the corresponding parenthesized group. If a
group number is negative or larger than the number of groups defined in the
pattern, an <a title="exceptions.IndexError" class="reference external" href="http://docs.python.org/library/exceptions.html#exceptions.IndexError"><tt class="xref docutils literal"><span class="pre">IndexError</span></tt></a> exception is raised. If a group is contained in a
part of the pattern that did not match, the corresponding result is <tt class="xref docutils literal"><span class="pre">None</span></tt>.
If a group is contained in a part of the pattern that matched multiple times,
the last match is returned.</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">r"(\w+) (\w+)"</span><span class="p">,</span> <span class="s">"Isaac Newton, physicist"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">0</span><span class="p">)</span> <span class="c"># The entire match</span>
<span class="go">'Isaac Newton'</span>
<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> <span class="c"># The first parenthesized subgroup.</span>
<span class="go">'Isaac'</span>
<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span> <span class="c"># The second parenthesized subgroup.</span>
<span class="go">'Newton'</span>
<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">group</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="c"># Multiple arguments give us a tuple.</span>
<span class="go">('Isaac', 'Newton')</span>
</pre></div>
</div>
<p>If the regular expression uses the <tt class="docutils literal"><span class="pre">(?P<name>...)</span></tt> syntax, the <em>groupN</em>
arguments may also be strings identifying groups by their group name. If a
string argument is not used as a group name in the pattern, an <a title="exceptions.IndexError" class="reference external" href="http://docs.python.org/library/exceptions.html#exceptions.IndexError"><tt class="xref docutils literal"><span class="pre">IndexError</span></tt></a>
exception is raised.</p>
<p>A moderately complicated example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">r"(?P<first_name>\w+) (?P<last_name>\w+)"</span><span class="p">,</span> <span class="s">"Malcolm Reynolds"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s">'first_name'</span><span class="p">)</span>
<span class="go">'Malcolm'</span>
<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s">'last_name'</span><span class="p">)</span>
<span class="go">'Reynolds'</span>
</pre></div>
</div>
<p>Named groups can also be referred to by their index:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>
<span class="go">'Malcolm'</span>
<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
<span class="go">'Reynolds'</span>
</pre></div>
</div>
<p>If a group matches multiple times, only the last match is accessible:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">r"(..)+"</span><span class="p">,</span> <span class="s">"a1b2c3"</span><span class="p">)</span> <span class="c"># Matches 3 times.</span>
<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> <span class="c"># Returns only the last match.</span>
<span class="go">'c3'</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="re.MatchObject.groups">
<tt class="descname">groups</tt><big>(</big><span class="optional">[</span><em>default</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.MatchObject.groups" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a tuple containing all the subgroups of the match, from 1 up to however
many groups are in the pattern. The <em>default</em> argument is used for groups that
did not participate in the match; it defaults to <tt class="xref docutils literal"><span class="pre">None</span></tt>. (Incompatibility
note: in the original Python 1.5 release, if the tuple was one element long, a
string would be returned instead. In later versions (from 1.5.1 on), a
singleton tuple is returned in such cases.)</p>
<p>For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">r"(\d+)\.(\d+)"</span><span class="p">,</span> <span class="s">"24.1632"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">groups</span><span class="p">()</span>
<span class="go">('24', '1632')</span>
</pre></div>
</div>
<p>If we make the decimal place and everything after it optional, not all groups
might participate in the match. These groups will default to <tt class="xref docutils literal"><span class="pre">None</span></tt> unless
the <em>default</em> argument is given:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">r"(\d+)\.?(\d+)?"</span><span class="p">,</span> <span class="s">"24"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">groups</span><span class="p">()</span> <span class="c"># Second group defaults to None.</span>
<span class="go">('24', None)</span>
<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">groups</span><span class="p">(</span><span class="s">'0'</span><span class="p">)</span> <span class="c"># Now, the second group defaults to '0'.</span>
<span class="go">('24', '0')</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="re.MatchObject.groupdict">
<tt class="descname">groupdict</tt><big>(</big><span class="optional">[</span><em>default</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.MatchObject.groupdict" title="Permalink to this definition">¶</a></dt>
<dd><p>Return a dictionary containing all the <em>named</em> subgroups of the match, keyed by
the subgroup name. The <em>default</em> argument is used for groups that did not
participate in the match; it defaults to <tt class="xref docutils literal"><span class="pre">None</span></tt>. For example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">r"(?P<first_name>\w+) (?P<last_name>\w+)"</span><span class="p">,</span> <span class="s">"Malcolm Reynolds"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">m</span><span class="o">.</span><span class="n">groupdict</span><span class="p">()</span>
<span class="go">{'first_name': 'Malcolm', 'last_name': 'Reynolds'}</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="re.MatchObject.start">
<tt class="descname">start</tt><big>(</big><span class="optional">[</span><em>group</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.MatchObject.start" title="Permalink to this definition">¶</a></dt>
<dt id="re.MatchObject.end">
<tt class="descname">end</tt><big>(</big><span class="optional">[</span><em>group</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.MatchObject.end" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the indices of the start and end of the substring matched by <em>group</em>;
<em>group</em> defaults to zero (meaning the whole matched substring). Return <tt class="docutils literal"><span class="pre">-1</span></tt> if
<em>group</em> exists but did not contribute to the match. For a match object <em>m</em>, and
a group <em>g</em> that did contribute to the match, the substring matched by group <em>g</em>
(equivalent to <tt class="docutils literal"><span class="pre">m.group(g)</span></tt>) is</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">m</span><span class="o">.</span><span class="n">string</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">start</span><span class="p">(</span><span class="n">g</span><span class="p">):</span><span class="n">m</span><span class="o">.</span><span class="n">end</span><span class="p">(</span><span class="n">g</span><span class="p">)]</span>
</pre></div>
</div>
<p>Note that <tt class="docutils literal"><span class="pre">m.start(group)</span></tt> will equal <tt class="docutils literal"><span class="pre">m.end(group)</span></tt> if <em>group</em> matched a
null string. For example, after <tt class="docutils literal"><span class="pre">m</span> <span class="pre">=</span> <span class="pre">re.search('b(c?)',</span> <span class="pre">'cba')</span></tt>,
<tt class="docutils literal"><span class="pre">m.start(0)</span></tt> is 1, <tt class="docutils literal"><span class="pre">m.end(0)</span></tt> is 2, <tt class="docutils literal"><span class="pre">m.start(1)</span></tt> and <tt class="docutils literal"><span class="pre">m.end(1)</span></tt> are both
2, and <tt class="docutils literal"><span class="pre">m.start(2)</span></tt> raises an <a title="exceptions.IndexError" class="reference external" href="http://docs.python.org/library/exceptions.html#exceptions.IndexError"><tt class="xref docutils literal"><span class="pre">IndexError</span></tt></a> exception.</p>
<p>An example that will remove <em>remove_this</em> from email addresses:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">email</span> <span class="o">=</span> <span class="s">"tony@tiremove_thisger.net"</span>
<span class="gp">>>> </span><span class="n">m</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="s">"remove_this"</span><span class="p">,</span> <span class="n">email</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">email</span><span class="p">[:</span><span class="n">m</span><span class="o">.</span><span class="n">start</span><span class="p">()]</span> <span class="o">+</span> <span class="n">email</span><span class="p">[</span><span class="n">m</span><span class="o">.</span><span class="n">end</span><span class="p">():]</span>
<span class="go">'[email protected]'</span>
</pre></div>
</div>
</dd></dl>
<dl class="method">
<dt id="re.MatchObject.span">
<tt class="descname">span</tt><big>(</big><span class="optional">[</span><em>group</em><span class="optional">]</span><big>)</big><a class="headerlink" href="#re.MatchObject.span" title="Permalink to this definition">¶</a></dt>
<dd>For <a title="re.MatchObject" class="reference internal" href="#re.MatchObject"><tt class="xref docutils literal"><span class="pre">MatchObject</span></tt></a> <em>m</em>, return the 2-tuple <tt class="docutils literal"><span class="pre">(m.start(group),</span>
<span class="pre">m.end(group))</span></tt>. Note that if <em>group</em> did not contribute to the match, this is
<tt class="docutils literal"><span class="pre">(-1,</span> <span class="pre">-1)</span></tt>. <em>group</em> defaults to zero, the entire match.</dd></dl>
<dl class="attribute">
<dt id="re.MatchObject.pos">
<tt class="descname">pos</tt><a class="headerlink" href="#re.MatchObject.pos" title="Permalink to this definition">¶</a></dt>
<dd>The value of <em>pos</em> which was passed to the <a title="re.RegexObject.search" class="reference internal" href="#re.RegexObject.search"><tt class="xref docutils literal"><span class="pre">search()</span></tt></a> or
<a title="re.RegexObject.match" class="reference internal" href="#re.RegexObject.match"><tt class="xref docutils literal"><span class="pre">match()</span></tt></a> method of the <a title="re.RegexObject" class="reference internal" href="#re.RegexObject"><tt class="xref docutils literal"><span class="pre">RegexObject</span></tt></a>. This is the
index into the string at which the RE engine started looking for a match.</dd></dl>
<dl class="attribute">
<dt id="re.MatchObject.endpos">
<tt class="descname">endpos</tt><a class="headerlink" href="#re.MatchObject.endpos" title="Permalink to this definition">¶</a></dt>
<dd>The value of <em>endpos</em> which was passed to the <a title="re.RegexObject.search" class="reference internal" href="#re.RegexObject.search"><tt class="xref docutils literal"><span class="pre">search()</span></tt></a> or
<a title="re.RegexObject.match" class="reference internal" href="#re.RegexObject.match"><tt class="xref docutils literal"><span class="pre">match()</span></tt></a> method of the <a title="re.RegexObject" class="reference internal" href="#re.RegexObject"><tt class="xref docutils literal"><span class="pre">RegexObject</span></tt></a>. This is the
index into the string beyond which the RE engine will not go.</dd></dl>
<dl class="attribute">
<dt id="re.MatchObject.lastindex">
<tt class="descname">lastindex</tt><a class="headerlink" href="#re.MatchObject.lastindex" title="Permalink to this definition">¶</a></dt>
<dd>The integer index of the last matched capturing group, or <tt class="xref docutils literal"><span class="pre">None</span></tt> if no group
was matched at all. For example, the expressions <tt class="docutils literal"><span class="pre">(a)b</span></tt>, <tt class="docutils literal"><span class="pre">((a)(b))</span></tt>, and
<tt class="docutils literal"><span class="pre">((ab))</span></tt> will have <tt class="docutils literal"><span class="pre">lastindex</span> <span class="pre">==</span> <span class="pre">1</span></tt> if applied to the string <tt class="docutils literal"><span class="pre">'ab'</span></tt>, while
the expression <tt class="docutils literal"><span class="pre">(a)(b)</span></tt> will have <tt class="docutils literal"><span class="pre">lastindex</span> <span class="pre">==</span> <span class="pre">2</span></tt>, if applied to the same
string.</dd></dl>
<dl class="attribute">
<dt id="re.MatchObject.lastgroup">
<tt class="descname">lastgroup</tt><a class="headerlink" href="#re.MatchObject.lastgroup" title="Permalink to this definition">¶</a></dt>
<dd>The name of the last matched capturing group, or <tt class="xref docutils literal"><span class="pre">None</span></tt> if the group didn’t
have a name, or if no group was matched at all.</dd></dl>
<dl class="attribute">
<dt id="re.MatchObject.re">
<tt class="descname">re</tt><a class="headerlink" href="#re.MatchObject.re" title="Permalink to this definition">¶</a></dt>
<dd>The regular expression object whose <a title="re.RegexObject.match" class="reference internal" href="#re.RegexObject.match"><tt class="xref docutils literal"><span class="pre">match()</span></tt></a> or
<a title="re.RegexObject.search" class="reference internal" href="#re.RegexObject.search"><tt class="xref docutils literal"><span class="pre">search()</span></tt></a> method produced this <a title="re.MatchObject" class="reference internal" href="#re.MatchObject"><tt class="xref docutils literal"><span class="pre">MatchObject</span></tt></a>
instance.</dd></dl>
<dl class="attribute">
<dt id="re.MatchObject.string">
<tt class="descname">string</tt><a class="headerlink" href="#re.MatchObject.string" title="Permalink to this definition">¶</a></dt>
<dd>The string passed to <a title="re.RegexObject.match" class="reference internal" href="#re.RegexObject.match"><tt class="xref docutils literal"><span class="pre">match()</span></tt></a> or
<a title="re.RegexObject.search" class="reference internal" href="#re.RegexObject.search"><tt class="xref docutils literal"><span class="pre">search()</span></tt></a>.</dd></dl>
</dd></dl>
</div>
<div class="section" id="examples">
<h2>7.2.6. Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
<div class="section" id="checking-for-a-pair">
<h3>7.2.6.1. Checking For a Pair<a class="headerlink" href="#checking-for-a-pair" title="Permalink to this headline">¶</a></h3>
<p>In this example, we’ll use the following helper function to display match
objects a little more gracefully:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="k">def</span> <span class="nf">displaymatch</span><span class="p">(</span><span class="n">match</span><span class="p">):</span>
<span class="k">if</span> <span class="n">match</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">None</span>
<span class="k">return</span> <span class="s">'<Match: </span><span class="si">%r</span><span class="s">, groups=</span><span class="si">%r</span><span class="s">>'</span> <span class="o">%</span> <span class="p">(</span><span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(),</span> <span class="n">match</span><span class="o">.</span><span class="n">groups</span><span class="p">())</span>
</pre></div>
</div>
<p>Suppose you are writing a poker program where a player’s hand is represented as
a 5-character string with each character representing a card, “a” for ace, “k”
for king, “q” for queen, j for jack, “0” for 10, and “1” through “9”
representing the card with that value.</p>
<p>To see if a given string is a valid hand, one could do the following:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">>>> </span><span class="n">valid</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s">r"[0-9akqj]{5}$"</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">displaymatch</span><span class="p">(</span><span class="n">valid</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="s">"ak05q"</span><span class="p">))</span> <span class="c"># Valid.</span>
<span class="go">"<Match: 'ak05q', groups=()>"</span>