6.1. string — 常见的字符串操作

    参见

    字符串的方法

    此模块中定义的常量为：

    下文所述 和 ascii_uppercase 常量的拼连。 该值不依赖于语言区域。

    string.ascii_lowercase

    小写字母 'abcdefghijklmnopqrstuvwxyz'。 该值不依赖于语言区域，不会发生改变。

    string.ascii_uppercase

    大写字母 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'。 该值不依赖于语言区域，不会发生改变。

    string.digits

    字符串 '0123456789'。

    string.hexdigits

    字符串 '0123456789abcdefABCDEF'。

    string.octdigits

    字符串 '01234567'。

    string.punctuation

    由在 C 语言区域中被视为标点符号的 ASCII 字符组成的字符串。

    string.printable

    由被视为可打印符号的 ASCII 字符组成的字符串。 这是 , ascii_letters, 和 whitespace 的总和。

    string.whitespace

    由被视为空白符号的 ASCII 字符组成的字符串。 其中包括空格、制表、换行、回车、进纸和纵向制表符。

    内置的字符串类提供了通过使用 所描述的 format() 方法进行复杂变量替换和值格式化的能力。 模块中的 Formatter 类允许你使用与内置 方法相同的实现来创建并定制你自己的字符串格式化行为。

    class string.Formatter

    Formatter 类包含下列公有方法：

    • format(format_string, args, kwargs*)

      首要的 API 方法。 它接受一个格式字符串和任意一组位置和关键字参数。 它只是一个调用 的包装器。

      3.5 版后已移除: Passing a format string as keyword argument format_string has been deprecated.

    • vformat(format_string, args, kwargs)

      此函数执行实际的格式化操作。 它被公开为一个单独的函数，用于需要传入一个预定义字母作为参数，而不是使用 *args 和 **kwargs 语法将字典解包为多个单独参数并重打包的情况。 vformat() 完成将格式字符串分解为字符数据和替换字段的工作。 它会调用下文所述的几种不同方法。

    此外， 还定义了一些旨在被子类替换的方法：

    • parse(format_string)

      循环遍历 format_string 并返回一个由可迭代对象组成的元组 (literal_text, field_name, format_spec, conversion)。 它会被 vformat() 用来将字符串分解为文本字面值或替换字段。

      元组中的值在概念上表示一段字面文本加上一个替换字段。 如果没有字面文本（如果连续出现两个替换字段就会发生这种情况），则 literal_text 将是一个长度为零的字符串。 如果没有替换字段，则 field_name, format_spec 和 conversion 的值将为 None。

    • get_field(field_name, args, kwargs)

      给定 field_name 作为 (见上文) 的返回值，将其转换为要格式化的对象。 返回一个元组 (obj, used_key)。 默认版本接受在 PEP 3101 所定义形式的字符串，例如 “0[name]” 或 “label.title”。 args 和 kwargs 与传给 的一样。 返回值 used_key 与 get_value() 的 key 形参具有相同的含义。

    • get_value(key, args, kwargs)

      提取给定的字段值。 key 参数将为整数或字符串。 如果是整数，它表示 args 中位置参数的索引；如果是字符串，它表示 kwargs 中的关键字参数名。

      args 形参会被设为 的位置参数列表，而 kwargs 形参会被设为由关键字参数组成的字典。

      对于复合字段名称，仅会为字段名称的第一个组件调用这些函数；后续组件会通过普通属性和索引操作来进行处理。

      因此举例来说，字段表达式 ‘0.name’ 将导致调用 get_value() 时附带 key 参数值 0。 在 通过调用内置的 getattr() 函数返回后将会查找 name 属性。

      如果索引或关键字引用了一个不存在的项，则将引发 或 KeyError。

    • check_unused_args(used_args, args, kwargs)

      在必要时实现对未使用参数进行检测。 此函数的参数是是格式字符串中实际引用的所有参数键的集合（整数表示位置参数，字符串表示名称参数），以及被传给 vformat 的 args 和 kwargs 的引用。 未使用参数的集合可以根据这些形参计算出来。 如果检测失败则 应会引发一个异常。

    • format_field(value, format_spec)

      format_field() 会简单地调用内置全局函数 。 提供该方法是为了让子类能够重载它。

    • convert_field(value, conversion)

      使用给定的转换类型（来自 parse() 方法所返回的元组）来转换（由 所返回的）值。 默认版本支持 ‘s’ (str), ‘r’ (repr) 和 ‘a’ (ascii) 等转换类型。

    str.format() 方法和 类共享相同的格式字符串语法（虽然对于 Formatter 来说，其子类可以定义它们自己的格式字符串语法）。 具体语法与 相似，但也存在区别。

    格式字符串包含有以花括号 {} 括起来的“替换字段”。 不在花括号之内的内容被视为字面文本，会不加修改地复制到输出中。 如果你需要在字面文本中包含花括号字符，可以通过重复来转义: {{ and }}。

    替换字段的语法如下：

    用不太正式的术语来描述，替换字段开头可以用一个 field_name 指定要对值进行格式化并取代替换字符被插入到输出结果的对象。 field_name 之后有可选的 conversion 字段，它是一个感叹号 '!' 加一个 format_spec，并以一个冒号 ':' 打头。 这些指明了替换值的非默认格式。

    另请参阅 格式规格迷你语言 一节。

    field_name 本身以一个数字或关键字 arg_name 打头。 如果为数字，则它指向一个位置参数，而如果为关键字，则它指向一个命名关键字参数。 如果格式字符串中的数字 arg_names 为 0, 1, 2, … 的序列，它们可以全部省略（而非部分省略），数字 0, 1, 2, … 将会按顺序自动插入。 由于 arg_name 不使用引号分隔，因此无法在格式字符串中指定任意的字典键 (例如字符串 '10' 或 ':-]')。 arg_name 之后可以带上任意数量的索引或属性表达式。 '.name' 形式的表达式会使用 选择命名属性，而 '[index]' 形式的表达式会使用 __getitem__() 执行索引查找。

    在 3.1 版更改: 位置参数说明符对于 可以省略，因此 '{} {}'.format(a, b) 等价于 '{0} {1}'.format(a, b)。

    在 3.4 版更改: 位置参数说明符对于 Formatter 可以省略。

    一些简单的格式字符串示例

    1. "First, thou shalt count to {0}"  # References first positional argument
    2. "Bring me a {}"                   # Implicitly references the first positional argument
    3. "From {} to {}"                   # Same as "From {0} to {1}"
    4. "My quest is {name}"              # References keyword argument 'name'
    5. "Weight in tons {0.weight}"       # 'weight' attribute of first positional arg
    6. "Units destroyed: {players[0]}"   # First element of keyword argument 'players'.

    使用 conversion 字段在格式化之前进行类型强制转换。 通常，格式化值的工作由值本身的 方法来完成。 但是，在某些情况下最好强制将类型格式化为一个字符串，覆盖其本身的格式化定义。 通过在调用 __format__() 之前将值转换为字符串，可以绕过正常的格式化逻辑。

    目前支持的转换旗标有三种: '!s' 会对值调用 ，'!r' 调用 repr() 而 '!a' 则调用 。

    几个例子:

    1. "Harold's a clever {0!s}"        # Calls str() on the argument first
    2. "Bring out the holy {name!r}"    # Calls repr() on the argument first
    3. "More {!a}"                      # Calls ascii() on the argument first

    format_spec 字段包含值应如何呈现的规格描述，例如字段宽度、对齐、填充、小数精度等细节信息。 每种值类型可以定义自己的“格式化迷你语言”或对 format_spec 的解读方式。

    大多数内置类型都支持同样的格式化迷你语言，具体描述见下一节。

    format_spec 字段还可以在其内部包含嵌套的替换字段。 这些嵌套的替换字段可能包括字段名称、转换旗标和格式规格描述，但是不再允许更深层的嵌套。 format_spec 内部的替换字段会在解读 format_spec 字符串之前先被解读。 这将允许动态地指定特定值的格式。

    请参阅 格式示例 一节查看相关示例。

    “格式规格”在格式字符串所包含的替换字段内部使用，用于定义单个值应如何呈现 (参见 和 格式化字符串字面值)。 它们也可以被直接传给内置的 函数。 每种可格式化的类型都可以自行定义如何对格式规格进行解读。

    A general convention is that an empty format string ("") produces the same result as if you had called str() on the value. A non-empty format string typically modifies the result.

    标准格式说明符 的一般形式如下：

    1. format_spec     ::=  [[]align][][#][0][width][][.precision][]
    2. fill            ::=  <any character>
    3. align           ::=  "<" | ">" | "=" | "^"
    4. sign            ::=  "+" | "-" | " "
    5. width           ::=  digit+
    6. grouping_option ::=  "_" | ","
    7. precision       ::=  +
    8. type            ::=  "b" | "c" | "d" | "e" | "E" | "f" | "F" | "g" | "G" | "n" | "o" | "s" | "x" | "X" | "%"

    如果指定了一个有效的 align 值，则可以在该值前面加一个 fill 字符，它可以为任意字符，如果省略则默认为空格符。 在 格式化字符串字面值 或在使用 方法时是无法使用花括号字面值 (“{” or “}”) 作为 fill 字符的。 但是，通过嵌套替换字段插入花括号则是可以的。 这个限制不会影响 format() 函数。

    各种对齐选项的含义如下：

    请注意，除非定义了最小字段宽度，否则字段宽度将始终与填充它的数据大小相同，因此在这种情况下，对齐选项没有意义。

    sign 选项仅对数字类型有效，可以是以下之一：

    '#' 选项可以让“替代形式”被用于转换。 替代形式可针对不同类型分别定义。 此选项仅对整数、浮点、复数和 Decimal 类型有效。 对于整数类型，当使用二进制、八进制或十六进制输出时，此选项会为输出值添加相应的 '0b', '0o' 或 '0x' 前缀。 对于浮点数、复数和 Decimal 类型，替代形式会使得转换结果总是包含小数点符号，即使其不带小数。 通常只有在带有小数的情况下，此类转换的结果中才会出现小数点符号。 此外，对于 'g' 和 'G' 转换，末尾的零不会从结果中被移除。

    ',' 选项表示使用逗号作为千位分隔符。 对于感应区域设置的分隔符，请改用 'n' 整数表示类型。

    在 3.1 版更改: 添加了 ',' 选项 (另请参阅 )。

    '_' 选项表示对浮点表示类型和整数表示类型 'd' 使用下划线作为千位分隔符。 对于整数表示类型 'b', 'o', 'x' 和 'X'，将为每 4 个数位插入一个下划线。 对于其他表示类型指定此选项则将导致错误。

    在 3.6 版更改: 添加了 '_' 选项 (另请参阅 PEP 515)。

    width is a decimal integer defining the minimum field width. If not specified, then the field width will be determined by the content.

    当未显式给出对齐方式时，在 width 字段前加一个零 ('0') 字段将为数字类型启用感知正负号的零填充。 这相当于设置 fill 字符为 '0' 且 alignment 类型为 '='。

    precision 是一个十进制数字，表示对于以 'f' and 'F' 格式化的浮点数值要在小数点后显示多少个数位，或者对于以 或 'G' 格式化的浮点数值要在小数点前后共显示多少个数位。 对于非数字类型，该字段表示最大字段大小 —— 换句话说就是要使用多少个来自字段内容的字符。 对于整数值则不允许使用 precision。

    最后，type 确定了数据应如何呈现。

    可用的字符串表示类型是：

    可用的整数表示类型是：

    在上述的表示类型之外，整数还可以通过下列的浮点表示类型来格式化 (除了 'n' 和 None)。 当这样做时，会在格式化之前使用 将整数转换为浮点数。

    浮点数和小数值可用的表示类型有：

    6.1.3.2. 格式示例

    本节包含 语法的示例以及与旧式 % 格式化的比较。

    该语法在大多数情况下与旧式的 % 格式化类似，只是增加了 {} 和 : 来取代 %。 例如，，'%03.2f' 可以被改写为 '{:03.2f}'。

    新的格式语法还支持新增的不同选项，将在以下示例中说明。

    按位置访问参数:

    1. >>> '{0}, {1}, {2}'.format('a', 'b', 'c')
    2. 'a, b, c'
    3. >>> '{}, {}, {}'.format('a', 'b', 'c')  # 3.1+ only
    4. 'a, b, c'
    5. 'c, b, a'
    6. >>> '{2}, {1}, {0}'.format(*'abc')      # unpacking argument sequence
    7. 'c, b, a'
    8. >>> '{0}{1}{0}'.format('abra', 'cad')   # arguments' indices can be repeated
    9. 'abracadabra'

    按名称访问参数:

    访问参数的属性:

    1. >>> c = 3-5j
    2. >>> ('The complex number {0} is formed from the real part {0.real} '
    3. ...  'and the imaginary part {0.imag}.').format(c)
    4. 'The complex number (3-5j) is formed from the real part 3.0 and the imaginary part -5.0.'
    5. >>> class Point:
    6. ...     def __init__(self, x, y):
    7. ...         self.x, self.y = x, y
    8. ...     def __str__(self):
    9. ...         return 'Point({self.x}, {self.y})'.format(self=self)
    10. ...
    12. 'Point(4, 2)'

    访问参数的项:

    1. >>> coord = (3, 5)
    2. >>> 'X: {0[0]};  Y: {0[1]}'.format(coord)
    3. 'X: 3;  Y: 5'

    替代 %s 和 %r:

    1. >>> "repr() shows quotes: {!r}; str() doesn't: {!s}".format('test1', 'test2')
    2. "repr() shows quotes: 'test1'; str() doesn't: test2"

    对齐文本以及指定宽度:

    1. >>> '{:<30}'.format('left aligned')
    2. 'left aligned                  '
    3. >>> '{:>30}'.format('right aligned')
    4. '                 right aligned'
    5. >>> '{:^30}'.format('centered')
    6. '           centered           '
    7. >>> '{:*^30}'.format('centered')  # use '*' as a fill char
    8. '***********centered***********'

    替代 %+f, %-f 和 % f 以及指定正负号:

    替代 %x 和 %o 以及转换基于不同进位制的值:

    1. >>> # format also supports binary numbers
    2. >>> "int: {0:d};  hex: {0:x};  oct: {0:o};  bin: {0:b}".format(42)
    3. 'int: 42;  hex: 2a;  oct: 52;  bin: 101010'
    4. >>> # with 0x, 0o, or 0b as prefix:
    5. >>> "int: {0:d};  hex: {0:#x};  oct: {0:#o};  bin: {0:#b}".format(42)
    6. 'int: 42;  hex: 0x2a;  oct: 0o52;  bin: 0b101010'

    使用逗号作为千位分隔符:

    1. '1,234,567,890'

    表示为百分数:

    1. >>> points = 19
    2. >>> total = 22
    3. >>> 'Correct answers: {:.2%}'.format(points/total)
    4. 'Correct answers: 86.36%'

    使用特定类型的专属格式化:

    1. >>> import datetime
    2. >>> d = datetime.datetime(2010, 7, 4, 12, 15, 58)
    3. >>> '{:%Y-%m-%d %H:%M:%S}'.format(d)
    4. '2010-07-04 12:15:58'

    嵌套参数以及更复杂的示例:

    模板字符串提供了由 PEP 292 所描述的更简便的字符串替换方式。 模板字符串的一个主要用例是文本国际化 (i18n)，因为在此场景下，更简单的语法和功能使得文本翻译过程比使用 Python 的其他内置字符串格式化工具更为方便。 作为基于模板字符串构建以实现 i18n 的库的一个示例，请参看 包。

    模板字符串支持基于 $ 的替换，使用以下规则：

    • $$ 为转义符号；它会被替换为单个的 $。

    • $identifier 为替换占位符，它会匹配一个名为 "identifier" 的映射键。 在默认情况下，"identifier" 限制为任意 ASCII 字母数字（包括下划线）组成的字符串，不区分大小写，以下划线或 ASCII 字母开头。 在 $ 字符之后的第一个非标识符字符将表明占位符的终结。

    • ${identifier} 等价于 $identifier。 当占位符之后紧跟着有效的但又不是占位符一部分的标识符字符时需要使用，例如 "${noun}ification"。

    在字符串的其他位置出现 $ 将导致引发 ValueError。

    模块提供了实现这些规则的 Template 类。 有下列方法：

    class string.Template(template)

    该构造器接受一个参数作为模板字符串。

    • substitute(mapping, **kwds)

      执行模板替换，返回一个新字符串。 mapping 为任意字典类对象，其中的键将匹配模板中的占位符。 或者你也可以提供一组关键字参数，其中的关键字即对应占位符。 当同时给出 mapping 和 kwds 并且存在重复时，则以 kwds 中的占位符为优先。

    • safe_substitute(mapping, **kwds)

      类似于 substitute()，不同之处是如果有占位符未在 mapping 和 kwds 中找到，不是引发 异常，而是将原始占位符不加修改地显示在结果字符串中。 另一个与 substitute() 的差异是任何在其他情况下出现的 $ 将简单地返回 $ 而不是引发 。

      此方法被认为“安全”，因为虽然仍有可能发生其他异常，但它总是尝试返回可用的字符串而不是引发一个异常。 从另一方面来说，safe_substitute() 也可能根本算不上安全，因为它将静默地忽略错误格式的模板，例如包含多余的分隔符、不成对的花括号或不是合法 Python 标识符的占位符等等。

    的实例还提供一个公有数据属性：

    • template

      这是作为构造器的 template 参数被传入的对象。 一般来说，你不应该修改它，但并不强制要求只读访问。

    以下是一个如何使用模版的示例：

    1. >>> from string import Template
    2. >>> s = Template('$who likes $what')
    3. >>> s.substitute(who='tim', what='kung pao')
    4. 'tim likes kung pao'
    5. >>> d = dict(who='tim')
    6. >>> Template('Give $who $100').substitute(d)
    7. Traceback (most recent call last):
    8. ...
    9. ValueError: Invalid placeholder in string: line 1, col 11
    10. >>> Template('$who likes $what').substitute(d)
    11. Traceback (most recent call last):
    12. ...
    13. KeyError: 'what'
    14. >>> Template('$who likes $what').safe_substitute(d)
    15. 'tim likes $what'

    进阶用法：你可以派生 Template 的子类来自定义占位符语法、分隔符，或用于解析模板字符串的整个正则表达式。 为此目的，你可以重载这些类属性：

    • delimiter – This is the literal string describing a placeholder introducing delimiter. The default value is $. Note that this should not be a regular expression, as the implementation will call on this string as needed.

    • idpattern – This is the regular expression describing the pattern for non-braced placeholders (the braces will be added automatically as appropriate). The default value is the regular expression (?-i:[_a-zA-Z][_a-zA-Z0-9]*).

      注解

      Since default flags is re.IGNORECASE, pattern [a-z] can match with some non-ASCII characters. That’s why we use local -i flag here.

      While flags is kept to re.IGNORECASE for backward compatibility, you can override it to 0 or re.IGNORECASE | re.ASCII when subclassing.

    • flags – 将在编译用于识别替换内容的正则表达式被应用的正则表达式旗标。 默认值为 re.IGNORECASE。 请注意 re.VERBOSE 总是会被加为旗标，因此自定义的 idpattern 必须遵循详细正则表达式的约定。

      3.2 新版功能.

    作为另一种选项，你可以通过重载类属性 pattern 来提供整个正则表达式模式。 如果你这样做，该值必须为一个具有四个命名捕获组的正则表达式对象。 这些捕获组对应于上面已经给出的规则，以及无效占位符的规则：

    • escaped – 这个组匹配转义序列，在默认模式中即 $$。

    • named – 这个组匹配不带花括号的占位符名称；它不应当包含捕获组中的分隔符。

    • braced – 这个组匹配带有花括号的占位符名称；它不应当包含捕获组中的分隔符或者花括号。

    (s, sep=None)