Regex
The tool to check the availability or syntax of domain, IP or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
Provides the regular expressions helpers.
Author: Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
Special thanks: https://pyfunceble.github.io/#/special-thanks
Contributors: https://pyfunceble.github.io/#/contributors
Project link: https://github.com/funilrys/PyFunceble
Project documentation: https://docs.pyfunceble.com
Project homepage: https://pyfunceble.github.io/
License: ::
Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024 Nissar Chababy
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
RegexHelper
Simplify the regex matching and usage.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
regex
|
str
|
The regex to use. |
None
|
escape_regex
|
bool
|
Escapes the given regex. |
False
|
Source code in PyFunceble/helpers/regex.py
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 |
|
regex
property
writable
Provides the current state of the :code:_regex
attribute.
get_matching_list(data)
Returns the strings which does the match the regex in the given data.
Source code in PyFunceble/helpers/regex.py
get_not_matching_list(data)
Returns the strings which does not the match the regex in the given data.
Source code in PyFunceble/helpers/regex.py
match(data, *, rematch=False, group=0, return_match=True)
Checks if the given data match the given regex string.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data
|
str
|
The data to work with. |
required |
rematch
|
bool
|
The equivalent of the $BASH_REMATCH but in Python. It's basically a list of all groups. |
False
|
group
|
int
|
The group to return when return_match is set to :code: |
0
|
return_match
|
bool
|
Return the part that match the given regex string. |
True
|
Source code in PyFunceble/helpers/regex.py
replace_match(data, replacement, *, occurences=0, multiline=False)
Replaces the string which match the regex string with the given replacement.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data
|
str
|
The data to work with. |
required |
replacement
|
str
|
The replacement of the matched regex. |
required |
occurences
|
int
|
The number of occurences to replace. .. note:: :code: |
0
|
Source code in PyFunceble/helpers/regex.py
set_regex(value)
Sets the regex to work with.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
value
|
str
|
The regex to work with. |
required |
Raises:
Type | Description |
---|---|
TypeError
|
When :code: |
Source code in PyFunceble/helpers/regex.py
split(data)
Split the reference of the given regex.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
data
|
str
|
The data to work with. |
required |