TolerateMissingKeyFormatter Class Reference

Inheritance diagram for TolerateMissingKeyFormatter:

Public Member Functions
def	get_value (self, key, args, kwds)
def	convert_field (self, value, conversion)
def	format_field (self, value, format_spec)

Detailed Description

A string formatter that implements format most equivalent to the str.format, but does not replace keys,
that are not present in the replacements dictionary

Example
-------
>>> formatter = TolerateMissingKeyFormatter()
>>> template = "{present}_{missing}"
>>> partially_substituted = formatter.format(template, present="replaced")
>>> print partially_substituted
"replaced_{missing}"

Definition at line 68 of file tolerate_missing_key_formatter.py.

Member Function Documentation

convert_field()

def convert_field	(		self,
			value,
			conversion
	)

Applies the conversion to the value.

Overrides the standard method such that a potential conversion is attached to the NoReplacementField

Definition at line 99 of file tolerate_missing_key_formatter.py.

    def convert_field(self, value, conversion):
        """Applies the conversion to the value.
 
        Overrides the standard method such that a potential conversion is attached to the NoReplacementField
        """
 
        if isinstance(value, NoReplacementField):
            conversion = conversion or None
            value.conversion = conversion
            return value
        else:
            return super().convert_field(value, conversion)
 

format_field()

def format_field	(		self,
			value,
			format_spec
	)

Applies the conversion to the value.

Overrides the standard method such that a potential format_spec is attached to the NoReplacementField.
Than composes the replacement_field specification to be inserted in the formatted string.
The outcome should be equivalent to the unformatted string for missing keys.

Definition at line 112 of file tolerate_missing_key_formatter.py.

    def format_field(self, value, format_spec):
        """Applies the conversion to the value.
 
        Overrides the standard method such that a potential format_spec is attached to the NoReplacementField.
        Than composes the replacement_field specification to be inserted in the formatted string.
        The outcome should be equivalent to the unformatted string for missing keys.
        """
 
        if isinstance(value, NoReplacementField):
            format_spec = format_spec or None
            value.format_spec = format_spec
            return value.compose()
        else:
            return super().format_field(value, format_spec)
 
 

get_value()

def get_value	(		self,
			key,
			args,
			kwds
	)

Retrieves the value that corresponds to the key from either the postional or
the keyword arguments given to format

Overrides the standard lookup such that missing keys in the keyword arguments or
transformed in a NoReplacementField signal object.

Definition at line 83 of file tolerate_missing_key_formatter.py.

    def get_value(self, key, args, kwds):
        """Retrieves the value that corresponds to the key from either the postional or
        the keyword arguments given to format
 
        Overrides the standard lookup such that missing keys in the keyword arguments or
        transformed in a NoReplacementField signal object.
        """
 
        if isinstance(key, str):
            try:
                return kwds[key]
            except KeyError:
                return NoReplacementField(key)
        else:
            return super().get_value(key, args, kwds)
 

---

The documentation for this class was generated from the following file:

• tracking/scripts/tracking/validation/tolerate_missing_key_formatter.py