[Python-checkins] CVS: python/dist/src/Lib re.py,1.40,1.41 sre.py,1.34,1.35 sre_compile.py,1.40,1.41 sre_constants.py,1.29,1.30 sre_parse.py,1.46,1.47

[Fred L. Drake]

Update of /cvsroot/python/python/dist/src/Lib
In directory usw-pr-cvs1:/tmp/cvs-serv29424

Modified Files:
	re.py sre.py sre_compile.py sre_constants.py sre_parse.py 
Log Message:
Added docstrings by Neal Norwitz.  This closes SF bug #450980.


Index: re.py
===================================================================
RCS file: /cvsroot/python/python/dist/src/Lib/re.py,v
retrieving revision 1.40
retrieving revision 1.41
diff -C2 -d -r1.40 -r1.41
*** re.py	2001/02/15 22:15:13	1.40
--- re.py	2001/09/04 19:10:20	1.41
***************
*** 1,5 ****
! #
! # Minimal "re" compatibility wrapper
! #
  # If your regexps don't work well under 2.0b1, you can switch
  # to the old engine ("pre") down below.
--- 1,4 ----
! """Minimal "re" compatibility wrapper"""
! 
  # If your regexps don't work well under 2.0b1, you can switch
  # to the old engine ("pre") down below.

Index: sre.py
===================================================================
RCS file: /cvsroot/python/python/dist/src/Lib/sre.py,v
retrieving revision 1.34
retrieving revision 1.35
diff -C2 -d -r1.34 -r1.35
*** sre.py	2001/08/10 14:56:54	1.34
--- sre.py	2001/09/04 19:10:20	1.35
***************
*** 15,18 ****
--- 15,99 ----
  #
  
+ """Support for regular expressions (RE).
+ 
+ This module provides regular expression matching operations similar to
+ those found in Perl. It's 8-bit clean: the strings being processed may
+ contain both null bytes and characters whose high bit is set. Regular
+ expression pattern strings may not contain null bytes, but can specify
+ the null byte using the \\number notation. Characters with the high
+ bit set may be included.
+ 
+ Regular expressions can contain both special and ordinary
+ characters. Most ordinary characters, like "A", "a", or "0", are the
+ simplest regular expressions; they simply match themselves. You can
+ concatenate ordinary characters, so last matches the string 'last'.
+ 
+ The special characters are:
+     "."      Matches any character except a newline.
+     "^"      Matches the start of the string.
+     "$"      Matches the end of the string.
+     "*"      Matches 0 or more (greedy) repetitions of the preceding RE.
+              Greedy means that it will match as many repetitions as possible.
+     "+"      Matches 1 or more (greedy) repetitions of the preceding RE.
+     "?"      Matches 0 or 1 (greedy) of the preceding RE.
+     *?,+?,?? Non-greedy versions of the previous three special characters.
+     {m,n}    Matches from m to n repetitions of the preceding RE.
+     {m,n}?   Non-greedy version of the above.
+     "\\"      Either escapes special characters or signals a special sequence.
+     []       Indicates a set of characters.
+              A "^" as the first character indicates a complementing set.
+     "|"      A|B, creates an RE that will match either A or B.
+     (...)    Matches the RE inside the parentheses.
+              The contents can be retrieved or matched later in the string.
+     (?iLmsx) Set the I, L, M, S, or X flag for the RE.
+     (?:...)  Non-grouping version of regular parentheses.
+     (?P<name>...) The substring matched by the group is accessible by name.
+     (?P=name)     Matches the text matched earlier by the group named name.
+     (?#...)  A comment; ignored.
+     (?=...)  Matches if ... matches next, but doesn't consume the string.
+     (?!...)  Matches if ... doesn't match next.
+ 
+ The special sequences consist of "\\" 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.
+     \\number  Matches the contents of the group of the same number.
+     \\A       Matches only at the start of the string.
+     \\Z       Matches only at the end of the string.
+     \\b       Matches the empty string, but only at the start or end of a word.
+     \\B       Matches the empty string, but not at the start or end of a word.
+     \\d       Matches any decimal digit; equivalent to the set [0-9].
+     \\D       Matches any non-digit character; equivalent to the set [^0-9].
+     \\s       Matches any whitespace character; equivalent to [ \\t\\n\\r\\f\\v].
+     \\S       Matches any non-whitespace character; equiv. to [^ \\t\\n\\r\\f\\v].
+     \\w       Matches any alphanumeric character; equivalent to [a-zA-Z0-9_].
+              With LOCALE, it will match the set [0-9_] plus characters defined
+              as letters for the current locale.
+     \\W       Matches the complement of \\w.
+     \\\\       Matches a literal backslash.
+ 
+ This module exports the following functions:
+     match    Match a regular expression pattern to the beginning of a string.
+     search   Search a string for the presence of a pattern.
+     sub      Substitute occurrences of a pattern found in a string.
+     subn     Same as sub, but also return the number of substitutions made.
+     split    Split a string by the occurrences of a pattern.
+     findall  Find all occurrences of a pattern in a string.
+     compile  Compile a pattern into a RegexObject.
+     purge    Clear the regular expression cache.
+     template Compile a template pattern, returning a pattern object.
+     escape   Backslash all non-alphanumerics in a string.
+ 
+ Some of the functions in this module takes flags as optional parameters:
+     I  IGNORECASE  Perform case-insensitive matching.
+     L  LOCALE      Make \w, \W, \b, \B, dependent on the current locale.
+     M  MULTILINE   "^" matches the beginning of lines as well as the string.
+                    "$" matches the end of lines as well as the string.
+     S  DOTALL      "." matches any character at all, including the newline.
+     X  VERBOSE     Ignore whitespace and comments for nicer looking RE's.
+     U  UNICODE     Use unicode locale.
+ 
+ This module also defines an exception 'error'.
+ 
+ """
  import sre_compile
  import sre_parse

Index: sre_compile.py
===================================================================
RCS file: /cvsroot/python/python/dist/src/Lib/sre_compile.py,v
retrieving revision 1.40
retrieving revision 1.41
diff -C2 -d -r1.40 -r1.41
*** sre_compile.py	2001/07/21 01:41:30	1.40
--- sre_compile.py	2001/09/04 19:10:20	1.41
***************
*** 9,12 ****
--- 9,14 ----
  #
  
+ """Internal support module for sre"""
+ 
  import _sre,sys
  

Index: sre_constants.py
===================================================================
RCS file: /cvsroot/python/python/dist/src/Lib/sre_constants.py,v
retrieving revision 1.29
retrieving revision 1.30
diff -C2 -d -r1.29 -r1.30
*** sre_constants.py	2001/07/02 16:58:38	1.29
--- sre_constants.py	2001/09/04 19:10:20	1.30
***************
*** 10,13 ****
--- 10,15 ----
  #
  
+ """Internal support module for sre"""
+ 
  # update when constants are added or removed
  

Index: sre_parse.py
===================================================================
RCS file: /cvsroot/python/python/dist/src/Lib/sre_parse.py,v
retrieving revision 1.46
retrieving revision 1.47
diff -C2 -d -r1.46 -r1.47
*** sre_parse.py	2001/03/22 15:50:10	1.46
--- sre_parse.py	2001/09/04 19:10:20	1.47
***************
*** 9,12 ****
--- 9,14 ----
  #
  
+ """Internal support module for sre"""
+ 
  # XXX: show string offset and offending character for all errors