diff options
| author | Susan LoVerso <sue@wiredtiger.com> | 2015-04-28 10:44:39 -0400 |
|---|---|---|
| committer | Susan LoVerso <sue@wiredtiger.com> | 2015-04-28 10:44:39 -0400 |
| commit | d6a6c0506d793010d6974fba2c46ca834d1a17ee (patch) | |
| tree | dbf4ab5ff3ba4200694993be7615c4183c1d10b0 /lang | |
| parent | e501b28e37fb5128507c2016be2001e58acf9f82 (diff) | |
| parent | 7ad8058797330fcf3f632271565151cbb4ada661 (diff) | |
| download | mongo-d6a6c0506d793010d6974fba2c46ca834d1a17ee.tar.gz | |
Merge branch 'develop' into encryption-api
Conflicts:
dist/api_data.py
src/config/config_def.c
src/include/config.h
Diffstat (limited to 'lang')
| -rw-r--r-- | lang/python/wiredtiger.i | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/lang/python/wiredtiger.i b/lang/python/wiredtiger.i index fb5b9ac5c55..3f297ca25a0 100644 --- a/lang/python/wiredtiger.i +++ b/lang/python/wiredtiger.i @@ -31,10 +31,16 @@ * The SWIG interface file defining the wiredtiger python API. */ %define DOCSTRING -"@defgroup wt_python WiredTiger Python API -Python wrappers aroung the WiredTiger C API. -@{ -@cond IGNORE" +"Python wrappers around the WiredTiger C API + +This provides an API similar to the C API, with the following modifications: + - Many C functions are exposed as OO methods. See the Python examples and test suite + - Errors are handled in a Pythonic way; wrap calls in try/except blocks + - Cursors have extra accessor methods and iterators that are higher-level than the C API + - Statistics cursors behave a little differently and are best handled using the C-like functions + - C Constants starting with WT_STAT_DSRC are instead exposed under wiredtiger.stat.dsrc + - C Constants starting with WT_STAT_CONN are instead exposed under wiredtiger.stat.conn +" %enddef %module(docstring=DOCSTRING) wiredtiger |