文字列の部分的なフォーマット


128

文字列テンプレートsafe_substitute()関数と同様に、高度な文字列フォーマット方法で部分的な文字列フォーマットを行うことは可能ですか?

例えば:

s = '{foo} {bar}'
s.format(foo='FOO') #Problem: raises KeyError 'bar'

回答:


58

マッピングを上書きすることで、それを部分的なフォーマットにだますことができます。

import string

class FormatDict(dict):
    def __missing__(self, key):
        return "{" + key + "}"

s = '{foo} {bar}'
formatter = string.Formatter()
mapping = FormatDict(foo='FOO')
print(formatter.vformat(s, (), mapping))

印刷

FOO {bar}

もちろん、この基本的な実装は、基本的なケースでのみ正しく機能します。


7
これは次のようなより高度なフォーマットでは機能しません{bar:1.2f}
MaxNoe

「最も基本的な実装は基本的なケースでのみ正しく機能する」と言っていますが、これを拡張して、フォーマット仕様を削除しないようにする方法はありますか?
Tadhg McDonald-Jensen

5
@ TadhgMcDonald-Jensen:はい、方法があります。で文字列を返す代わりに、フォーマット仕様を含む元のプレースホルダーを返す方法で__missing__()オーバーライドするカスタムクラスのインスタンスを返します__format__()。概念実証:ideone.com/xykV7R
Sven Marnach

@SvenMarnachなぜあなたの概念実証はあなたの答えの本文にないのですか?それは少しわかりにくいです。宣伝を妨げる既知の警告はありますか?
norok2

1
@ norok2コメントで寄せられた質問への回答なので、コメントに返信を入れます。元の質問にはその要件は実際には含まれていませんでしたが、文字列を部分的にフォーマットしようとするのは少し変だと一般的には思っています。
Sven Marnach

128

フォーマットする順序がわかっている場合:

s = '{foo} {{bar}}'

次のように使用します。

ss = s.format(foo='FOO') 
print ss 
>>> 'FOO {bar}'

print ss.format(bar='BAR')
>>> 'FOO BAR'

あなたは指定することはできませんfoobar同時に-あなたは順番にそれをしなければなりません。


これの意味は何ですか?fooとbarの両方を指定した場合、何があってs.format(foo='FOO',bar='BAR')も引き続きを取得'FOO {bar}'します。明確にしていただけませんか?
n611x007 2013年

10
両方を同時に入力できないのは面倒です。これは、何らかの理由で文字列を段階的にフォーマットする必要があり、それらの段階の順序がわかっている場合に役立ちます。
アーレン2013年

1
あなたはおそらくこれをしなくて済むようにあなたのやり方を設計すべきですが、多分あなたはそれを強いられているのでしょう。
アーレン2013年

2
これについて知りませんでした。文字列をミニテンプレートとして "
準備

これは、コードの一部に文字列の一部を入力する場合に非常に役立ちますが、コードの別の部分に後で入力されるようにプレースホルダーを残します。
Alex Petralia 2017

98

あなたは短く、最も読みやすいpartial関数を使用することができfunctools、コーダーの意図も説明します:

from functools import partial

s = partial("{foo} {bar}".format, foo="FOO")
print s(bar="BAR")
# FOO BAR

2
最短かつ最も読みやすいソリューションだけでなく、コーダーの意図も説明します。Python3バージョン:python from functool import partial s = "{foo} {bar}".format s_foo = partial(s, foo="FOO") print(s_foo(bar="BAR")) # FOO BAR print(s(foo="FOO", bar="BAR")) # FOO BAR
Paul Brown、

@PaulBrown true、答えには愛が必要です;)
ypercubeᵀᴹ2018年

8
@ypercubeᵀᴹまあ、これがほとんどの人が探しているものかどうかはわかりません。partial()部分的にフォーマットされた文字列(つまり"FOO {bar}")で処理を行う必要がある場合、私は役に立ちません。
Delgan

1
これは、100%制御できない入力で操作している場合に適しています。想像してみてください:"{foo} {{bar}}".format(foo="{bar}").format(bar="123")他の例から。私は期待するでしょうが"{bar} 123"、彼らは出力します"123 123"
ベンジャミンマン

50

この制限.format()-部分的な置換を行うことができない-は私を悩ませてきました。

Formatterここで多くの回答に記載されているカスタムクラスの記述を評価し、lazy_formatなどのサードパーティパッケージの使用を検討した後、はるかに単純な組み込みソリューションを発見しました:テンプレート文字列

これは同様の機能を提供しますが、safe_substitute()メソッドの部分的な置換も提供します。テンプレート文字列には$接頭辞が必要です(少し変な感じがしますが、全体的な解決策の方が優れていると思います)。

import string
template = string.Template('${x} ${y}')
try:
  template.substitute({'x':1}) # raises KeyError
except KeyError:
  pass

# but the following raises no error
partial_str = template.safe_substitute({'x':1}) # no error

# partial_str now contains a string with partial substitution
partial_template = string.Template(partial_str)
substituted_str = partial_template.safe_substitute({'y':2}) # no error
print substituted_str # prints '12'

これに基づいて便利なラッパーを形成しました:

class StringTemplate(object):
    def __init__(self, template):
        self.template = string.Template(template)
        self.partial_substituted_str = None

    def __repr__(self):
        return self.template.safe_substitute()

    def format(self, *args, **kws):
        self.partial_substituted_str = self.template.safe_substitute(*args, **kws)
        self.template = string.Template(self.partial_substituted_str)
        return self.__repr__()


>>> s = StringTemplate('${x}${y}')
>>> s
'${x}${y}'
>>> s.format(x=1)
'1${y}'
>>> s.format({'y':2})
'12'
>>> print s
12

同様に、デフォルトの文字列フォーマットを使用するSvenの回答に基づくラッパー:

class StringTemplate(object):
    class FormatDict(dict):
        def __missing__(self, key):
            return "{" + key + "}"

    def __init__(self, template):
        self.substituted_str = template
        self.formatter = string.Formatter()

    def __repr__(self):
        return self.substituted_str

    def format(self, *args, **kwargs):
        mapping = StringTemplate.FormatDict(*args, **kwargs)
        self.substituted_str = self.formatter.vformat(self.substituted_str, (), mapping)

29

これが簡単な回避策として問題ないかどうかはわかりませんが、どうですか

s = '{foo} {bar}'
s.format(foo='FOO', bar='{bar}')

?:)


私は完全に同じことをしました、そうすることで警告があるかどうか私が知っていればいいのに
ramgo 2015

11

メソッドFormatterをオーバーライドする独自のものを定義する場合get_value、それを使用して未定義のフィールド名を必要なものにマップできます。

http://docs.python.org/library/string.html#string.Formatter.get_value

たとえば、あなたがマップすることができbar"{bar}"ならばbarkwargsからではありません。

ただし、そのためformat()には、文字列のformat()メソッドではなく、Formatterオブジェクトのメソッドを使用する必要があります。


Python> = 2.6機能のようです。
n611x007 2013年

11
>>> 'fd:{uid}:{{topic_id}}'.format(uid=123)
'fd:123:{topic_id}'

これを試してみてください。


うわー、まさに私が必要なもの!説明していただけますか?
セルゲイチジク2017

1
{{および}}は、フォーマットマークをエスケープする方法であるためformat()、置換、置換{{、および}}{}それぞれ実行しません。
7yl4r 2017年

このソリューションの問題は、double {{ }}が1つのフォーマットでのみ機能することです{}。さらに適用する必要がある場合は、さらに追加する必要があります。例。'fd:{uid}:{{topic_id}}'.format(uid=123).format(a=1)2番目の形式ではtopic_id値が提供されないため、エラーが返されます。
フランツィ

7

アンバーのコメントのおかげで、私はこれを思いつきました:

import string

try:
    # Python 3
    from _string import formatter_field_name_split
except ImportError:
    formatter_field_name_split = str._formatter_field_name_split


class PartialFormatter(string.Formatter):
    def get_field(self, field_name, args, kwargs):
        try:
            val = super(PartialFormatter, self).get_field(field_name, args, kwargs)
        except (IndexError, KeyError, AttributeError):
            first, _ = formatter_field_name_split(field_name)
            val = '{' + field_name + '}', first
        return val

Python> = 2.6機能のようです。
n611x007 2013年

私は間違いなくこのソリューションを使用しています:)ありがとう!
astrojuanlu 2015年

2
それらが存在する(そしてそれは実際に返された値のフォーマットの仕様を適用した場合、これは、変換およびフォーマット仕様を失うことに注意してくださいつまり、(。{field!s: >4}となり{field}
ブレンダン・アベル

3

私にとってはこれで十分でした:

>>> ss = 'dfassf {} dfasfae efaef {} fds'
>>> nn = ss.format('f1', '{}')
>>> nn
'dfassf f1 dfasfae efaef {} fds'
>>> n2 = nn.format('whoa')
>>> n2
'dfassf f1 dfasfae efaef whoa fds'

3

私が見つけたすべてのソリューションには、より高度な仕様または変換オプションに問題があるようです。@SvenMarnachのFormatPlaceholderは見事に巧妙ですが、強制(例:)では適切に機能しません。代わりに(この例では)メソッドが{a!s:>2s}呼び出され、追加のフォーマットが失われるためです。__str____format__

これが私が最終的に得たものであり、いくつかの主要な機能があります:

sformat('The {} is {}', 'answer')
'The answer is {}'

sformat('The answer to {question!r} is {answer:0.2f}', answer=42)
'The answer to {question!r} is 42.00'

sformat('The {} to {} is {:0.{p}f}', 'answer', 'everything', p=4)
'The answer to everything is {:0.4f}'
  • と同様のインターフェースを提供しますstr.format(単なるマッピングではありません)
  • より複雑な書式設定オプションをサポートします:
    • 強制 {k!s} {!r}
    • 入れ子 {k:>{size}}
    • getattr {k.foo}
    • getitem {k[0]}
    • 強制+フォーマット {k!s:>{size}}
import string


class SparseFormatter(string.Formatter):
    """
    A modified string formatter that handles a sparse set of format
    args/kwargs.
    """

    # re-implemented this method for python2/3 compatibility
    def vformat(self, format_string, args, kwargs):
        used_args = set()
        result, _ = self._vformat(format_string, args, kwargs, used_args, 2)
        self.check_unused_args(used_args, args, kwargs)
        return result

    def _vformat(self, format_string, args, kwargs, used_args, recursion_depth,
                 auto_arg_index=0):
        if recursion_depth < 0:
            raise ValueError('Max string recursion exceeded')
        result = []
        for literal_text, field_name, format_spec, conversion in \
                self.parse(format_string):

            orig_field_name = field_name

            # output the literal text
            if literal_text:
                result.append(literal_text)

            # if there's a field, output it
            if field_name is not None:
                # this is some markup, find the object and do
                #  the formatting

                # handle arg indexing when empty field_names are given.
                if field_name == '':
                    if auto_arg_index is False:
                        raise ValueError('cannot switch from manual field '
                                         'specification to automatic field '
                                         'numbering')
                    field_name = str(auto_arg_index)
                    auto_arg_index += 1
                elif field_name.isdigit():
                    if auto_arg_index:
                        raise ValueError('cannot switch from manual field '
                                         'specification to automatic field '
                                         'numbering')
                    # disable auto arg incrementing, if it gets
                    # used later on, then an exception will be raised
                    auto_arg_index = False

                # given the field_name, find the object it references
                #  and the argument it came from
                try:
                    obj, arg_used = self.get_field(field_name, args, kwargs)
                except (IndexError, KeyError):
                    # catch issues with both arg indexing and kwarg key errors
                    obj = orig_field_name
                    if conversion:
                        obj += '!{}'.format(conversion)
                    if format_spec:
                        format_spec, auto_arg_index = self._vformat(
                            format_spec, args, kwargs, used_args,
                            recursion_depth, auto_arg_index=auto_arg_index)
                        obj += ':{}'.format(format_spec)
                    result.append('{' + obj + '}')
                else:
                    used_args.add(arg_used)

                    # do any conversion on the resulting object
                    obj = self.convert_field(obj, conversion)

                    # expand the format spec, if needed
                    format_spec, auto_arg_index = self._vformat(
                        format_spec, args, kwargs,
                        used_args, recursion_depth-1,
                        auto_arg_index=auto_arg_index)

                    # format the object and append to the result
                    result.append(self.format_field(obj, format_spec))

        return ''.join(result), auto_arg_index


def sformat(s, *args, **kwargs):
    # type: (str, *Any, **Any) -> str
    """
    Sparse format a string.

    Parameters
    ----------
    s : str
    args : *Any
    kwargs : **Any

    Examples
    --------
    >>> sformat('The {} is {}', 'answer')
    'The answer is {}'

    >>> sformat('The answer to {question!r} is {answer:0.2f}', answer=42)
    'The answer to {question!r} is 42.00'

    >>> sformat('The {} to {} is {:0.{p}f}', 'answer', 'everything', p=4)
    'The answer to everything is {:0.4f}'

    Returns
    -------
    str
    """
    return SparseFormatter().format(s, *args, **kwargs)

このメソッドがどのように動作するかについてのテストをいくつか書いた後、さまざまな実装の問題を発見しました。誰かが洞察力に富んでいると感じたら、それらは下にあります。

import pytest


def test_auto_indexing():
    # test basic arg auto-indexing
    assert sformat('{}{}', 4, 2) == '42'
    assert sformat('{}{} {}', 4, 2) == '42 {}'


def test_manual_indexing():
    # test basic arg indexing
    assert sformat('{0}{1} is not {1} or {0}', 4, 2) == '42 is not 2 or 4'
    assert sformat('{0}{1} is {3} {1} or {0}', 4, 2) == '42 is {3} 2 or 4'


def test_mixing_manualauto_fails():
    # test mixing manual and auto args raises
    with pytest.raises(ValueError):
        assert sformat('{!r} is {0}{1}', 4, 2)


def test_kwargs():
    # test basic kwarg
    assert sformat('{base}{n}', base=4, n=2) == '42'
    assert sformat('{base}{n}', base=4, n=2, extra='foo') == '42'
    assert sformat('{base}{n} {key}', base=4, n=2) == '42 {key}'


def test_args_and_kwargs():
    # test mixing args/kwargs with leftovers
    assert sformat('{}{k} {v}', 4, k=2) == '42 {v}'

    # test mixing with leftovers
    r = sformat('{}{} is the {k} to {!r}', 4, 2, k='answer')
    assert r == '42 is the answer to {!r}'


def test_coercion():
    # test coercion is preserved for skipped elements
    assert sformat('{!r} {k!r}', '42') == "'42' {k!r}"


def test_nesting():
    # test nesting works with or with out parent keys
    assert sformat('{k:>{size}}', k=42, size=3) == ' 42'
    assert sformat('{k:>{size}}', size=3) == '{k:>3}'


@pytest.mark.parametrize(
    ('s', 'expected'),
    [
        ('{a} {b}', '1 2.0'),
        ('{z} {y}', '{z} {y}'),
        ('{a} {a:2d} {a:04d} {y:2d} {z:04d}', '1  1 0001 {y:2d} {z:04d}'),
        ('{a!s} {z!s} {d!r}', '1 {z!s} {\'k\': \'v\'}'),
        ('{a!s:>2s} {z!s:>2s}', ' 1 {z!s:>2s}'),
        ('{a!s:>{a}s} {z!s:>{z}s}', '1 {z!s:>{z}s}'),
        ('{a.imag} {z.y}', '0 {z.y}'),
        ('{e[0]:03d} {z[0]:03d}', '042 {z[0]:03d}'),
    ],
    ids=[
        'normal',
        'none',
        'formatting',
        'coercion',
        'formatting+coercion',
        'nesting',
        'getattr',
        'getitem',
    ]
)
def test_sformat(s, expected):
    # test a bunch of random stuff
    data = dict(
        a=1,
        b=2.0,
        c='3',
        d={'k': 'v'},
        e=[42],
    )
    assert expected == sformat(s, **data)

@SvenMarnachコードに似ていますが、テストで強制を正しく処理する回答を追加しました。
Tohiko

1

私の提案は次のようになります(Python3.6でテストされています):

class Lazymap(object):
       def __init__(self, **kwargs):
           self.dict = kwargs

       def __getitem__(self, key):
           return self.dict.get(key, "".join(["{", key, "}"]))


s = '{foo} {bar}'

s.format_map(Lazymap(bar="FOO"))
# >>> '{foo} FOO'

s.format_map(Lazymap(bar="BAR"))
# >>> '{foo} BAR'

s.format_map(Lazymap(bar="BAR", foo="FOO", baz="BAZ"))
# >>> 'FOO BAR'

更新: より洗練された方法(サブクラス化dictとオーバーロード__missing__(self, key))は次のとおりです:https : //stackoverflow.com/a/17215533/333403


0

完全に入力されるまで文字列を使用しないと仮定すると、次のクラスのようなことができます。

class IncrementalFormatting:
    def __init__(self, string):
        self._args = []
        self._kwargs = {}
        self._string = string

    def add(self, *args, **kwargs):
        self._args.extend(args)
        self._kwargs.update(kwargs)

    def get(self):
        return self._string.format(*self._args, **self._kwargs)

例:

template = '#{a}:{}/{}?{c}'
message = IncrementalFormatting(template)
message.add('abc')
message.add('xyz', a=24)
message.add(c='lmno')
assert message.get() == '#24:abc/xyz?lmno'

0

これを実現する方法はもう1つあります。つまり、変数を使用format%て置換する方法です。例えば:

>>> s = '{foo} %(bar)s'
>>> s = s.format(foo='my_foo')
>>> s
'my_foo %(bar)s'
>>> s % {'bar': 'my_bar'}
'my_foo my_bar'

0

非常に醜いですが、私にとって最も簡単な解決策は、次のようにすることです:

tmpl = '{foo}, {bar}'
tmpl.replace('{bar}', 'BAR')
Out[3]: '{foo}, BAR'

この方法でもtmpl、通常のテンプレートとして使用でき、必要な場合にのみ部分的なフォーマットを実行できます。この問題は些細すぎて、Mohan Rajのような過剰殺害ソリューションを使用できないことに気づきました。


0

最も有望なソリューションをテストした後、ここそこに、私はそれらのどれもが本当に、次の要件を満たしていない実現しました:

  1. str.format_map()テンプレートで認識される構文に厳密に従います。
  2. 複雑なフォーマットを保持できる、つまりFormat Mini-Languageを完全にサポートする

そこで、上記の要件を満たす独自のソリューションを作成しました。(編集:@SvenMarnachによるバージョン-この回答で報告されているように-私が必要とするコーナーケースを処理するようです)。

基本的に、テンプレート文字列を解析し、一致するネストされた{.*?}グループを見つけ(find_all()ヘルパー関数を使用)、フォーマットされた文字列を段階的に直接作成str.format_map()して、潜在的なをキャッチしましたKeyError

def find_all(
        text,
        pattern,
        overlap=False):
    """
    Find all occurrencies of the pattern in the text.

    Args:
        text (str|bytes|bytearray): The input text.
        pattern (str|bytes|bytearray): The pattern to find.
        overlap (bool): Detect overlapping patterns.

    Yields:
        position (int): The position of the next finding.
    """
    len_text = len(text)
    offset = 1 if overlap else (len(pattern) or 1)
    i = 0
    while i < len_text:
        i = text.find(pattern, i)
        if i >= 0:
            yield i
            i += offset
        else:
            break
def matching_delimiters(
        text,
        l_delim,
        r_delim,
        including=True):
    """
    Find matching delimiters in a sequence.

    The delimiters are matched according to nesting level.

    Args:
        text (str|bytes|bytearray): The input text.
        l_delim (str|bytes|bytearray): The left delimiter.
        r_delim (str|bytes|bytearray): The right delimiter.
        including (bool): Include delimeters.

    yields:
        result (tuple[int]): The matching delimiters.
    """
    l_offset = len(l_delim) if including else 0
    r_offset = len(r_delim) if including else 0
    stack = []

    l_tokens = set(find_all(text, l_delim))
    r_tokens = set(find_all(text, r_delim))
    positions = l_tokens.union(r_tokens)
    for pos in sorted(positions):
        if pos in l_tokens:
            stack.append(pos + 1)
        elif pos in r_tokens:
            if len(stack) > 0:
                prev = stack.pop()
                yield (prev - l_offset, pos + r_offset, len(stack))
            else:
                raise ValueError(
                    'Found `{}` unmatched right token(s) `{}` (position: {}).'
                        .format(len(r_tokens) - len(l_tokens), r_delim, pos))
    if len(stack) > 0:
        raise ValueError(
            'Found `{}` unmatched left token(s) `{}` (position: {}).'
                .format(
                len(l_tokens) - len(r_tokens), l_delim, stack.pop() - 1))
def safe_format_map(
        text,
        source):
    """
    Perform safe string formatting from a mapping source.

    If a value is missing from source, this is simply ignored, and no
    `KeyError` is raised.

    Args:
        text (str): Text to format.
        source (Mapping|None): The mapping to use as source.
            If None, uses caller's `vars()`.

    Returns:
        result (str): The formatted text.
    """
    stack = []
    for i, j, depth in matching_delimiters(text, '{', '}'):
        if depth == 0:
            try:
                replacing = text[i:j].format_map(source)
            except KeyError:
                pass
            else:
                stack.append((i, j, replacing))
    result = ''
    i, j = len(text), 0
    while len(stack) > 0:
        last_i = i
        i, j, replacing = stack.pop()
        result = replacing + text[j:last_i] + result
    if i > 0:
        result = text[0:i] + result
    return result

(このコードはFlyingCircusでも利用できます-免責事項:私はその主な作者です。)


このコードの使用法は次のとおりです。

print(safe_format_map('{a} {b} {c}', dict(a=-A-)))
# -A- {b} {c}

のは、(親切に自分のコードを共有@SvenMarnachことで私のお気に入りのソリューションにこれを比較してみましょう、ここそこに):

import string


class FormatPlaceholder:
    def __init__(self, key):
        self.key = key
    def __format__(self, spec):
        result = self.key
        if spec:
            result += ":" + spec
        return "{" + result + "}"
    def __getitem__(self, index):
        self.key = "{}[{}]".format(self.key, index)
        return self
    def __getattr__(self, attr):
        self.key = "{}.{}".format(self.key, attr)
        return self


class FormatDict(dict):
    def __missing__(self, key):
        return FormatPlaceholder(key)


def safe_format_alt(text, source):
    formatter = string.Formatter()
    return formatter.vformat(text, (), FormatDict(source))

ここにいくつかのテストがあります:

test_texts = (
    '{b} {f}',  # simple nothing useful in source
    '{a} {b}',  # simple
    '{a} {b} {c:5d}',  # formatting
    '{a} {b} {c!s}',  # coercion
    '{a} {b} {c!s:>{a}s}',  # formatting and coercion
    '{a} {b} {c:0{a}d}',  # nesting
    '{a} {b} {d[x]}',  # dicts (existing in source)
    '{a} {b} {e.index}',  # class (existing in source)
    '{a} {b} {f[g]}',  # dict (not existing in source)
    '{a} {b} {f.values}',  # class (not existing in source)

)
source = dict(a=4, c=101, d=dict(x='FOO'), e=[])

そしてそれを実行させるコード:

funcs = safe_format_map, safe_format_alt

n = 18
for text in test_texts:
    full_source = {**dict(b='---', f=dict(g='Oh yes!')), **source}
    print('{:>{n}s} :   OK   : '.format('str.format_map', n=n) + text.format_map(full_source))
    for func in funcs:
        try:
            print(f'{func.__name__:>{n}s} :   OK   : ' + func(text, source))
        except:
            print(f'{func.__name__:>{n}s} : FAILED : {text}')

その結果:

    str.format_map :   OK   : --- {'g': 'Oh yes!'}
   safe_format_map :   OK   : {b} {f}
   safe_format_alt :   OK   : {b} {f}
    str.format_map :   OK   : 4 ---
   safe_format_map :   OK   : 4 {b}
   safe_format_alt :   OK   : 4 {b}
    str.format_map :   OK   : 4 ---   101
   safe_format_map :   OK   : 4 {b}   101
   safe_format_alt :   OK   : 4 {b}   101
    str.format_map :   OK   : 4 --- 101
   safe_format_map :   OK   : 4 {b} 101
   safe_format_alt :   OK   : 4 {b} 101
    str.format_map :   OK   : 4 ---  101
   safe_format_map :   OK   : 4 {b}  101
   safe_format_alt :   OK   : 4 {b}  101
    str.format_map :   OK   : 4 --- 0101
   safe_format_map :   OK   : 4 {b} 0101
   safe_format_alt :   OK   : 4 {b} 0101
    str.format_map :   OK   : 4 --- FOO
   safe_format_map :   OK   : 4 {b} FOO
   safe_format_alt :   OK   : 4 {b} FOO
    str.format_map :   OK   : 4 --- <built-in method index of list object at 0x7f7a485666c8>
   safe_format_map :   OK   : 4 {b} <built-in method index of list object at 0x7f7a485666c8>
   safe_format_alt :   OK   : 4 {b} <built-in method index of list object at 0x7f7a485666c8>
    str.format_map :   OK   : 4 --- Oh yes!
   safe_format_map :   OK   : 4 {b} {f[g]}
   safe_format_alt :   OK   : 4 {b} {f[g]}
    str.format_map :   OK   : 4 --- <built-in method values of dict object at 0x7f7a485da090>
   safe_format_map :   OK   : 4 {b} {f.values}
   safe_format_alt :   OK   : 4 {b} {f.values}

ご覧のように、更新されたバージョンは、以前のバージョンが失敗していたコーナーケースをうまく処理するようになりました。


時間的には、約以内です。実際のtext形式(おそらく実際のsource)にもよりますが、50%ですsafe_format_map()が、私が実行したほとんどのテスト(もちろん、意味が何であれ)には優位性があるようです。

for text in test_texts:
    print(f'  {text}')
    %timeit safe_format(text * 1000, source)
    %timeit safe_format_alt(text * 1000, source)
  {b} {f}
3.93 ms ± 153 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
6.35 ms ± 51.9 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
  {a} {b}
4.37 ms ± 57.1 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
5.2 ms ± 159 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
  {a} {b} {c:5d}
7.15 ms ± 91.9 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
7.76 ms ± 69.5 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
  {a} {b} {c!s}
7.04 ms ± 138 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
7.56 ms ± 161 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
  {a} {b} {c!s:>{a}s}
8.91 ms ± 113 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
10.5 ms ± 181 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
  {a} {b} {c:0{a}d}
8.84 ms ± 147 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
10.2 ms ± 202 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
  {a} {b} {d[x]}
7.01 ms ± 197 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
7.35 ms ± 106 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
  {a} {b} {e.index}
11 ms ± 68.8 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
8.78 ms ± 405 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
  {a} {b} {f[g]}
6.55 ms ± 88.6 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
9.12 ms ± 159 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
  {a} {b} {f.values}
6.61 ms ± 55.9 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)
9.92 ms ± 98.8 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)

{d[x]}私が知る限り、これは有効なフォーマット文字列ではないことに注意してください。
Sven Marnach

@SvenMarnach公式ドキュメントは明示的に伝えfield_name ::= arg_name ("." attribute_name | "[" element_index "]")*、その両方str.format()str.format_map()理解します。これが有効なフォーマット文字列であることを示す十分な証拠があると思います。
norok2

str.format()角かっこ内の非整数インデックスでの使用例を挙げていただけますか?整数のインデックスのみを機能させることができます。
Sven Marnach

@SvenMarnach a = dict(b='YAY!'); '{a[b]}'.format_map(dict(a=a))があなたに「 'YAY!」
norok2

1
ああ、なるほど。私はこれがa[b]Pythonコードのように解釈されると想定していましたが、実際はa["b"]ありがとうです!
Sven Marnach

0

この関連する質問のようにformat、引数をに渡すために辞書をアンパックしたい場合は、次の方法を使用できます。

最初に、文字列sがこの質問と同じであると仮定します。

s = '{foo} {bar}'

値は次の辞書で与えられます:

replacements = {'foo': 'FOO'}

明らかにこれは動作しません:

s.format(**replacements)
#---------------------------------------------------------------------------
#KeyError                                  Traceback (most recent call last)
#<ipython-input-29-ef5e51de79bf> in <module>()
#----> 1 s.format(**replacements)
#
#KeyError: 'bar'

ただし、最初にすべての名前付き引数を取得し、sets中括弧で囲まれたそれ自体に引数をマップする辞書を作成できます。

from string import Formatter
args = {x[1]:'{'+x[1]+'}' for x in Formatter().parse(s)}
print(args)
#{'foo': '{foo}', 'bar': '{bar}'}

次に、args辞書を使用して、不足しているキーをに入力しreplacementsます。Python 3.5以降の場合、これを単一の式で行うことができます

new_s = s.format(**{**args, **replacements}}
print(new_s)
#'FOO {bar}'

古いバージョンのpythonの場合、次のように呼び出すことができますupdate

args.update(replacements)
print(s.format(**args))
#'FOO {bar}'

0

@ sven-marnachの回答が好きです。私の答えは、単にその拡張バージョンです。キーワード以外のフォーマットが可能で、余分なキーは無視されます。以下に使用例を示します(関数の名前はpython 3.6 f-stringフォーマッティングへの参照です):

# partial string substitution by keyword
>>> f('{foo} {bar}', foo="FOO")
'FOO {bar}'

# partial string substitution by argument
>>> f('{} {bar}', 1)
'1 {bar}'

>>> f('{foo} {}', 1)
'{foo} 1'

# partial string substitution with arguments and keyword mixed
>>> f('{foo} {} {bar} {}', '|', bar='BAR')
'{foo} | BAR {}'

# partial string substitution with extra keyword
>>> f('{foo} {bar}', foo="FOO", bro="BRO")
'FOO {bar}'

# you can simply 'pour out' your dictionary to format function
>>> kwargs = {'foo': 'FOO', 'bro': 'BRO'}
>>> f('{foo} {bar}', **kwargs)
'FOO {bar}'

そして、これが私のコードです:

from string import Formatter


class FormatTuple(tuple):
    def __getitem__(self, key):
        if key + 1 > len(self):
            return "{}"
        return tuple.__getitem__(self, key)


class FormatDict(dict):
    def __missing__(self, key):
        return "{" + key + "}"


def f(string, *args, **kwargs):
    """
    String safe substitute format method.
    If you pass extra keys they will be ignored.
    If you pass incomplete substitute map, missing keys will be left unchanged.
    :param string:
    :param kwargs:
    :return:

    >>> f('{foo} {bar}', foo="FOO")
    'FOO {bar}'
    >>> f('{} {bar}', 1)
    '1 {bar}'
    >>> f('{foo} {}', 1)
    '{foo} 1'
    >>> f('{foo} {} {bar} {}', '|', bar='BAR')
    '{foo} | BAR {}'
    >>> f('{foo} {bar}', foo="FOO", bro="BRO")
    'FOO {bar}'
    """
    formatter = Formatter()
    args_mapping = FormatTuple(args)
    mapping = FormatDict(kwargs)
    return formatter.vformat(string, args_mapping, mapping)

0

あなたは、テンプレートをたくさんやって、Pythonの文字列のテンプレート機能が内蔵さが不十分または不格好なことを見て見つけている場合はJinja2のを

ドキュメントから:

Jinjaは、Djangoのテンプレートをモデルにした、Python向けのモダンでデザイナーフレンドリーなテンプレート言語です。


0

@Sam Bourneコメントを読んで、@ SvenMarnachのコードを変更し{a!s:>2s}て、カスタムパーサーを作成せずに 強制的に(など)強制的に動作するようにしました。基本的な考え方は、文字列に変換するのではなく、不足しているキーを強制タグで連結することです。

import string
class MissingKey(object):
    def __init__(self, key):
        self.key = key

    def __str__(self):  # Supports {key!s}
        return MissingKeyStr("".join([self.key, "!s"]))

    def __repr__(self):  # Supports {key!r}
        return MissingKeyStr("".join([self.key, "!r"]))

    def __format__(self, spec): # Supports {key:spec}
        if spec:
            return "".join(["{", self.key, ":", spec, "}"])
        return "".join(["{", self.key, "}"])

    def __getitem__(self, i): # Supports {key[i]}
        return MissingKey("".join([self.key, "[", str(i), "]"]))

    def __getattr__(self, name): # Supports {key.name}
        return MissingKey("".join([self.key, ".", name]))


class MissingKeyStr(MissingKey, str):
    def __init__(self, key):
        if isinstance(key, MissingKey):
            self.key = "".join([key.key, "!s"])
        else:
            self.key = key

class SafeFormatter(string.Formatter):
    def __init__(self, default=lambda k: MissingKey(k)):
        self.default=default

    def get_value(self, key, args, kwds):
        if isinstance(key, str):
            return kwds.get(key, self.default(key))
        else:
            return super().get_value(key, args, kwds)

(例えば)このように使用します

SafeFormatter().format("{a:<5} {b:<10}", a=10)

次のテスト(@ norok2のテストに触発されたもの)は、従来の出力と上記のクラスに基づくformat_mapaのsafe_format_map2つのケースで出力をチェックします。

def safe_format_map(text, source):
    return SafeFormatter().format(text, **source)

test_texts = (
    '{a} ',             # simple nothing useful in source
    '{a:5d}',       # formatting
    '{a!s}',        # coercion
    '{a!s:>{a}s}',  # formatting and coercion
    '{a:0{a}d}',    # nesting
    '{d[x]}',       # indexing
    '{d.values}',   # member
)

source = dict(a=10,d=dict(x='FOO'))
funcs = [safe_format_map,
         str.format_map
         #safe_format_alt  # Version based on parsing (See @norok2)
         ]
n = 18
for text in test_texts:
    # full_source = {**dict(b='---', f=dict(g='Oh yes!')), **source}
    # print('{:>{n}s} :   OK   : '.format('str.format_map', n=n) + text.format_map(full_source))
    print("Testing:", text)
    for func in funcs:
        try:
            print(f'{func.__name__:>{n}s} : OK\t\t\t: ' + func(text, dict()))
        except:
            print(f'{func.__name__:>{n}s} : FAILED')

        try:
            print(f'{func.__name__:>{n}s} : OK\t\t\t: ' + func(text, source))
        except:
            print(f'{func.__name__:>{n}s} : FAILED')

どの出力

Testing: {a} 
   safe_format_map : OK         : {a} 
   safe_format_map : OK         : 10 
        format_map : FAILED
        format_map : OK         : 10 
Testing: {a:5d}
   safe_format_map : OK         : {a:5d}
   safe_format_map : OK         :    10
        format_map : FAILED
        format_map : OK         :    10
Testing: {a!s}
   safe_format_map : OK         : {a!s}
   safe_format_map : OK         : 10
        format_map : FAILED
        format_map : OK         : 10
Testing: {a!s:>{a}s}
   safe_format_map : OK         : {a!s:>{a}s}
   safe_format_map : OK         :         10
        format_map : FAILED
        format_map : OK         :         10
Testing: {a:0{a}d}
   safe_format_map : OK         : {a:0{a}d}
   safe_format_map : OK         : 0000000010
        format_map : FAILED
        format_map : OK         : 0000000010
Testing: {d[x]}
   safe_format_map : OK         : {d[x]}
   safe_format_map : OK         : FOO
        format_map : FAILED
        format_map : OK         : FOO
Testing: {d.values}
   safe_format_map : OK         : {d.values}
   safe_format_map : OK         : <built-in method values of dict object at 0x7fe61e230af8>
        format_map : FAILED
        format_map : OK         : <built-in method values of dict object at 0x7fe61e230af8>

-2

あなたはそれをデフォルトの引数を取る関数にラップすることができます:

def print_foo_bar(foo='', bar=''):
    s = '{foo} {bar}'
    return s.format(foo=foo, bar=bar)

print_foo_bar(bar='BAR') # ' BAR'

{foo}を空の文字列に置き換えます。問題は、欠落しているフィールドを無視するのではなく、さらなる最終的なフォーマットのための部分的なフォーマットについてです。
egvo
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.