pybind/rados: use stub implementations when building document

* setup.py: inject "BUILD_DOC" into cython build context if "BUILD_DOC"
    env variable is set, this helps us to do conditional compilation.
    for instance, if we are building document, there is no need to
    use the header files or link against librados.so for building
    the python bindings.
* mock_rados.pxi: implement the mock functinons for their C counterparts
    in librados, so we can use them when building librados python
    binding for creating the document. Sphinx's autodoc extension
    reads annotation of the python package whose document is being
    built, after importing the python package into python runtime.
    but since we use Cython for creating our python binding,
    we have to provide the implementation of those referenced
    librados C API symbols. mock_rados.pxi implements them using Cython.
    the downside of this solution is that we need to mirror every
    function used by the Python binding by repeating them in both
    c_rados.pxd and mock_rados.pxi. the same will apply to other
    Ceph python bindings as long as they use C APIs not offered by
    libc or python runtime. so next step is to develop a simple
    parser which can be run at build time to create mock_*.pxi from
    c_*.pxd.
* rados.pyx: use mock_rados.pxi if BUILD_DOC, otherwise use
    c_rados.pyd. the latter requires a librados.so at runtime.

Signed-off-by: Kefu Chai <kchai@redhat.com>

diff --git a/src/pybind/rados/mock_rados.pxi b/src/pybind/rados/mock_rados.pxi
new file mode 100644 (file)
index 0000000..dcd79ed
--- /dev/null
+++ b/src/pybind/rados/mock_rados.pxi
@@ -0,0 +1,449 @@
+# cython: embedsignature=True
+
+from libc.stdint cimport *
+from ctime cimport time_t, timeval
+
+# mirrors the structure of c_rados, but instead *defines* the rados functions
+
+# err.h
+cdef:
+    int _MAX_ERRNO "MAX_ERRNO"
+
+# rados/rados_types.h
+cdef:
+    char* _LIBRADOS_ALL_NSPACES = "\001"
+    struct notify_ack_t:
+        unsigned long notifier_id
+        unsigned long cookie
+        char *payload
+        unsigned long payload_len
+
+    struct notify_timeout_t:
+        unsigned long notifier_id
+        unsigned long cookie
+
+# rados/librados.h
+cdef nogil:
+    enum:
+        _LIBRADOS_OP_FLAG_EXCL "LIBRADOS_OP_FLAG_EXCL"
+        _LIBRADOS_OP_FLAG_FAILOK "LIBRADOS_OP_FLAG_FAILOK"
+        _LIBRADOS_OP_FLAG_FADVISE_RANDOM "LIBRADOS_OP_FLAG_FADVISE_RANDOM"
+        _LIBRADOS_OP_FLAG_FADVISE_SEQUENTIAL "LIBRADOS_OP_FLAG_FADVISE_SEQUENTIAL"
+        _LIBRADOS_OP_FLAG_FADVISE_WILLNEED "LIBRADOS_OP_FLAG_FADVISE_WILLNEED"
+        _LIBRADOS_OP_FLAG_FADVISE_DONTNEED "LIBRADOS_OP_FLAG_FADVISE_DONTNEED"
+        _LIBRADOS_OP_FLAG_FADVISE_NOCACHE "LIBRADOS_OP_FLAG_FADVISE_NOCACHE"
+
+
+    enum:
+        _LIBRADOS_OPERATION_NOFLAG "LIBRADOS_OPERATION_NOFLAG"
+        _LIBRADOS_OPERATION_BALANCE_READS "LIBRADOS_OPERATION_BALANCE_READS"
+        _LIBRADOS_OPERATION_LOCALIZE_READS "LIBRADOS_OPERATION_LOCALIZE_READS"
+        _LIBRADOS_OPERATION_ORDER_READS_WRITES "LIBRADOS_OPERATION_ORDER_READS_WRITES"
+        _LIBRADOS_OPERATION_IGNORE_CACHE "LIBRADOS_OPERATION_IGNORE_CACHE"
+        _LIBRADOS_OPERATION_SKIPRWLOCKS "LIBRADOS_OPERATION_SKIPRWLOCKS"
+        _LIBRADOS_OPERATION_IGNORE_OVERLAY "LIBRADOS_OPERATION_IGNORE_OVERLAY"
+        _LIBRADOS_CREATE_EXCLUSIVE "LIBRADOS_CREATE_EXCLUSIVE"
+        _LIBRADOS_CREATE_IDEMPOTENT "LIBRADOS_CREATE_IDEMPOTENT"
+
+    uint64_t _LIBRADOS_SNAP_HEAD "LIBRADOS_SNAP_HEAD"
+
+    ctypedef void* rados_xattrs_iter_t
+    ctypedef void* rados_omap_iter_t
+    ctypedef void* rados_list_ctx_t
+    ctypedef uint64_t rados_snap_t
+    ctypedef void *rados_write_op_t
+    ctypedef void *rados_read_op_t
+    ctypedef void *rados_completion_t
+    ctypedef void (*rados_callback_t)(rados_completion_t cb, void *arg)
+    ctypedef void (*rados_log_callback_t)(void *arg, const char *line, const char *who,
+                                          uint64_t sec, uint64_t nsec, uint64_t seq, const char *level, const char *msg)
+    ctypedef void (*rados_log_callback2_t)(void *arg, const char *line, const char *channel, const char *who, const char *name,
+                                          uint64_t sec, uint64_t nsec, uint64_t seq, const char *level, const char *msg)
+    ctypedef void (*rados_watchcb2_t)(void *arg, int64_t notify_id,
+                                      uint64_t handle, uint64_t notifier_id,
+                                      void *data, size_t data_len)
+    ctypedef void (*rados_watcherrcb_t)(void *pre, uint64_t cookie, int err)
+
+
+    struct rados_cluster_stat_t:
+        uint64_t kb
+        uint64_t kb_used
+        uint64_t kb_avail
+        uint64_t num_objects
+
+    struct rados_pool_stat_t:
+        uint64_t num_bytes
+        uint64_t num_kb
+        uint64_t num_objects
+        uint64_t num_object_clones
+        uint64_t num_object_copies
+        uint64_t num_objects_missing_on_primary
+        uint64_t num_objects_unfound
+        uint64_t num_objects_degraded
+        uint64_t num_rd
+        uint64_t num_rd_kb
+        uint64_t num_wr
+        uint64_t num_wr_kb
+
+    void rados_buffer_free(char *buf):
+        pass
+
+    void rados_version(int *major, int *minor, int *extra):
+        pass
+
+    int rados_create2(rados_t *pcluster, const char *const clustername,
+                      const char * const name, uint64_t flags):
+        pass
+
+    int rados_create_with_context(rados_t *cluster, rados_config_t cct):
+        pass
+    int rados_connect(rados_t cluster):
+        pass
+    void rados_shutdown(rados_t cluster):
+        pass
+    cdef uint64_t rados_get_instance_id(rados_t cluster):
+        pass
+    int rados_conf_read_file(rados_t cluster, const char *path):
+        pass
+    int rados_conf_parse_argv_remainder(rados_t cluster, int argc, const char **argv, const char **remargv):
+        pass
+    int rados_conf_parse_env(rados_t cluster, const char *var):
+        pass
+    int rados_conf_set(rados_t cluster, char *option, const char *value):
+        pass
+    int rados_conf_get(rados_t cluster, char *option, char *buf, size_t len):
+        pass
+
+    rados_t rados_ioctx_get_cluster(rados_ioctx_t io):
+        pass
+    int rados_ioctx_pool_stat(rados_ioctx_t io, rados_pool_stat_t *stats):
+        pass
+    int64_t rados_pool_lookup(rados_t cluster, const char *pool_name):
+        pass
+    int rados_pool_reverse_lookup(rados_t cluster, int64_t id, char *buf, size_t maxlen):
+        pass
+    int rados_pool_create(rados_t cluster, const char *pool_name):
+        pass
+    int rados_pool_create_with_crush_rule(rados_t cluster, const char *pool_name, uint8_t crush_rule_num):
+        pass
+    int rados_pool_create_with_auid(rados_t cluster, const char *pool_name, uint64_t auid):
+        pass
+    int rados_pool_create_with_all(rados_t cluster, const char *pool_name, uint64_t auid, uint8_t crush_rule_num):
+        pass
+    int rados_pool_get_base_tier(rados_t cluster, int64_t pool, int64_t *base_tier):
+        pass
+    int rados_pool_list(rados_t cluster, char *buf, size_t len):
+        pass
+    int rados_pool_delete(rados_t cluster, const char *pool_name):
+        pass
+    int rados_inconsistent_pg_list(rados_t cluster, int64_t pool, char *buf, size_t len):
+        pass
+
+    int rados_cluster_stat(rados_t cluster, rados_cluster_stat_t *result):
+        pass
+    int rados_cluster_fsid(rados_t cluster, char *buf, size_t len):
+        pass
+    int rados_blocklist_add(rados_t cluster, char *client_address, uint32_t expire_seconds):
+        pass
+    int rados_getaddrs(rados_t cluster, char** addrs):
+        pass
+    int rados_application_enable(rados_ioctx_t io, const char *app_name,
+                                 int force):
+        pass
+    void rados_set_pool_full_try(rados_ioctx_t io):
+        pass
+    void rados_unset_pool_full_try(rados_ioctx_t io):
+        pass
+    int rados_application_list(rados_ioctx_t io, char *values,
+                             size_t *values_len):
+        pass
+    int rados_application_metadata_get(rados_ioctx_t io, const char *app_name,
+                                       const char *key, char *value,
+                                       size_t *value_len):
+        pass
+    int rados_application_metadata_set(rados_ioctx_t io, const char *app_name,
+                                       const char *key, const char *value):
+        pass
+    int rados_application_metadata_remove(rados_ioctx_t io,
+                                          const char *app_name, const char *key):
+        pass
+    int rados_application_metadata_list(rados_ioctx_t io,
+                                        const char *app_name, char *keys,
+                                        size_t *key_len, char *values,
+                                        size_t *value_len):
+        pass
+    int rados_ping_monitor(rados_t cluster, const char *mon_id, char **outstr, size_t *outstrlen):
+        pass
+    int rados_mon_command(rados_t cluster, const char **cmd, size_t cmdlen,
+                          const char *inbuf, size_t inbuflen,
+                          char **outbuf, size_t *outbuflen,
+                          char **outs, size_t *outslen):
+        pass
+    int rados_mgr_command(rados_t cluster, const char **cmd, size_t cmdlen,
+                          const char *inbuf, size_t inbuflen,
+                          char **outbuf, size_t *outbuflen,
+                          char **outs, size_t *outslen):
+        pass
+    int rados_mgr_command_target(rados_t cluster,
+                          const char *name,
+                         const char **cmd, size_t cmdlen,
+                          const char *inbuf, size_t inbuflen,
+                          char **outbuf, size_t *outbuflen,
+                          char **outs, size_t *outslen):
+        pass
+    int rados_mon_command_target(rados_t cluster, const char *name, const char **cmd, size_t cmdlen,
+                                 const char *inbuf, size_t inbuflen,
+                                 char **outbuf, size_t *outbuflen,
+                                 char **outs, size_t *outslen):
+        pass
+    int rados_osd_command(rados_t cluster, int osdid, const char **cmd, size_t cmdlen,
+                          const char *inbuf, size_t inbuflen,
+                          char **outbuf, size_t *outbuflen,
+                          char **outs, size_t *outslen):
+        pass
+    int rados_pg_command(rados_t cluster, const char *pgstr, const char **cmd, size_t cmdlen,
+                         const char *inbuf, size_t inbuflen,
+                         char **outbuf, size_t *outbuflen,
+                         char **outs, size_t *outslen):
+        pass
+    int rados_monitor_log(rados_t cluster, const char *level, rados_log_callback_t cb, void *arg):
+        pass
+    int rados_monitor_log2(rados_t cluster, const char *level, rados_log_callback2_t cb, void *arg):
+        pass
+
+    int rados_wait_for_latest_osdmap(rados_t cluster):
+        pass
+
+    int rados_service_register(rados_t cluster, const char *service, const char *daemon, const char *metadata_dict):
+        pass
+    int rados_service_update_status(rados_t cluster, const char *status_dict):
+        pass
+
+    int rados_ioctx_create(rados_t cluster, const char *pool_name, rados_ioctx_t *ioctx):
+        pass
+    int rados_ioctx_create2(rados_t cluster, int64_t pool_id, rados_ioctx_t *ioctx):
+        pass
+    void rados_ioctx_destroy(rados_ioctx_t io):
+        pass
+    void rados_ioctx_locator_set_key(rados_ioctx_t io, const char *key):
+        pass
+    void rados_ioctx_set_namespace(rados_ioctx_t io, const char * nspace):
+        pass
+
+    cdef uint64_t rados_get_last_version(rados_ioctx_t io):
+        pass
+    int rados_stat(rados_ioctx_t io, const char *o, uint64_t *psize, time_t *pmtime):
+        pass
+    int rados_write(rados_ioctx_t io, const char *oid, const char *buf, size_t len, uint64_t off):
+        pass
+    int rados_write_full(rados_ioctx_t io, const char *oid, const char *buf, size_t len):
+        pass
+    int rados_writesame(rados_ioctx_t io, const char *oid, const char *buf, size_t data_len, size_t write_len, uint64_t off):
+        pass
+    int rados_append(rados_ioctx_t io, const char *oid, const char *buf, size_t len):
+        pass
+    int rados_read(rados_ioctx_t io, const char *oid, char *buf, size_t len, uint64_t off):
+        pass
+    int rados_remove(rados_ioctx_t io, const char *oid):
+        pass
+    int rados_trunc(rados_ioctx_t io, const char *oid, uint64_t size):
+        pass
+    int rados_cmpext(rados_ioctx_t io, const char *o, const char *cmp_buf, size_t cmp_len, uint64_t off):
+        pass
+    int rados_getxattr(rados_ioctx_t io, const char *o, const char *name, char *buf, size_t len):
+        pass
+    int rados_setxattr(rados_ioctx_t io, const char *o, const char *name, const char *buf, size_t len):
+        pass
+    int rados_rmxattr(rados_ioctx_t io, const char *o, const char *name):
+        pass
+    int rados_getxattrs(rados_ioctx_t io, const char *oid, rados_xattrs_iter_t *iter):
+        pass
+    int rados_getxattrs_next(rados_xattrs_iter_t iter, const char **name, const char **val, size_t *len):
+        pass
+    void rados_getxattrs_end(rados_xattrs_iter_t iter):
+        pass
+
+    int rados_nobjects_list_open(rados_ioctx_t io, rados_list_ctx_t *ctx):
+        pass
+    int rados_nobjects_list_next(rados_list_ctx_t ctx, const char **entry, const char **key, const char **nspace):
+        pass
+    void rados_nobjects_list_close(rados_list_ctx_t ctx):
+        pass
+
+    int rados_ioctx_pool_requires_alignment2(rados_ioctx_t io, int * requires):
+        pass
+    int rados_ioctx_pool_required_alignment2(rados_ioctx_t io, uint64_t * alignment):
+        pass
+
+    int rados_ioctx_snap_rollback(rados_ioctx_t io, const char * oid, const char * snapname):
+        pass
+    int rados_ioctx_snap_create(rados_ioctx_t io, const char * snapname):
+        pass
+    int rados_ioctx_snap_remove(rados_ioctx_t io, const char * snapname):
+        pass
+    int rados_ioctx_snap_lookup(rados_ioctx_t io, const char * name, rados_snap_t * id):
+        pass
+    int rados_ioctx_snap_get_name(rados_ioctx_t io, rados_snap_t id, char * name, int maxlen):
+        pass
+    void rados_ioctx_snap_set_read(rados_ioctx_t io, rados_snap_t snap):
+        pass
+    int rados_ioctx_snap_list(rados_ioctx_t io, rados_snap_t * snaps, int maxlen):
+        pass
+    int rados_ioctx_snap_get_stamp(rados_ioctx_t io, rados_snap_t id, time_t * t):
+        pass
+    int64_t rados_ioctx_get_id(rados_ioctx_t io):
+        pass
+    int rados_ioctx_get_pool_name(rados_ioctx_t io, char *buf, unsigned maxlen):
+        pass
+
+    int rados_ioctx_selfmanaged_snap_create(rados_ioctx_t io,
+                                                 rados_snap_t *snapid):
+        pass
+    int rados_ioctx_selfmanaged_snap_remove(rados_ioctx_t io,
+                                                 rados_snap_t snapid):
+        pass
+    int rados_ioctx_selfmanaged_snap_set_write_ctx(rados_ioctx_t io,
+                                                   rados_snap_t snap_seq,
+                                                   rados_snap_t *snap,
+                                                   int num_snaps):
+        pass
+    int rados_ioctx_selfmanaged_snap_rollback(rados_ioctx_t io, const char *oid,
+                                                   rados_snap_t snapid):
+        pass
+
+    int rados_lock_exclusive(rados_ioctx_t io, const char * oid, const char * name,
+                             const char * cookie, const char * desc,
+                             timeval * duration, uint8_t flags):
+        pass
+    int rados_lock_shared(rados_ioctx_t io, const char * o, const char * name,
+                          const char * cookie, const char * tag, const char * desc,
+                          timeval * duration, uint8_t flags):
+        pass
+    int rados_unlock(rados_ioctx_t io, const char * o, const char * name, const char * cookie):
+        pass
+
+    rados_write_op_t rados_create_write_op():
+        pass
+    void rados_release_write_op(rados_write_op_t write_op):
+        pass
+
+    rados_read_op_t rados_create_read_op():
+        pass
+    void rados_release_read_op(rados_read_op_t read_op):
+        pass
+
+    int rados_aio_create_completion2(void * cb_arg, rados_callback_t cb_complete, rados_completion_t * pc):
+        pass
+    void rados_aio_release(rados_completion_t c):
+        pass
+    int rados_aio_stat(rados_ioctx_t io, const char *oid, rados_completion_t completion, uint64_t *psize, time_t *pmtime):
+        pass
+    int rados_aio_write(rados_ioctx_t io, const char * oid, rados_completion_t completion, const char * buf, size_t len, uint64_t off):
+        pass
+    int rados_aio_append(rados_ioctx_t io, const char * oid, rados_completion_t completion, const char * buf, size_t len):
+        pass
+    int rados_aio_write_full(rados_ioctx_t io, const char * oid, rados_completion_t completion, const char * buf, size_t len):
+        pass
+    int rados_aio_writesame(rados_ioctx_t io, const char *oid, rados_completion_t completion, const char *buf, size_t data_len, size_t write_len, uint64_t off):
+        pass
+    int rados_aio_remove(rados_ioctx_t io, const char * oid, rados_completion_t completion):
+        pass
+    int rados_aio_read(rados_ioctx_t io, const char * oid, rados_completion_t completion, char * buf, size_t len, uint64_t off):
+        pass
+    int rados_aio_flush(rados_ioctx_t io):
+        pass
+    int rados_aio_cmpext(rados_ioctx_t io, const char *o, rados_completion_t completion,  const char *cmp_buf, size_t cmp_len, uint64_t off):
+        pass
+    int rados_aio_rmxattr(rados_ioctx_t io, const char *o, rados_completion_t completion, const char *name):
+        pass
+
+    int rados_aio_get_return_value(rados_completion_t c):
+        pass
+    int rados_aio_wait_for_complete_and_cb(rados_completion_t c):
+        pass
+    int rados_aio_wait_for_complete(rados_completion_t c):
+        pass
+    int rados_aio_is_complete(rados_completion_t c):
+        pass
+
+    int rados_exec(rados_ioctx_t io, const char * oid, const char * cls, const char * method,
+                   const char * in_buf, size_t in_len, char * buf, size_t out_len):
+        pass
+    int rados_aio_exec(rados_ioctx_t io, const char * oid, rados_completion_t completion, const char * cls, const char * method,
+                       const char * in_buf, size_t in_len, char * buf, size_t out_len):
+        pass
+    int rados_aio_setxattr(rados_ioctx_t io, const char *o, rados_completion_t completion, const char *name, const char *buf, size_t len):
+        pass
+    int rados_write_op_operate(rados_write_op_t write_op, rados_ioctx_t io, const char * oid, time_t * mtime, int flags):
+        pass
+    int rados_aio_write_op_operate(rados_write_op_t write_op, rados_ioctx_t io, rados_completion_t completion, const char *oid, time_t *mtime, int flags):
+        pass
+    void rados_write_op_omap_set(rados_write_op_t write_op, const char * const* keys, const char * const* vals, const size_t * lens, size_t num):
+        pass
+    void rados_write_op_omap_rm_keys(rados_write_op_t write_op, const char * const* keys, size_t keys_len):
+        pass
+    void rados_write_op_omap_clear(rados_write_op_t write_op):
+        pass
+    void rados_write_op_omap_rm_range2(rados_write_op_t write_op, const char *key_begin, size_t key_begin_len, const char *key_end, size_t key_end_len):
+        pass
+    void rados_write_op_set_flags(rados_write_op_t write_op, int flags):
+        pass
+    void rados_write_op_setxattr(rados_write_op_t write_op, const char *name, const char *value, size_t value_len):
+        pass
+    void rados_write_op_rmxattr(rados_write_op_t write_op, const char *name):
+        pass
+
+    void rados_write_op_create(rados_write_op_t write_op, int exclusive, const char *category):
+        pass
+    void rados_write_op_append(rados_write_op_t write_op, const char *buffer, size_t len):
+        pass
+    void rados_write_op_write_full(rados_write_op_t write_op, const char *buffer, size_t len):
+        pass
+    void rados_write_op_assert_version(rados_write_op_t write_op, uint64_t ver):
+        pass
+    void rados_write_op_write(rados_write_op_t write_op, const char *buffer, size_t len, uint64_t offset):
+        pass
+    void rados_write_op_remove(rados_write_op_t write_op):
+        pass
+    void rados_write_op_truncate(rados_write_op_t write_op, uint64_t offset):
+        pass
+    void rados_write_op_zero(rados_write_op_t write_op, uint64_t offset, uint64_t len):
+        pass
+    void rados_write_op_exec(rados_write_op_t write_op, const char *cls, const char *method, const char *in_buf, size_t in_len, int *prval):
+        pass
+    void rados_write_op_writesame(rados_write_op_t write_op, const char *buffer, size_t data_len, size_t write_len, uint64_t offset):
+        pass
+    void rados_read_op_omap_get_vals2(rados_read_op_t read_op, const char * start_after, const char * filter_prefix, uint64_t max_return, rados_omap_iter_t * iter, unsigned char *pmore, int * prval):
+        pass
+    void rados_read_op_omap_get_keys2(rados_read_op_t read_op, const char * start_after, uint64_t max_return, rados_omap_iter_t * iter, unsigned char *pmore, int * prval):
+        pass
+    void rados_read_op_omap_get_vals_by_keys(rados_read_op_t read_op, const char * const* keys, size_t keys_len, rados_omap_iter_t * iter, int * prval):
+        pass
+    int rados_read_op_operate(rados_read_op_t read_op, rados_ioctx_t io, const char * oid, int flags):
+        pass
+    int rados_aio_read_op_operate(rados_read_op_t read_op, rados_ioctx_t io, rados_completion_t completion, const char *oid, int flags):
+        pass
+    void rados_read_op_set_flags(rados_read_op_t read_op, int flags):
+        pass
+    int rados_omap_get_next(rados_omap_iter_t iter, const char * const* key, const char * const* val, size_t * len):
+        pass
+    void rados_omap_get_end(rados_omap_iter_t iter):
+        pass
+    int rados_notify2(rados_ioctx_t io, const char * o, const char *buf, int buf_len, uint64_t timeout_ms, char **reply_buffer, size_t *reply_buffer_len):
+        pass
+    int rados_aio_notify(rados_ioctx_t io, const char * oid, rados_completion_t completion, const char * buf, int len, uint64_t timeout_ms, char **reply_buffer, size_t *reply_buffer_len):
+        pass
+    int rados_decode_notify_response(char *reply_buffer, size_t reply_buffer_len, notify_ack_t **acks, size_t *nr_acks, notify_timeout_t **timeouts, size_t *nr_timeouts):
+        pass
+    void rados_free_notify_response(notify_ack_t *acks, size_t nr_acks, notify_timeout_t *timeouts):
+        pass
+    int rados_notify_ack(rados_ioctx_t io, const char *o, uint64_t notify_id, uint64_t cookie, const char *buf, int buf_len):
+        pass
+    int rados_watch3(rados_ioctx_t io, const char *o, uint64_t *cookie, rados_watchcb2_t watchcb, rados_watcherrcb_t watcherrcb, uint32_t timeout, void *arg):
+        pass
+    int rados_watch_check(rados_ioctx_t io, uint64_t cookie):
+        pass
+    int rados_unwatch2(rados_ioctx_t io, uint64_t cookie):
+        pass
+    int rados_watch_flush(rados_t cluster):
+        pass

diff --git a/src/pybind/rados/rados.pxd b/src/pybind/rados/rados.pxd
index 14f6b503d1c7882fd98914a7e70f8674b7508eb4..fec534e8cc70936ecb23b3835ba12e1aa70bf4f6 100644 (file)
--- a/src/pybind/rados/rados.pxd
+++ b/src/pybind/rados/rados.pxd
@@ -4,11 +4,16 @@
 #
 # Copyright 2016 Mehdi Abaakouk <sileht@redhat.com>
 
-
-cdef extern from "rados/librados.h" nogil:
-    ctypedef void* rados_t
-    ctypedef void* rados_config_t
-    ctypedef void* rados_ioctx_t
+IF BUILD_DOC:
+    cdef:
+        ctypedef void* rados_t
+        ctypedef void* rados_config_t
+        ctypedef void* rados_ioctx_t
+ELSE:
+    cdef extern from "rados/librados.h" nogil:
+        ctypedef void* rados_t
+        ctypedef void* rados_config_t
+        ctypedef void* rados_ioctx_t
 
 
 cdef class Rados(object):

diff --git a/src/pybind/rados/rados.pyx b/src/pybind/rados/rados.pyx
index dfa9eee22bd29f38c29ba4505143c8eb523296dd..bdab1339dbcd065168ac7002719baec6c92fecee 100644 (file)
--- a/src/pybind/rados/rados.pyx
+++ b/src/pybind/rados/rados.pyx
@@ -18,7 +18,10 @@ from cpython.pycapsule cimport *
 from libc cimport errno
 from libc.stdint cimport *
 from libc.stdlib cimport malloc, realloc, free
-from c_rados cimport *
+IF BUILD_DOC:
+    include "mock_rados.pxi"
+ELSE:
+    from c_rados cimport *
 
 import threading
 import time

diff --git a/src/pybind/rados/setup.py b/src/pybind/rados/setup.py
index 091f1ea2b15662d6253462110394a9a084a5569b..57a9085b27eb9b469df73f2b9898a57868e2bb92 100755 (executable)
--- a/src/pybind/rados/setup.py
+++ b/src/pybind/rados/setup.py
@@ -133,9 +133,11 @@ def check_sanity():
 
 
 if 'BUILD_DOC' in os.environ:
-    pass
+    ext_args = {}
+    cython_constants = dict(BUILD_DOC=True)
 elif check_sanity():
-    pass
+    ext_args = get_python_flags(['rados'])
+    cython_constants = dict(BUILD_DOC=False)
 else:
     sys.exit(1)
 
@@ -185,12 +187,13 @@ setup(
             Extension(
                 "rados",
                 [source],
-                **get_python_flags(['rados'])
+                **ext_args
             )
         ],
         # use "3str" when Cython 3.0 is available
         compiler_directives={'language_level': sys.version_info.major},
-        build_dir=os.environ.get("CYTHON_BUILD_DIR", None)
+        compile_time_env=cython_constants,
+        build_dir=os.environ.get("CYTHON_BUILD_DIR", None),
     ),
     classifiers=[
         'Intended Audience :: Developers',