diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2013-01-19 15:33:01 -0500 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2013-01-19 15:33:01 -0500 |
| commit | 4c08f92f9caa64140e0010eae88179f260a28704 (patch) | |
| tree | 2df0bc5ac5f976348c10a3778992f052f1cccb45 /passlib/exc.py | |
| parent | ffc6b005e32e4d3a71d24d27d22b3f46f4674a52 (diff) | |
| download | passlib-4c08f92f9caa64140e0010eae88179f260a28704.tar.gz | |
minor documentation updates
* added some backwards-compat & error handling notes to CryptContext,
as suggested by Thomas Waldmann (https://code.google.com/p/passlib/issues/detail?id=27#c2)
* clarified alg descriptions and internal comments for lmhash, md5_crypt, cisco, et al
* deprecated_method() decorator now checks if ".. deprecated::" stanza already present in docstring
* hash_needs_update() won't be removed until release 2.0
Diffstat (limited to 'passlib/exc.py')
| -rw-r--r-- | passlib/exc.py | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/passlib/exc.py b/passlib/exc.py index bdcbc5e..8d872a7 100644 --- a/passlib/exc.py +++ b/passlib/exc.py @@ -43,7 +43,8 @@ class PasswordSizeError(ValueError): # warnings #============================================================================= class PasslibWarning(UserWarning): - """base class for Passlib's user warnings. + """base class for Passlib's user warnings, + derives from the builtin :exc:`UserWarning`. .. versionadded:: 1.6 """ @@ -61,6 +62,8 @@ class PasslibConfigWarning(PasslibWarning): In both of these cases, the code will perform correctly & securely; but the warning is issued as a sign the configuration may need updating. + + .. versionadded:: 1.6 """ class PasslibHashWarning(PasslibWarning): @@ -75,6 +78,8 @@ class PasslibHashWarning(PasslibWarning): * A malformed hash string was encountered which (while parsable) should be re-encoded. + + .. versionadded:: 1.6 """ class PasslibRuntimeWarning(PasslibWarning): @@ -83,11 +88,15 @@ class PasslibRuntimeWarning(PasslibWarning): The fact that it's a warning instead of an error means Passlib was able to correct for the issue, but that it's anonmalous enough that the developers would love to hear under what conditions it occurred. + + .. versionadded:: 1.6 """ class PasslibSecurityWarning(PasslibWarning): """Special warning issued when Passlib encounters something that might affect security. + + .. versionadded:: 1.6 """ #============================================================================= |