OpenQuizz
Une application de gestion des contenus pédagogiques
pymongo.common Namespace Reference

Data Structures

class  _CaseInsensitiveDictionary
 
class  BaseObject
 

Functions

def partition_node (node)
 
def clean_node (node)
 
def raise_config_error (key, dummy)
 
def validate_boolean (option, value)
 
def validate_boolean_or_string (option, value)
 
def validate_integer (option, value)
 
def validate_positive_integer (option, value)
 
def validate_non_negative_integer (option, value)
 
def validate_readable (option, value)
 
def validate_positive_integer_or_none (option, value)
 
def validate_non_negative_integer_or_none (option, value)
 
def validate_string (option, value)
 
def validate_string_or_none (option, value)
 
def validate_int_or_basestring (option, value)
 
def validate_non_negative_int_or_basestring (option, value)
 
def validate_positive_float (option, value)
 
def validate_positive_float_or_zero (option, value)
 
def validate_timeout_or_none (option, value)
 
def validate_timeout_or_zero (option, value)
 
def validate_timeout_or_none_or_zero (option, value)
 
def validate_max_staleness (option, value)
 
def validate_read_preference (dummy, value)
 
def validate_read_preference_mode (dummy, value)
 
def validate_auth_mechanism (option, value)
 
def validate_uuid_representation (dummy, value)
 
def validate_read_preference_tags (name, value)
 
def validate_auth_mechanism_properties (option, value)
 
def validate_document_class (option, value)
 
def validate_type_registry (option, value)
 
def validate_list (option, value)
 
def validate_list_or_none (option, value)
 
def validate_list_or_mapping (option, value)
 
def validate_is_mapping (option, value)
 
def validate_is_document_type (option, value)
 
def validate_appname_or_none (option, value)
 
def validate_driver_or_none (option, value)
 
def validate_is_callable_or_none (option, value)
 
def validate_ok_for_replace (replacement)
 
def validate_ok_for_update (update)
 
def validate_unicode_decode_error_handler (dummy, value)
 
def validate_tzinfo (dummy, value)
 
def validate_auth_option (option, value)
 
def validate (option, value)
 
def get_validated_options (options, warn=True)
 

Variables

 ORDERED_TYPES
 
 MAX_BSON_SIZE
 
 MAX_MESSAGE_SIZE
 
 MIN_WIRE_VERSION
 
 MAX_WIRE_VERSION
 
 MAX_WRITE_BATCH_SIZE
 
 MIN_SUPPORTED_SERVER_VERSION
 
 MIN_SUPPORTED_WIRE_VERSION
 
 MAX_SUPPORTED_WIRE_VERSION
 
 HEARTBEAT_FREQUENCY
 
 KILL_CURSOR_FREQUENCY
 
 EVENTS_QUEUE_FREQUENCY
 
 SERVER_SELECTION_TIMEOUT
 
 MIN_HEARTBEAT_INTERVAL
 
 MIN_SRV_RESCAN_INTERVAL
 
 CONNECT_TIMEOUT
 
 MAX_POOL_SIZE
 
 MIN_POOL_SIZE
 
 MAX_IDLE_TIME_MS
 
 MAX_IDLE_TIME_SEC
 
 WAIT_QUEUE_TIMEOUT
 
 LOCAL_THRESHOLD_MS
 
 RETRY_WRITES
 
 RETRY_READS
 
 COMMAND_NOT_FOUND_CODES
 
 UNAUTHORIZED_CODES
 
 URI_OPTIONS_ALIAS_MAP
 
 URI_OPTIONS_VALIDATOR_MAP
 
 NONSPEC_OPTIONS_VALIDATOR_MAP
 
 KW_VALIDATORS
 
 INTERNAL_URI_OPTION_NAME_MAP
 
 URI_OPTIONS_DEPRECATION_MAP
 
 VALIDATORS
 
 TIMEOUT_OPTIONS
 
 WRITE_CONCERN_OPTIONS
 

Function Documentation

◆ clean_node()

def pymongo.common.clean_node (   node)
Split and normalize a node name from an ismaster response.

◆ get_validated_options()

def pymongo.common.get_validated_options (   options,
  warn = True 
)
Validate each entry in options and raise a warning if it is not valid.
Returns a copy of options with invalid entries removed.

:Parameters:
    - `opts`: A dict containing MongoDB URI options.
    - `warn` (optional): If ``True`` then warnings will be logged and
      invalid options will be ignored. Otherwise, invalid options will
      cause errors.

◆ partition_node()

def pymongo.common.partition_node (   node)
Split a host:port string into (host, int(port)) pair.

◆ raise_config_error()

def pymongo.common.raise_config_error (   key,
  dummy 
)
Raise ConfigurationError with the given key name.

◆ validate()

def pymongo.common.validate (   option,
  value 
)
Generic validation function.

◆ validate_appname_or_none()

def pymongo.common.validate_appname_or_none (   option,
  value 
)
Validate the appname option.

◆ validate_auth_mechanism()

def pymongo.common.validate_auth_mechanism (   option,
  value 
)
Validate the authMechanism URI option.

◆ validate_auth_mechanism_properties()

def pymongo.common.validate_auth_mechanism_properties (   option,
  value 
)
Validate authMechanismProperties.

◆ validate_auth_option()

def pymongo.common.validate_auth_option (   option,
  value 
)
Validate optional authentication parameters.

◆ validate_boolean()

def pymongo.common.validate_boolean (   option,
  value 
)
Validates that 'value' is True or False.

◆ validate_boolean_or_string()

def pymongo.common.validate_boolean_or_string (   option,
  value 
)
Validates that value is True, False, 'true', or 'false'.

◆ validate_document_class()

def pymongo.common.validate_document_class (   option,
  value 
)
Validate the document_class option.

◆ validate_driver_or_none()

def pymongo.common.validate_driver_or_none (   option,
  value 
)
Validate the driver keyword arg.

◆ validate_int_or_basestring()

def pymongo.common.validate_int_or_basestring (   option,
  value 
)
Validates that 'value' is an integer or string.

◆ validate_integer()

def pymongo.common.validate_integer (   option,
  value 
)
Validates that 'value' is an integer (or basestring representation).

◆ validate_is_callable_or_none()

def pymongo.common.validate_is_callable_or_none (   option,
  value 
)
Validates that 'value' is a callable.

◆ validate_is_document_type()

def pymongo.common.validate_is_document_type (   option,
  value 
)
Validate the type of method arguments that expect a MongoDB document.

◆ validate_is_mapping()

def pymongo.common.validate_is_mapping (   option,
  value 
)
Validate the type of method arguments that expect a document.

◆ validate_list()

def pymongo.common.validate_list (   option,
  value 
)
Validates that 'value' is a list.

◆ validate_list_or_mapping()

def pymongo.common.validate_list_or_mapping (   option,
  value 
)
Validates that 'value' is a list or a document.

◆ validate_list_or_none()

def pymongo.common.validate_list_or_none (   option,
  value 
)
Validates that 'value' is a list or None.

◆ validate_max_staleness()

def pymongo.common.validate_max_staleness (   option,
  value 
)
Validates maxStalenessSeconds according to the Max Staleness Spec.

◆ validate_non_negative_int_or_basestring()

def pymongo.common.validate_non_negative_int_or_basestring (   option,
  value 
)
Validates that 'value' is an integer or string.

◆ validate_non_negative_integer()

def pymongo.common.validate_non_negative_integer (   option,
  value 
)
Validate that 'value' is a positive integer or 0.

◆ validate_non_negative_integer_or_none()

def pymongo.common.validate_non_negative_integer_or_none (   option,
  value 
)
Validate that 'value' is a positive integer or 0 or None.

◆ validate_ok_for_replace()

def pymongo.common.validate_ok_for_replace (   replacement)
Validate a replacement document.

◆ validate_ok_for_update()

def pymongo.common.validate_ok_for_update (   update)
Validate an update document.

◆ validate_positive_float()

def pymongo.common.validate_positive_float (   option,
  value 
)
Validates that 'value' is a float, or can be converted to one, and is
   positive.

◆ validate_positive_float_or_zero()

def pymongo.common.validate_positive_float_or_zero (   option,
  value 
)
Validates that 'value' is 0 or a positive float, or can be converted to
0 or a positive float.

◆ validate_positive_integer()

def pymongo.common.validate_positive_integer (   option,
  value 
)
Validate that 'value' is a positive integer, which does not include 0.

◆ validate_positive_integer_or_none()

def pymongo.common.validate_positive_integer_or_none (   option,
  value 
)
Validate that 'value' is a positive integer or None.

◆ validate_read_preference()

def pymongo.common.validate_read_preference (   dummy,
  value 
)
Validate a read preference.

◆ validate_read_preference_mode()

def pymongo.common.validate_read_preference_mode (   dummy,
  value 
)
Validate read preference mode for a MongoReplicaSetClient.

.. versionchanged:: 3.5
   Returns the original ``value`` instead of the validated read preference
   mode.

◆ validate_read_preference_tags()

def pymongo.common.validate_read_preference_tags (   name,
  value 
)
Parse readPreferenceTags if passed as a client kwarg.

◆ validate_readable()

def pymongo.common.validate_readable (   option,
  value 
)
Validates that 'value' is file-like and readable.

◆ validate_string()

def pymongo.common.validate_string (   option,
  value 
)
Validates that 'value' is an instance of `basestring` for Python 2
or `str` for Python 3.

◆ validate_string_or_none()

def pymongo.common.validate_string_or_none (   option,
  value 
)
Validates that 'value' is an instance of `basestring` or `None`.

◆ validate_timeout_or_none()

def pymongo.common.validate_timeout_or_none (   option,
  value 
)
Validates a timeout specified in milliseconds returning
a value in floating point seconds.

◆ validate_timeout_or_none_or_zero()

def pymongo.common.validate_timeout_or_none_or_zero (   option,
  value 
)
Validates a timeout specified in milliseconds returning
a value in floating point seconds. value=0 and value="0" are treated the
same as value=None which means unlimited timeout.

◆ validate_timeout_or_zero()

def pymongo.common.validate_timeout_or_zero (   option,
  value 
)
Validates a timeout specified in milliseconds returning
a value in floating point seconds for the case where None is an error
and 0 is valid. Setting the timeout to nothing in the URI string is a
config error.

◆ validate_type_registry()

def pymongo.common.validate_type_registry (   option,
  value 
)
Validate the type_registry option.

◆ validate_tzinfo()

def pymongo.common.validate_tzinfo (   dummy,
  value 
)
Validate the tzinfo option

◆ validate_unicode_decode_error_handler()

def pymongo.common.validate_unicode_decode_error_handler (   dummy,
  value 
)
Validate the Unicode decode error handler option of CodecOptions.

◆ validate_uuid_representation()

def pymongo.common.validate_uuid_representation (   dummy,
  value 
)
Validate the uuid representation option selected in the URI.

Variable Documentation

◆ COMMAND_NOT_FOUND_CODES

COMMAND_NOT_FOUND_CODES

◆ CONNECT_TIMEOUT

CONNECT_TIMEOUT

◆ EVENTS_QUEUE_FREQUENCY

EVENTS_QUEUE_FREQUENCY

◆ HEARTBEAT_FREQUENCY

HEARTBEAT_FREQUENCY

◆ INTERNAL_URI_OPTION_NAME_MAP

INTERNAL_URI_OPTION_NAME_MAP

◆ KILL_CURSOR_FREQUENCY

KILL_CURSOR_FREQUENCY

◆ KW_VALIDATORS

KW_VALIDATORS

◆ LOCAL_THRESHOLD_MS

LOCAL_THRESHOLD_MS

◆ MAX_BSON_SIZE

MAX_BSON_SIZE

◆ MAX_IDLE_TIME_MS

MAX_IDLE_TIME_MS

◆ MAX_IDLE_TIME_SEC

MAX_IDLE_TIME_SEC

◆ MAX_MESSAGE_SIZE

MAX_MESSAGE_SIZE

◆ MAX_POOL_SIZE

MAX_POOL_SIZE

◆ MAX_SUPPORTED_WIRE_VERSION

MAX_SUPPORTED_WIRE_VERSION

◆ MAX_WIRE_VERSION

MAX_WIRE_VERSION

◆ MAX_WRITE_BATCH_SIZE

MAX_WRITE_BATCH_SIZE

◆ MIN_HEARTBEAT_INTERVAL

MIN_HEARTBEAT_INTERVAL

◆ MIN_POOL_SIZE

MIN_POOL_SIZE

◆ MIN_SRV_RESCAN_INTERVAL

MIN_SRV_RESCAN_INTERVAL

◆ MIN_SUPPORTED_SERVER_VERSION

MIN_SUPPORTED_SERVER_VERSION

◆ MIN_SUPPORTED_WIRE_VERSION

MIN_SUPPORTED_WIRE_VERSION

◆ MIN_WIRE_VERSION

MIN_WIRE_VERSION

◆ NONSPEC_OPTIONS_VALIDATOR_MAP

NONSPEC_OPTIONS_VALIDATOR_MAP

◆ ORDERED_TYPES

ORDERED_TYPES

◆ RETRY_READS

RETRY_READS

◆ RETRY_WRITES

RETRY_WRITES

◆ SERVER_SELECTION_TIMEOUT

SERVER_SELECTION_TIMEOUT

◆ TIMEOUT_OPTIONS

TIMEOUT_OPTIONS

◆ UNAUTHORIZED_CODES

UNAUTHORIZED_CODES

◆ URI_OPTIONS_ALIAS_MAP

URI_OPTIONS_ALIAS_MAP

◆ URI_OPTIONS_DEPRECATION_MAP

URI_OPTIONS_DEPRECATION_MAP

◆ URI_OPTIONS_VALIDATOR_MAP

URI_OPTIONS_VALIDATOR_MAP

◆ VALIDATORS

VALIDATORS

◆ WAIT_QUEUE_TIMEOUT

WAIT_QUEUE_TIMEOUT

◆ WRITE_CONCERN_OPTIONS

WRITE_CONCERN_OPTIONS