Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 4052a46

Browse files
Add inline documentation for low-level module
This commit adds a docstring to `gssapi.raw` so that `help(gssapi.raw)` returns useful information.
1 parent 2572d5d commit 4052a46

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

‎gssapi/raw/__init__.py‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,39 @@
1+
"""Low-Level GSSAPI Bindings
2+
3+
The low-level API presents a series of methods designed
4+
to closely mimic the C API presented in RFC 2744 and
5+
associated RFCs.
6+
7+
In this API, classes are simply thin wrappers around C
8+
constructs, and generally lack instance methods. However,
9+
classes will automatically free associated memory (so the
10+
release_xyz methods are not necessary to call).
11+
12+
The core RFC 2744 components are organized into the following
13+
submodules:
14+
15+
gssapi.raw.names -- Names
16+
17+
gssapi.raw.creds -- Credentials
18+
19+
gssapi.raw.sec_contexts -- Security Contexts
20+
21+
gssapi.raw.message -- Message encryption, decryption, etc
22+
23+
gssapi.raw.misc -- Miscellaneous functions
24+
25+
gssapi.raw.types -- Miscellaneous types (enums, etc)
26+
27+
gssapi.raw.exceptions -- Exceptions
28+
29+
Additionally, a number of extensions may be present. All extensions
30+
are in modules of the form `gssapi.raw.ext_xyz`.
31+
32+
All available functions and classes can be accessed directly from this
33+
module (`gssapi.raw`) -- it is unneccessary to directly import submodules.
34+
"""
35+
36+
137
import pkgutil
238
import importlib
339

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /