Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding missing functions to documentation for re library #73

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Adding missing functions to documentation for re library #73

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a9bbddb
Adding missing functions
sknick May 10, 2021
54cbf05
Update README.md
sknick May 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 43 additions & 8 deletions re/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,42 +3,77 @@ re defines regular expression functions, it's intended to be a drop-in subset of

## Functions

#### `findall(pattern, text, flags=0)`
Note: All but the `compile` function can also be called as methods on a compiled regex object. When used in such a way, drop the `pattern` argument from the call.

### `compile(pattern, flags=0)`
Compile a regular expression pattern into a regular expression object, which can be used for matching using its match(), search() and other methods.

**parameters:**

| name | type | description |
|------|------|-------------|
| `pattern` | `string` | regular expression string to be compiled |
| `flags` | `int` | integer flags to control regex behaviour. reserved for future use |


### `findall(pattern, text, flags=0)`
Returns all non-overlapping matches of pattern in string, as a list of strings. The string 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.

**parameters:**

| name | type | description |
|------|------|-------------|
| `pattern` | `string` | regular expression pattern string |
| `pattern` | `string` | regular expression pattern |
| `text` | `string` | string to find within |
| `flags` | `int` | integer flags to control regex behaviour. reserved for future use |


#### `split(pattern, text, maxsplit=0, flags=0)`
### `match(pattern, string, flags=0)`
If zero or more characters at the beginning of string match the regular expression pattern, return a corresponding match object. Return None if the string does not match the pattern; note that this is different from a zero-length match. Note that even in MULTILINE mode, re.match() will only match at the beginning of the string and not at the beginning of each line. If you want to locate a match anywhere in string, use search() instead.

**parameters:**

| name | type | description |
|------|------|-------------|
| `pattern` | `string` | regular expression pattern |
| `text` | `string` | string on which to match |
| `flags` | `int` | integer flags to control regex behaviour. reserved for future use |


### `search(pattern, string, flags=0)`
Scan through string looking for the first location where the regular expression pattern produces a match, and return a corresponding match object. Return None 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.

**parameters:**

| name | type | description |
|------|------|-------------|
| `pattern` | `string` | regular expression pattern |
| `text` | `string` | string to search within |
| `flags` | `int` | integer flags to control regex behaviour. reserved for future use |


### `split(pattern, text, maxsplit=0, flags=0)`
Split text by the occurrences of pattern. If capturing parentheses are used in pattern, then the text of all groups in the pattern are also returned as part of the resulting list. If maxsplit is nonzero, at most maxsplit splits occur, and the remainder of the string is returned as the final element of the list.

**parameters:**

| name | type | description |
|------|------|-------------|
| `pattern` | `string` | regular expression pattern string |
| `pattern` | `string` | regular expression pattern |
| `text` | `string` | input string to split |
| `maxsplit` | `int` | maximum number of splits to make. default 0 splits all matches |
| `flags` | `int` | integer flags to control regex behaviour. reserved for future use |


#### `sub(pattern, repl, text, count=0, flags=0)`
### `sub(pattern, repl, text, count=0, flags=0)`
Return the string obtained by replacing the leftmost non-overlapping occurrences of pattern in string by the replacement repl. If the pattern isn’t found, string is returned unchanged. repl can be a string or a function; if it is a string, any backslash escapes in it are processed. That is, \n is converted to a single newline character, \r is converted to a carriage return, and so forth.

**parameters:**

| name | type | description |
|------|------|-------------|
| `pattern` | `string` | regular expression pattern string |
| `pattern` | `string` | regular expression pattern |
| `repl` | `string` | string to replace matches with |
| `text` | `string` | input string to replace |
| `count` | `int` | number of replacements to make, default 0 means replace all matches |
| `flags` | `int` | integer flags to control regex behaviour. reserved for future use |