Skip to content

Commit f2f7679

Browse files
yozacharyozachar
committed
Deployed ca1b41f to dev with MkDocs 1.6.1 and mike 2.1.3
1 parent 2058873 commit f2f7679

Some content is hidden

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

76 files changed

+1434
-1242
lines changed

‎dev/404.html

Lines changed: 19 additions & 19 deletions
Large diffs are not rendered by default.

‎dev/_build/man/validators.1

Lines changed: 211 additions & 34 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" "Jun 17, 2024" "0.28.3" "validators"
30+
.TH "VALIDATORS" "1" "Sep 03, 2024" "0.33.0" "validators"
3131
.SH NAME
3232
validators \- Python Data Validation for Humans™
3333
.sp
@@ -215,39 +215,6 @@ 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
251218
.SS card
252219
.INDENT 0.0
253220
.TP
@@ -622,6 +589,129 @@ If \fIvalue\fP is a valid cron string.
622589
(Literal[True])
623590
.UNINDENT
624591
.UNINDENT
592+
.SS crypto_addresses
593+
.INDENT 0.0
594+
.TP
595+
.B validators.crypto_addresses.bsc_address(value: str, /)
596+
Return whether or not given value is a valid binance smart chain address.
597+
.sp
598+
Full validation is implemented for BSC addresses.
599+
.sp
600+
Examples
601+
.sp
602+
.nf
603+
.ft C
604+
>>> bsc_address(\(aq0x4e5acf9684652BEa56F2f01b7101a225Ee33d23f\(aq)
605+
# Output: True
606+
>>> bsc_address(\(aq0x4g5acf9684652BEa56F2f01b7101a225Eh33d23z\(aq)
607+
# Output: ValidationError(func=bsc_address, args=...)
608+
.ft P
609+
.fi
610+
.INDENT 7.0
611+
.TP
612+
.B Parameters
613+
\fBvalue\fP \-\- BSC address string to validate.
614+
.TP
615+
.B Returns
616+
If \fIvalue\fP is a valid bsc address.
617+
(ValidationError): If \fIvalue\fP is an invalid bsc address.
618+
.TP
619+
.B Return type
620+
(Literal[True])
621+
.UNINDENT
622+
.UNINDENT
623+
.INDENT 0.0
624+
.TP
625+
.B validators.crypto_addresses.btc_address(value: str, /)
626+
Return whether or not given value is a valid bitcoin address.
627+
.sp
628+
Full validation is implemented for P2PKH and P2SH addresses.
629+
For segwit addresses a regexp is used to provide a reasonable
630+
estimate on whether the address is valid.
631+
.sp
632+
Examples
633+
.sp
634+
.nf
635+
.ft C
636+
>>> btc_address(\(aq3Cwgr2g7vsi1bXDUkpEnVoRLA9w4FZfC69\(aq)
637+
# Output: True
638+
>>> btc_address(\(aq1BvBMsEYstWetqTFn5Au4m4GFg7xJaNVN2\(aq)
639+
# Output: ValidationError(func=btc_address, args=...)
640+
.ft P
641+
.fi
642+
.INDENT 7.0
643+
.TP
644+
.B Parameters
645+
\fBvalue\fP \-\- Bitcoin address string to validate.
646+
.TP
647+
.B Returns
648+
If \fIvalue\fP is a valid bitcoin address.
649+
(ValidationError): If \fIvalue\fP is an invalid bitcoin 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.eth_address(value: str, /)
658+
Return whether or not given value is a valid ethereum address.
659+
.sp
660+
Full validation is implemented for ERC20 addresses.
661+
.sp
662+
Examples
663+
.sp
664+
.nf
665+
.ft C
666+
>>> eth_address(\(aq0x9cc14ba4f9f68ca159ea4ebf2c292a808aaeb598\(aq)
667+
# Output: True
668+
>>> eth_address(\(aq0x8Ba1f109551bD432803012645Ac136ddd64DBa72\(aq)
669+
# Output: ValidationError(func=eth_address, args=...)
670+
.ft P
671+
.fi
672+
.INDENT 7.0
673+
.TP
674+
.B Parameters
675+
\fBvalue\fP \-\- Ethereum address string to validate.
676+
.TP
677+
.B Returns
678+
If \fIvalue\fP is a valid ethereum address.
679+
(ValidationError): If \fIvalue\fP is an invalid ethereum address.
680+
.TP
681+
.B Return type
682+
(Literal[True])
683+
.UNINDENT
684+
.UNINDENT
685+
.INDENT 0.0
686+
.TP
687+
.B validators.crypto_addresses.trx_address(value: str, /)
688+
Return whether or not given value is a valid tron address.
689+
.sp
690+
Full validation is implemented for TRC20 tron addresses.
691+
.sp
692+
Examples
693+
.sp
694+
.nf
695+
.ft C
696+
>>> trx_address(\(aqTLjfbTbpZYDQ4EoA4N5CLNgGjfbF8ZWz38\(aq)
697+
# Output: True
698+
>>> trx_address(\(aqTR2G7Rm4vFqF8EpY4U5xdLdQ7XgJ2U8Vd\(aq)
699+
# Output: ValidationError(func=trx_address, args=...)
700+
.ft P
701+
.fi
702+
.INDENT 7.0
703+
.TP
704+
.B Parameters
705+
\fBvalue\fP \-\- Tron address string to validate.
706+
.TP
707+
.B Returns
708+
If \fIvalue\fP is a valid tron address.
709+
(ValidationError): If \fIvalue\fP is an invalid tron address.
710+
.TP
711+
.B Return type
712+
(Literal[True])
713+
.UNINDENT
714+
.UNINDENT
625715
.SS domain
626716
.INDENT 0.0
627717
.TP
@@ -724,6 +814,62 @@ If \fIvalue\fP is a valid eMail.
724814
.SS encoding
725815
.INDENT 0.0
726816
.TP
817+
.B validators.encoding.base16(value: str, /)
818+
Return whether or not given value is a valid base16 encoding.
819+
.sp
820+
Examples
821+
.sp
822+
.nf
823+
.ft C
824+
>>> base16(\(aqa3f4b2\(aq)
825+
# Output: True
826+
>>> base16(\(aqa3f4Z1\(aq)
827+
# Output: ValidationError(func=base16, args={\(aqvalue\(aq: \(aqa3f4Z1\(aq})
828+
.ft P
829+
.fi
830+
.INDENT 7.0
831+
.TP
832+
.B Parameters
833+
\fBvalue\fP \-\- base16 string to validate.
834+
.TP
835+
.B Returns
836+
If \fIvalue\fP is a valid base16 encoding.
837+
(ValidationError): If \fIvalue\fP is an invalid base16 encoding.
838+
.TP
839+
.B Return type
840+
(Literal[True])
841+
.UNINDENT
842+
.UNINDENT
843+
.INDENT 0.0
844+
.TP
845+
.B validators.encoding.base32(value: str, /)
846+
Return whether or not given value is a valid base32 encoding.
847+
.sp
848+
Examples
849+
.sp
850+
.nf
851+
.ft C
852+
>>> base32(\(aqMFZWIZLTOQ======\(aq)
853+
# Output: True
854+
>>> base32(\(aqMfZW3zLT9Q======\(aq)
855+
# Output: ValidationError(func=base32, args={\(aqvalue\(aq: \(aqMfZW3zLT9Q======\(aq})
856+
.ft P
857+
.fi
858+
.INDENT 7.0
859+
.TP
860+
.B Parameters
861+
\fBvalue\fP \-\- base32 string to validate.
862+
.TP
863+
.B Returns
864+
If \fIvalue\fP is a valid base32 encoding.
865+
(ValidationError): If \fIvalue\fP is an invalid base32 encoding.
866+
.TP
867+
.B Return type
868+
(Literal[True])
869+
.UNINDENT
870+
.UNINDENT
871+
.INDENT 0.0
872+
.TP
727873
.B validators.encoding.base58(value: str, /)
728874
Return whether or not given value is a valid base58 encoding.
729875
.sp
@@ -990,6 +1136,37 @@ If \fIvalue\fP is a valid SHA256 hash.
9901136
.UNINDENT
9911137
.INDENT 0.0
9921138
.TP
1139+
.B validators.hashes.sha384(value: str, /)
1140+
Return whether or not given value is a valid SHA384 hash.
1141+
.sp
1142+
Examples
1143+
.sp
1144+
.nf
1145+
.ft C
1146+
>>> sha384(
1147+
\&... \(aqcb00753f45a35e8bb5a03d699ac65007272c32ab0eded163\(aq
1148+
\&... \(aq1a8b605a43ff5bed8086072ba1e7cc2358baeca134c825a7\(aq
1149+
\&... )
1150+
# Output: True
1151+
>>> sha384(\(aq900zz11\(aq)
1152+
# Output: ValidationError(func=sha384, args={\(aqvalue\(aq: \(aq900zz11\(aq})
1153+
.ft P
1154+
.fi
1155+
.INDENT 7.0
1156+
.TP
1157+
.B Parameters
1158+
\fBvalue\fP \-\- SHA384 string to validate.
1159+
.TP
1160+
.B Returns
1161+
If \fIvalue\fP is a valid SHA384 hash.
1162+
(ValidationError): If \fIvalue\fP is an invalid SHA384 hash.
1163+
.TP
1164+
.B Return type
1165+
(Literal[True])
1166+
.UNINDENT
1167+
.UNINDENT
1168+
.INDENT 0.0
1169+
.TP
9931170
.B validators.hashes.sha512(value: str, /)
9941171
Return whether or not given value is a valid SHA512 hash.
9951172
.sp

‎dev/_build/web/_sources/api/btc_address.rst.txt

Lines changed: 0 additions & 5 deletions
This file was deleted.

‎dev/_build/web/_sources/api/crypto_addresses.rst.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
crypto_addresses
2+
----------------
3+
4+
.. module:: validators.crypto_addresses
5+
.. autofunction:: bsc_address
6+
.. autofunction:: btc_address
7+
.. autofunction:: eth_address
8+
.. autofunction:: trx_address

‎dev/_build/web/_sources/api/encoding.rst.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,7 @@ encoding
22
--------
33

44
.. module:: validators.encoding
5+
.. autofunction:: base16
6+
.. autofunction:: base32
57
.. autofunction:: base58
68
.. autofunction:: base64

‎dev/_build/web/_sources/api/hashes.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ hashes
66
.. autofunction:: sha1
77
.. autofunction:: sha224
88
.. autofunction:: sha256
9+
.. autofunction:: sha384
910
.. autofunction:: sha512

‎dev/_build/web/_sources/index.rst.txt

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,12 @@ Resources
3737

3838
.. raw:: html
3939

40-
<!-- Original docs URL will be restored, once properly versioned docs is ready. -->
40+
<!-- Original docs URL will be restored, once properly versioned docs are ready. -->
41+
42+
--------------
43+
44+
**Python 3.8** `reaches EOL in <https://endoflife.date/python>`__
45+
**October 2024.**
4146

4247
.. raw:: html
4348

‎dev/_build/web/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '0.28.2',
3+
VERSION: '0.33.0',
44
LANGUAGE: 'en',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

‎dev/_build/web/_static/scripts/furo.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dev/_build/web/_static/scripts/furo.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)