sphinx-toolbox Demo - Regex ¶
General utility functions.
- <{{ sig_prename_tag }} class="sig-prename descclassname"> sphinx_toolbox.utils. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> untyped_param_regex {{ sig_prename_tag }}> ¶
-
Regex to match
:param <name>: <docstring>
flags.{% if sphinx_version >= (7, 3) %}Added{% else %}New{% endif %} in version 0.8.0.
Pattern
^ : ( p a r a m | p a r a m e t e r | a r g | a r g u m e n t ) \s * ( [ A - Z a - z _ ] \w * \s * ) : \s * ( . * )
Flags
- <{{ sig_prename_tag }} class="sig-prename descclassname"> sphinx_toolbox.utils. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> typed_flag_regex {{ sig_prename_tag }}> ¶
-
Regex to match
:type <name>: <type>
flags.{% if sphinx_version >= (7, 3) %}Added{% else %}New{% endif %} in version 0.8.0.
Pattern
^ : ( p a r a m t y p e | t y p e ) \s * ( [ A - Z a - z _ ] \w * \s * ) : \s * ( . * )
Flags
^
H
e
l
l
o
\s
+
[
W
w
]
o
r
l
d
[
.
,
]
(
L
o
v
e
l
y
|
H
o
r
r
i
b
l
e
)
w
e
a
t
h
e
r
,
i
s
n
'
t
i
t
(
.
*
)
?
- <{{ sig_prename_tag }} class="sig-prename descclassname"> tests.regex_demo. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> no_flags {{ sig_prename_tag }}> ¶
-
Type:
Pattern
Compiled regular expression object.
Pattern
H e l l o \s + [ W w ] o r l d [ . , ] ( L o v e l y | H o r r i b l e ) w e a t h e r , i s n ' t i t ( . * ) ?
- <{{ sig_prename_tag }} class="sig-prename descclassname"> tests.regex_demo. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> one_flag {{ sig_prename_tag }}> ¶
-
Type:
Pattern
Compiled regular expression object.
Pattern
H e l l o \s + [ W w ] o r l d [ . , ] ( L o v e l y | H o r r i b l e ) w e a t h e r , i s n ' t i t ( . * ) ?
Flags
- <{{ sig_prename_tag }} class="sig-prename descclassname"> tests.regex_demo. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> two_flags {{ sig_prename_tag }}> ¶
-
Type:
Pattern
Compiled regular expression object.
Pattern
H e l l o \s + [ W w ] o r l d [ . , ] ( L o v e l y | H o r r i b l e ) w e a t h e r , i s n ' t i t ( . * ) ?
Flags
- <{{ sig_prename_tag }} class="sig-prename descclassname"> tests.regex_demo. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> backticks {{ sig_prename_tag }}> ¶
-
Type:
Pattern
Compiled regular expression object.
Pattern
: p y : c l a s s : ` ( [ A - Z a - z _ ] [ A - Z a - z 0 - 9 . _ ] + ) `
- <{{ sig_prename_tag }} class="sig-prename descclassname"> tests.regex_demo. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> leading_whitespace {{ sig_prename_tag }}> ¶
-
Type:
Pattern
Compiled regular expression object.
Pattern
[ ] 3 : p y : c l a s s : ` ( [ A - Z a - z _ ] [ A - Z a - z 0 - 9 . _ ] + ) `
- <{{ sig_prename_tag }} class="sig-prename descclassname"> tests.regex_demo. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> trailing_whitespace {{ sig_prename_tag }}> ¶
-
Type:
Pattern
Compiled regular expression object.
Pattern
: p y : c l a s s : ` ( [ A - Z a - z _ ] [ A - Z a - z 0 - 9 . _ ] + ) ` 3
- <{{ sig_prename_tag }} class="sig-prename descclassname"> tests.regex_demo. {{ sig_prename_tag }}> <{{ sig_prename_tag }} class="sig-name descname"> single_whitespace {{ sig_prename_tag }}> ¶
-
Type:
Pattern
Compiled regular expression object.
Pattern
[ ] : p y : c l a s s : ` ( [ A - Z a - z _ ] [ A - Z a - z 0 - 9 . _ ] + ) ` [ ]