Python Regex Object and Methods

By Xah Lee. Date: . Last updated: .

Compile Regex Object

re.compile(pattern) → Compiles regex pattern into a object. A regex object can be used by regex object methods. For example,…).

re.compile(pattern,flags) → use flags. [see Python Regex Flags]

The use of regex object is similar to re module functions. For example, the following 2 have the same result.

Creating a regex object is useful when you need to use the same pattern on many strings. This is more efficient because python doesn't have to compile the regex pattern internally each time.

The following detail regex object methods. Most of them have the same syntax as regex functions, but some are more flexible with optional parameters. [see Python Regex Functions]

Regex Object Methods

search is equivalent to, string). [see Python Regex Functions], startpos) → match on substring starting at startpos., startpos, endpos) → end at endpos.

The following have the same result:


RegexObj.match(string) → same result as re.match(pattern, string). [see Python Regex Functions]

RegexObj.match(string, startpos) → match on substring starting at startpos.

RegexObj.match(string, startpos, endpos) → end at endpos


RegexObj.split(string, …) → same result as re.split(pattern, string, …). [see Python Regex Functions]


RegexObj.findall(string) → same result as re.findall(pattern, string)

RegexObj.findall(string, startpos) → match on substring starting at startpos.

RegexObj.findall(string, startpos, endpos) → end at endpos.


RegexObj.finditer(string) → same result as re.finditer(pattern, string)

RegexObj.finditer(string, startpos) → match on substring starting at startpos.

RegexObj.finditer(string, startpos, endpos) → end at endpos.


RegexObj.sub( repl, string, …) → same result as re.sub(pattern, string, …).


RegexObj.subn( repl, string, …) → same result as re.subn(pattern, string, …)

Regex Attributes

The following are constants assigned by the module when a pattern object is compiled.


RegexObj.flags → The flags argument used when the regex object was compiled, or 0 if no flags were provided.

import re
patObj = re.compile(ur'\w', re.M|re.U)
print patObj.flags  # prints 40


RegexObj.groupindex → returns a dictionary. The keys are the named capture groups, the values are their order in the pattern. For example, here's a pattern of named group (?P<id>). The dictionary is empty if no symbolic groups were used in the pattern.

#-*- coding: utf-8 -*-
# python

# example of regex .groupindex

import re

# a typical image tag
# <img src="cat.jpg" alt="cat" width="123" height="456">

# a pattern to capture image tag, with named group
xx = re.compile(r'src="(?P<filename>[^"]+)" alt="(?P<alttext>[^"]+)" width="(?P<width>\d+)" height="(?P<height>\d+)"')

print xx.groupindex #  {'height': 4, 'width': 3, 'alttext': 2, 'filename': 1}


RegexObj.pattern → The pattern string from which the regex object was compiled.

If you have a question, put $5 at patreon and message me.

Python by Example

  1. Python Basics
  2. Print Version String
  3. Builtin Help
  4. Quote String
  5. String Operations
  6. String Methods
  7. Format String
  8. True, False
  9. if then else
  10. for, while, Loops
  11. List Basics
  12. Loop Thru List
  13. Map Function to List
  14. List Comprehension
  15. List Methods
  16. Dictionary
  17. Loop Thru Dict
  18. Dict Methods
  19. Function
  20. Class
  21. List Modules
  22. Write a Module
  23. Unicode 🐍


  1. Regex Basics
  2. Regex Reference

Text Processing

  1. Read/Write File
  2. Traverse Directory
  3. Manipulate Path
  4. Process Unicode
  5. Convert File Encoding
  6. Find Replace in dir
  7. Find Replace by Regex
  8. Count Word Frequency


  1. Send Email
  2. GET Web Page
  3. Web Crawler
  5. Check Page Load Size
  6. Thumbnail Generation


  1. JSON
  2. Find Script Path
  3. Get Env Var
  4. System Call
  5. Decompress Gzip
  6. Complex Numbers


  1. Sort
  2. Copy Nested List
  3. Tuple vs List
  4. Sets, Union, Intersection
  5. Closure in Python 2
  6. Decorator
  7. Append String in Loop
  8. Timing f timeit
  9. Keyword Arg Default Value Unstable