diff options
| author | Alex Gaynor <alex.gaynor@gmail.com> | 2013-12-23 08:25:24 -0800 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2013-12-23 08:25:24 -0800 |
| commit | 834342bea3990d166b9c63620a133d18ae5c9339 (patch) | |
| tree | 5d93d450e80cc70e64c79f203b9556e2453f6950 | |
| parent | 2ca30db7b8608af3e9994f6b324d9311ca437b78 (diff) | |
| download | cryptography-834342bea3990d166b9c63620a133d18ae5c9339.tar.gz cryptography-834342bea3990d166b9c63620a133d18ae5c9339.tar.bz2 cryptography-834342bea3990d166b9c63620a133d18ae5c9339.zip | |
A docstring
| -rw-r--r-- | cryptography/hazmat/backends/openssl/backend.py | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/cryptography/hazmat/backends/openssl/backend.py b/cryptography/hazmat/backends/openssl/backend.py index 9cd07ea5..3e47afa1 100644 --- a/cryptography/hazmat/backends/openssl/backend.py +++ b/cryptography/hazmat/backends/openssl/backend.py @@ -56,6 +56,20 @@ _OSX_POST_INCLUDE = """ class Backend(object): """ OpenSSL API wrapper. + + Modules listed in the ``_modules`` listed should have the following + attributes: + + * ``INCLUDES``: A string containg C includes. + * ``TYPES``: A string containing C declarations for types. + * ``FUNCTIONS``: A string containing C declarations for functions. + * ``MACROS``: A string containing C declarations for any macros. + * ``CUSTOMIZATIONS``: A string containing arbitrary top-level C code, this + can be used to do things like test for a define and provide an + alternate implementation based on that. + * ``CONDITIONAL_NAMES``: A dict mapping strings of condition names from the + library to a list of names which will not be present without the + condition. """ _module_prefix = "cryptography.hazmat.backends.openssl." _modules = [ |