Skip to content

Commit 16e43f5

Browse files
committed
Deployed 0c41b9f to dev with MkDocs 1.6.0 and mike 2.1.2
1 parent bc05f8f commit 16e43f5

107 files changed

Lines changed: 14486 additions & 574 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

dev/404.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@
1414

1515

1616
<link rel="icon" href="/pyvalidators/dev/assets/icons/favicon.svg">
17-
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.27">
17+
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.30">
1818

1919

2020

2121
<title>validators</title>
2222

2323

2424

25-
<link rel="stylesheet" href="/pyvalidators/dev/assets/stylesheets/main.6543a935.min.css">
25+
<link rel="stylesheet" href="/pyvalidators/dev/assets/stylesheets/main.3cba04c6.min.css">
2626

2727

2828
<link rel="stylesheet" href="/pyvalidators/dev/assets/stylesheets/palette.06af60db.min.css">
@@ -187,7 +187,7 @@
187187
<a href="https://github.com/python-validators/validators/" title="Go to repository" class="md-source" data-md-component="source">
188188
<div class="md-source__icon md-icon">
189189

190-
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
190+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
191191
</div>
192192
<div class="md-source__repository">
193193
validators/validators
@@ -233,7 +233,7 @@
233233
<a href="https://github.com/python-validators/validators/" title="Go to repository" class="md-source" data-md-component="source">
234234
<div class="md-source__icon md-icon">
235235

236-
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
236+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
237237
</div>
238238
<div class="md-source__repository">
239239
validators/validators
@@ -812,7 +812,7 @@ <h1>404 - Not found</h1>
812812

813813

814814
<a href="https://github.com/python-validators" target="_blank" rel="noopener" title="github.com" class="md-social__link">
815-
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
815+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
816816
</a>
817817

818818

@@ -823,7 +823,7 @@ <h1>404 - Not found</h1>
823823

824824

825825
<a href="https://pypi.org/project/validators" target="_blank" rel="noopener" title="pypi.org" class="md-social__link">
826-
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.8 200.5c-7.7-30.9-22.3-54.2-53.4-54.2h-40.1v47.4c0 36.8-31.2 67.8-66.8 67.8H172.7c-29.2 0-53.4 25-53.4 54.3v101.8c0 29 25.2 46 53.4 54.3 33.8 9.9 66.3 11.7 106.8 0 26.9-7.8 53.4-23.5 53.4-54.3v-40.7H226.2v-13.6h160.2c31.1 0 42.6-21.7 53.4-54.2 11.2-33.5 10.7-65.7 0-108.6zM286.2 404c11.1 0 20.1 9.1 20.1 20.3 0 11.3-9 20.4-20.1 20.4-11 0-20.1-9.2-20.1-20.4.1-11.3 9.1-20.3 20.1-20.3zM167.8 248.1h106.8c29.7 0 53.4-24.5 53.4-54.3V91.9c0-29-24.4-50.7-53.4-55.6-35.8-5.9-74.7-5.6-106.8.1-45.2 8-53.4 24.7-53.4 55.6v40.7h106.9v13.6h-147c-31.1 0-58.3 18.7-66.8 54.2-9.8 40.7-10.2 66.1 0 108.6 7.6 31.6 25.7 54.2 56.8 54.2H101v-48.8c0-35.3 30.5-66.4 66.8-66.4zm-6.7-142.6c-11.1 0-20.1-9.1-20.1-20.3.1-11.3 9-20.4 20.1-20.4 11 0 20.1 9.2 20.1 20.4s-9 20.3-20.1 20.3z"/></svg>
826+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.6.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.8 200.5c-7.7-30.9-22.3-54.2-53.4-54.2h-40.1v47.4c0 36.8-31.2 67.8-66.8 67.8H172.7c-29.2 0-53.4 25-53.4 54.3v101.8c0 29 25.2 46 53.4 54.3 33.8 9.9 66.3 11.7 106.8 0 26.9-7.8 53.4-23.5 53.4-54.3v-40.7H226.2v-13.6h160.2c31.1 0 42.6-21.7 53.4-54.2 11.2-33.5 10.7-65.7 0-108.6zM286.2 404c11.1 0 20.1 9.1 20.1 20.3 0 11.3-9 20.4-20.1 20.4-11 0-20.1-9.2-20.1-20.4.1-11.3 9.1-20.3 20.1-20.3zM167.8 248.1h106.8c29.7 0 53.4-24.5 53.4-54.3V91.9c0-29-24.4-50.7-53.4-55.6-35.8-5.9-74.7-5.6-106.8.1-45.2 8-53.4 24.7-53.4 55.6v40.7h106.9v13.6h-147c-31.1 0-58.3 18.7-66.8 54.2-9.8 40.7-10.2 66.1 0 108.6 7.6 31.6 25.7 54.2 56.8 54.2H101v-48.8c0-35.3 30.5-66.4 66.8-66.4zm-6.7-142.6c-11.1 0-20.1-9.1-20.1-20.3.1-11.3 9-20.4 20.1-20.4 11 0 20.1 9.2 20.1 20.4s-9 20.3-20.1 20.3z"/></svg>
827827
</a>
828828

829829
</div>
@@ -841,7 +841,7 @@ <h1>404 - Not found</h1>
841841
<script id="__config" type="application/json">{"base": "/pyvalidators/dev", "features": ["content.code.copy"], "search": "/pyvalidators/dev/assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"default": "stable", "provider": "mike"}}</script>
842842

843843

844-
<script src="/pyvalidators/dev/assets/javascripts/bundle.ad660dcc.min.js"></script>
844+
<script src="/pyvalidators/dev/assets/javascripts/bundle.fe8b6f2b.min.js"></script>
845845

846846

847847
</body>

dev/_build/man/validators.1

Lines changed: 34 additions & 150 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "VALIDATORS" "1" "Jul 08, 2024" "0.31.0" "validators"
30+
.TH "VALIDATORS" "1" "Jun 17, 2024" "0.28.3" "validators"
3131
.SH NAME
3232
validators \- Python Data Validation for Humans™
3333
.sp
@@ -215,6 +215,39 @@ If neither \fImin_val\fP nor \fImax_val\fP is provided, result will always be \f
215215
.UNINDENT
216216
.UNINDENT
217217
.UNINDENT
218+
.SS btc_address
219+
.INDENT 0.0
220+
.TP
221+
.B validators.btc_address.btc_address(value: str, /)
222+
Return whether or not given value is a valid bitcoin address.
223+
.sp
224+
Full validation is implemented for P2PKH and P2SH addresses.
225+
For segwit addresses a regexp is used to provide a reasonable
226+
estimate on whether the address is valid.
227+
.sp
228+
Examples
229+
.sp
230+
.nf
231+
.ft C
232+
>>> btc_address(\(aq3Cwgr2g7vsi1bXDUkpEnVoRLA9w4FZfC69\(aq)
233+
# Output: True
234+
>>> btc_address(\(aq1BvBMsEYstWetqTFn5Au4m4GFg7xJaNVN2\(aq)
235+
# Output: ValidationError(func=btc_address, args=...)
236+
.ft P
237+
.fi
238+
.INDENT 7.0
239+
.TP
240+
.B Parameters
241+
\fBvalue\fP \-\- Bitcoin address string to validate.
242+
.TP
243+
.B Returns
244+
If \fIvalue\fP is a valid bitcoin address.
245+
(ValidationError): If \fIvalue\fP is an invalid bitcoin address.
246+
.TP
247+
.B Return type
248+
(Literal[True])
249+
.UNINDENT
250+
.UNINDENT
218251
.SS card
219252
.INDENT 0.0
220253
.TP
@@ -589,99 +622,6 @@ If \fIvalue\fP is a valid cron string.
589622
(Literal[True])
590623
.UNINDENT
591624
.UNINDENT
592-
.SS crypto_addresses
593-
.INDENT 0.0
594-
.TP
595-
.B validators.crypto_addresses.btc_address(value: str, /)
596-
Return whether or not given value is a valid bitcoin address.
597-
.sp
598-
Full validation is implemented for P2PKH and P2SH addresses.
599-
For segwit addresses a regexp is used to provide a reasonable
600-
estimate on whether the address is valid.
601-
.sp
602-
Examples
603-
.sp
604-
.nf
605-
.ft C
606-
>>> btc_address(\(aq3Cwgr2g7vsi1bXDUkpEnVoRLA9w4FZfC69\(aq)
607-
# Output: True
608-
>>> btc_address(\(aq1BvBMsEYstWetqTFn5Au4m4GFg7xJaNVN2\(aq)
609-
# Output: ValidationError(func=btc_address, args=...)
610-
.ft P
611-
.fi
612-
.INDENT 7.0
613-
.TP
614-
.B Parameters
615-
\fBvalue\fP \-\- Bitcoin address string to validate.
616-
.TP
617-
.B Returns
618-
If \fIvalue\fP is a valid bitcoin address.
619-
(ValidationError): If \fIvalue\fP is an invalid bitcoin address.
620-
.TP
621-
.B Return type
622-
(Literal[True])
623-
.UNINDENT
624-
.UNINDENT
625-
.INDENT 0.0
626-
.TP
627-
.B validators.crypto_addresses.eth_address(value: str, /)
628-
Return whether or not given value is a valid ethereum address.
629-
.sp
630-
Full validation is implemented for ERC20 addresses.
631-
.sp
632-
Examples
633-
.sp
634-
.nf
635-
.ft C
636-
>>> eth_address(\(aq0x9cc14ba4f9f68ca159ea4ebf2c292a808aaeb598\(aq)
637-
# Output: True
638-
>>> eth_address(\(aq0x8Ba1f109551bD432803012645Ac136ddd64DBa72\(aq)
639-
# Output: ValidationError(func=eth_address, args=...)
640-
.ft P
641-
.fi
642-
.INDENT 7.0
643-
.TP
644-
.B Parameters
645-
\fBvalue\fP \-\- Ethereum address string to validate.
646-
.TP
647-
.B Returns
648-
If \fIvalue\fP is a valid ethereum address.
649-
(ValidationError): If \fIvalue\fP is an invalid ethereum address.
650-
.TP
651-
.B Return type
652-
(Literal[True])
653-
.UNINDENT
654-
.UNINDENT
655-
.INDENT 0.0
656-
.TP
657-
.B validators.crypto_addresses.trx_address(value: str, /)
658-
Return whether or not given value is a valid tron address.
659-
.sp
660-
Full validation is implemented for TRC20 tron addresses.
661-
.sp
662-
Examples
663-
.sp
664-
.nf
665-
.ft C
666-
>>> trx_address(\(aqTLjfbTbpZYDQ4EoA4N5CLNgGjfbF8ZWz38\(aq)
667-
# Output: True
668-
>>> trx_address(\(aqTR2G7Rm4vFqF8EpY4U5xdLdQ7XgJ2U8Vd\(aq)
669-
# Output: ValidationError(func=trx_address, args=...)
670-
.ft P
671-
.fi
672-
.INDENT 7.0
673-
.TP
674-
.B Parameters
675-
\fBvalue\fP \-\- Tron address string to validate.
676-
.TP
677-
.B Returns
678-
If \fIvalue\fP is a valid tron address.
679-
(ValidationError): If \fIvalue\fP is an invalid tron address.
680-
.TP
681-
.B Return type
682-
(Literal[True])
683-
.UNINDENT
684-
.UNINDENT
685625
.SS domain
686626
.INDENT 0.0
687627
.TP
@@ -784,62 +724,6 @@ If \fIvalue\fP is a valid eMail.
784724
.SS encoding
785725
.INDENT 0.0
786726
.TP
787-
.B validators.encoding.base16(value: str, /)
788-
Return whether or not given value is a valid base16 encoding.
789-
.sp
790-
Examples
791-
.sp
792-
.nf
793-
.ft C
794-
>>> base16(\(aqa3f4b2\(aq)
795-
# Output: True
796-
>>> base16(\(aqa3f4Z1\(aq)
797-
# Output: ValidationError(func=base16, args={\(aqvalue\(aq: \(aqa3f4Z1\(aq})
798-
.ft P
799-
.fi
800-
.INDENT 7.0
801-
.TP
802-
.B Parameters
803-
\fBvalue\fP \-\- base16 string to validate.
804-
.TP
805-
.B Returns
806-
If \fIvalue\fP is a valid base16 encoding.
807-
(ValidationError): If \fIvalue\fP is an invalid base16 encoding.
808-
.TP
809-
.B Return type
810-
(Literal[True])
811-
.UNINDENT
812-
.UNINDENT
813-
.INDENT 0.0
814-
.TP
815-
.B validators.encoding.base32(value: str, /)
816-
Return whether or not given value is a valid base32 encoding.
817-
.sp
818-
Examples
819-
.sp
820-
.nf
821-
.ft C
822-
>>> base32(\(aqMFZWIZLTOQ======\(aq)
823-
# Output: True
824-
>>> base32(\(aqMfZW3zLT9Q======\(aq)
825-
# Output: ValidationError(func=base32, args={\(aqvalue\(aq: \(aqMfZW3zLT9Q======\(aq})
826-
.ft P
827-
.fi
828-
.INDENT 7.0
829-
.TP
830-
.B Parameters
831-
\fBvalue\fP \-\- base32 string to validate.
832-
.TP
833-
.B Returns
834-
If \fIvalue\fP is a valid base32 encoding.
835-
(ValidationError): If \fIvalue\fP is an invalid base32 encoding.
836-
.TP
837-
.B Return type
838-
(Literal[True])
839-
.UNINDENT
840-
.UNINDENT
841-
.INDENT 0.0
842-
.TP
843727
.B validators.encoding.base58(value: str, /)
844728
Return whether or not given value is a valid base58 encoding.
845729
.sp
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
between
2+
-------
3+
4+
.. module:: validators.between
5+
.. autofunction:: between
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
btc_address
2+
-----------
3+
4+
.. module:: validators.btc_address
5+
.. autofunction:: btc_address
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
card
2+
----
3+
4+
.. module:: validators.card
5+
.. autofunction:: amex
6+
.. autofunction:: card_number
7+
.. autofunction:: diners
8+
.. autofunction:: discover
9+
.. autofunction:: jcb
10+
.. autofunction:: mastercard
11+
.. autofunction:: unionpay
12+
.. autofunction:: visa
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
country
2+
-------
3+
4+
.. module:: validators.country
5+
.. autofunction:: calling_code
6+
.. autofunction:: country_code
7+
.. autofunction:: currency
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
cron
2+
----
3+
4+
.. module:: validators.cron
5+
.. autofunction:: cron
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
domain
2+
------
3+
4+
.. module:: validators.domain
5+
.. autofunction:: domain
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
email
2+
-----
3+
4+
.. module:: validators.email
5+
.. autofunction:: email
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
encoding
2+
--------
3+
4+
.. module:: validators.encoding
5+
.. autofunction:: base58
6+
.. autofunction:: base64

0 commit comments

Comments
 (0)