pybnb.configuration

Configuration settings for node serialization.

Copyright by Gabriel A. Hackebeil (gabe.hackebeil@gmail.com).

class pybnb.configuration.Configuration

The main configuration object.

SERIALIZER

The name of serialization module used to transmit node state. (default: “pickle”)

Type

str, {‘pickle’, ‘dill’}

SERIALIZER_PROTOCOL_VERSION

The protocol argument passed to the dumps function of the selected serialization module. (default: pickle.HIGHEST_PROTOCOL)

Type

int

COMPRESSION

Indicates whether or not to compress the serialized node state using zlib. (default: False)

Type

bool

MARSHAL_PROTOCOL_VERSION

The version argument passed to the marshal.dumps() function. (default: 2)

Type

int

reset(use_environment=True)

Reset the configuration to default settings.

Parameters

use_environment (bool, optional) – Controls whether or not to check for environment variables to overwrite the default settings. (default: True)