bpo-30398: Add a docstring for re.error. (#1647)

Also document that some attributes may be None.
This commit is contained in:
Serhiy Storchaka 2017-05-27 16:12:48 +03:00 committed by GitHub
parent 5becf38a03
commit 12d6b5d156
2 changed files with 14 additions and 3 deletions

View File

@ -839,15 +839,15 @@ form.
.. attribute:: pos
The index of *pattern* where compilation failed.
The index in *pattern* where compilation failed (may be ``None``).
.. attribute:: lineno
The line corresponding to *pos*.
The line corresponding to *pos* (may be ``None``).
.. attribute:: colno
The column corresponding to *pos*.
The column corresponding to *pos* (may be ``None``).
.. versionchanged:: 3.5
Added additional attributes.

View File

@ -21,6 +21,17 @@ from _sre import MAXREPEAT, MAXGROUPS
# should this really be here?
class error(Exception):
"""Exception raised for invalid regular expressions.
Attributes:
msg: The unformatted error message
pattern: The regular expression pattern
pos: The index in the pattern where compilation failed (may be None)
lineno: The line corresponding to pos (may be None)
colno: The column corresponding to pos (may be None)
"""
def __init__(self, msg, pattern=None, pos=None):
self.msg = msg
self.pattern = pattern