Advanced Usage & Internals

This page contains documentation for aspects of library internals that you will rarely need to interact with, but are important for understanding how it works and development purposes.

Connection pool

Retry logic

Multiget / Multiput

Datatypes

Datatype internals

TypedMapView

TYPES constant

Transports

Security helpers

HTTP Transport

TCP Transport

Utilities

Multi-valued Dict

Micro-benchmarking

Miscellaneous

distutils commands

class commands.build_messages(dist)

Generates message code mappings. Add to the build process using:

setup(cmd_class={'build_messages': build_messages})

Create and initialize a new Command object. Most importantly, invokes the ‘initialize_options()’ method, which is the real initializer and depends on the actual command being instantiated.

finalize_options()
initialize_options()
run()
description = 'generate protocol message code mappings'
user_options = [('source=', None, 'source CSV file containing message code mappings'), ('destination=', None, 'destination Python source file')]
class commands.setup_timeseries(dist)

Creates bucket-types appropriate for timeseries.

Create and initialize a new Command object. Most importantly, invokes the ‘initialize_options()’ method, which is the real initializer and depends on the actual command being instantiated.

description = 'create bucket-types used in timeseries tests'
user_options = [('riak-admin=', None, 'path to the riak-admin script')]

Version extraction (version module)

Gets the current version number. If in a git repository, it is the current git tag. Otherwise it is the one contained in the PKG-INFO file.

To use this script, simply import it in your setup.py file and use the results of get_version() as your package version:

from version import *

setup(
    version=get_version()
)