DefaultValueFormatter Class Reference

Inheritance diagram for DefaultValueFormatter:

Collaboration diagram for DefaultValueFormatter:

Public Member Functions
def	format_field (self, value, spec)
def	get_field (self, field_name, args, kwargs)

Detailed Description

Custom formatter class which allows to substitute a missing value with a
default value

Definition at line 151 of file format.py.

Member Function Documentation

format_field()

def format_field	(		self,
			value,
			spec
	)

Format a single field:

* if the field is None and we have a ``:=`` specification we replace
  the field with the default value and change the spec to 's'
* if the value is None we replace it with an empty string

then we just run the normal formatter ...

Definition at line 155 of file format.py.

    def format_field(self, value, spec):
        """
        Format a single field:
 
        * if the field is None and we have a ``:=`` specification we replace
          the field with the default value and change the spec to 's'
        * if the value is None we replace it with an empty string
 
        then we just run the normal formatter ...
        """
        if spec.startswith("="):
            if value is None:
                value = spec[1:]
            spec = "s"
        if value is None:
            value = ""
            spec = ""
        return super().format_field(value, spec)
 

get_field()

def get_field	(		self,
			field_name,
			args,
			kwargs
	)

Try to get the field as usual but in case we cannot find it because it
either doesn't exist or it doesn't have the correct attribute/item we
just return None

Definition at line 174 of file format.py.

    def get_field(self, field_name, args, kwargs):
        """
        Try to get the field as usual but in case we cannot find it because it
        either doesn't exist or it doesn't have the correct attribute/item we
        just return None
        """
        try:
            return super().get_field(field_name, args, kwargs)
        except (KeyError, TypeError):
            return None, None
 
 

---

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

• framework/scripts/B2Tools/format.py