8.2 自定义字符串的格式化

问题

你想通过 format() 函数和字符串方法使得一个对象能支持自定义的格式化。

解决方案

为了自定义字符串的格式化，我们需要在类上面定义 format() 方法。例如：

  1. _formats = {
  2.     'ymd' : '{d.year}-{d.month}-{d.day}',
  3.     'mdy' : '{d.month}/{d.day}/{d.year}',
  4.     'dmy' : '{d.day}/{d.month}/{d.year}'
  5.     }
  6.  
  7. class Date:
  8.     def __init__(self, year, month, day):
  9.         self.year = year
  10.         self.month = month
  11.         self.day = day
  12.  
  13.     def __format__(self, code):
  14.         if code == '':
  15.             code = 'ymd'
  16.         fmt = _formats[code]
  17.         return fmt.format(d=self)

现在 Date 类的实例可以支持格式化操作了，如同下面这样：

  1. >>> d = Date(2012, 12, 21)
  2. >>> format(d)
  3. '2012-12-21'
  4. >>> format(d, 'mdy')
  5. '12/21/2012'
  6. >>> 'The date is {:ymd}'.format(d)
  7. 'The date is 2012-12-21'
  8. >>> 'The date is {:mdy}'.format(d)
  9. 'The date is 12/21/2012'
  10. >>>

讨论

format() 方法给Python的字符串格式化功能提供了一个钩子。这里需要着重强调的是格式化代码的解析工作完全由类自己决定。因此，格式化代码可以是任何值。例如，参考下面来自 datetime 模块中的代码：

  1. >>> from datetime import date
  2. >>> d = date(2012, 12, 21)
  3. >>> format(d)
  4. '2012-12-21'
  5. >>> format(d,'%A, %B %d, %Y')
  6. 'Friday, December 21, 2012'
  7. >>> 'The end is {:%d %b %Y}. Goodbye'.format(d)
  8. 'The end is 21 Dec 2012. Goodbye'
  9. >>>

对于内置类型的格式化有一些标准的约定。可以参考 string模块文档 说明。

原文:

http://python3-cookbook.readthedocs.io/zh_CN/latest/c08/p02_customizing_string_formatting.html