How to get Python to gracefully format None and non-existing fields [duplicate]

by

The recommendation in PEP 3101 is to subclass Formatter: 

import string
class PartialFormatter(string.Formatter):
    def __init__(self, missing='~~', bad_fmt="!!"):
        self.missing, self.bad_fmt=missing, bad_fmt

    def get_field(self, field_name, args, kwargs):
        # Handle a key not found
        try:
            val=super(PartialFormatter, self).get_field(field_name, args, kwargs)
            # Python 3, 'super().get_field(field_name, args, kwargs)' works
        except (KeyError, AttributeError):
            val=None,field_name 
        return val 

    def format_field(self, value, spec):
        # handle an invalid format
        if value==None: return self.missing
        try:
            return super(PartialFormatter, self).format_field(value, spec)
        except ValueError:
            if self.bad_fmt is not None: return self.bad_fmt   
            else: raise

fmt=PartialFormatter()
data = {'n': 3, 'k': 3.141594, 'p': {'a': '7', 'b': 8}}
print(fmt.format('{n}, {k:.2f}, {p[a]}, {p[b]}', **data))
# 3, 3.14, 7, 8
del data['k']
data['p']['b'] = None
print(fmt.format('{n}, {k:.2f}, {p[a]:.2f}, {p[b]}', **data))
# 3, ~~, !!, ~~

As set up, it will print ~~ if a field or attribute is not found and !! if an invalid format is used given the field value. (Just use None for the keyword argument bad_fmt if you want the default of a value error raised.)

To handle missing keys, you need to subclass both get_field to catch the KeyError or AttributeError and format_field to return a default value for the missing key.

Since you are catching format_field errors, you can catch a bad format field as well by catching the ValueError from the superclass.

More Related Contents:

  1. Format string unused named arguments [duplicate]
  2. str.format() raises KeyError
  3. Leaving values blank if not passed in str.format
  4. How to use % symbol correctly
  5. How do I print curly-brace characters in a string while using .format?
  6. Display number with leading zeros
  7. What does %s mean in a Python format string?
  8. How do I turn a python datetime into a string, with readable format date?
  9. Format output string, right alignment
  10. f-strings vs str.format()
  11. Format a datetime into a string with milliseconds
  12. What’s the difference between %s and %d in Python string formatting?
  13. Convert hex to binary
  14. How can I convert 24 hour time to 12 hour time?
  15. How to left align a fixed width string?
  16. Format strings vs concatenation
  17. Pandas Dataframe: Replacing NaN with row average
  18. Format numbers to strings in Python
  19. How can I extract keywords from a Python format string?
  20. Can’t drop NAN with dropna in pandas
  21. Print floating point values without leading zero
  22. Nested f-strings
  23. Most Pythonic way to print *at most* some number of decimal places [duplicate]
  24. How can I use f-string with a variable, not with a string literal?
  25. How do I format a number with a variable number of digits in Python?
  26. Python 3 bytes formatting
  27. Slicing strings in str.format
  28. Python, print all floats to 2 decimal places in output
  29. Pandas: groupby forward fill with datetime index
  30. python format string thousand separator with spaces

Leave a Comment