częściowe formatowanie ciągu

128

Czy można wykonać częściowe formatowanie ciągu za pomocą zaawansowanych metod formatowania ciągów, podobnie jak w przypadku safe_substitute()funkcji szablonu ciągu ?

Na przykład:

s = '{foo} {bar}'
s.format(foo='FOO') #Problem: raises KeyError 'bar'
P3trus
źródło

Odpowiedzi:

58

Możesz oszukać częściowe formatowanie, nadpisując mapowanie:

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))

druk

FOO {bar}

Oczywiście ta podstawowa implementacja działa poprawnie tylko w podstawowych przypadkach.

Sven Marnach
źródło
7
To nie działa w przypadku bardziej zaawansowanych {bar:1.2f}
formatów,
Rozumiem, mówiąc, że „najbardziej podstawowa implementacja działa poprawnie tylko w podstawowych przypadkach”, ale czy istnieje sposób na rozszerzenie tego, aby nawet nie usunąć specyfikacji formatu?
Tadhg McDonald-Jensen
5
@ TadhgMcDonald-Jensen: Tak, jest sposób. Zamiast zwracać ciąg w __missing__(), zwróć wystąpienie klasy niestandardowej przesłaniającej __format__()w taki sposób, aby zwrócić oryginalny symbol zastępczy, w tym specyfikację formatu. Dowód koncepcji: ideone.com/xykV7R
Sven Marnach
@SvenMarnach dlaczego w treści odpowiedzi nie ma dowodu słuszności koncepcji ? To trochę nieuchwytne. Czy są jakieś znane zastrzeżenia, które uniemożliwiają Ci jej promowanie?
norok2
1
@ norok2 To odpowiedź na pytanie zadane w komentarzu, więc umieściłem odpowiedź w komentarzu. Oryginalne pytanie tak naprawdę nie zawierało tego wymogu i nadal uważam, że próba częściowego sformatowania ciągu jest trochę dziwna.
Sven Marnach
128

Jeśli wiesz, w jakiej kolejności formatujesz rzeczy:

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

Użyj tego w ten sposób:

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

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

Nie możesz określić, fooa barjednocześnie - musisz to robić po kolei.

aaren
źródło
Jaki to ma sens? Jeśli podam zarówno foo, jak i bar: s.format(foo='FOO',bar='BAR')to nadal mam 'FOO {bar}', bez względu na wszystko. Czy mógłbyś to wyjaśnić?
n611x007
10
To, że nie możesz wypełnić obu naraz, jest denerwujące. Jest to przydatne, gdy z jakiegoś powodu musisz formatować łańcuch etapami i znasz kolejność tych etapów.
aaren
1
Prawdopodobnie powinieneś zaplanować wyjście z konieczności robienia tego, ale być może jesteś do tego zmuszony.
aaren
2
Nie wiedziałem o tym. Miałem kilka przypadków użycia, w których chciałem „przygotować” ciąg jako mini szablon
ejrb.
Jest to bardzo przydatne, gdy wypełniasz część ciągu w jednej części kodu, ale pozostawiasz symbol zastępczy do wypełnienia później w innej części kodu.
Alex Petralia
99

Możesz skorzystać z partialfunkcji, z functoolsktórej jest krótka, najbardziej czytelna, a także opisuje intencje kodera:

from functools import partial

s = partial("{foo} {bar}".format, foo="FOO")
print s(bar="BAR")
# FOO BAR
Saikiran Yerram
źródło
2
Nie tylko najkrótsze i najbardziej czytelne rozwiązanie, ale także opisuje intencje programisty. Wersja Pythona3: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 prawda, odpowiedź wymaga trochę miłości;)
ypercubeᵀᴹ
8
@ ypercubeᵀᴹ Cóż, nie jestem pewien, czy właśnie tego szuka większość ludzi. partial()nie pomoże mi, jeśli potrzebuję przetworzyć częściowo sformatowany ciąg (to znaczy "FOO {bar}").
Delgan
1
Jest to lepsze w przypadku, gdy operujesz na wejściu, nad którym nie masz 100% kontroli. Wyobraź sobie: "{foo} {{bar}}".format(foo="{bar}").format(bar="123")z innych przykładów. Spodziewałbym się, "{bar} 123"ale wychodzą "123 123".
Benjamin Manns
50

To ograniczenie .format()- niezdolność do częściowych podstawień - niepokoi mnie.

Po Formatterprzeanalizowaniu pisania niestandardowej klasy, jak opisano w wielu odpowiedziach tutaj, a nawet rozważeniu użycia pakietów innych firm, takich jak lazy_format , odkryłem znacznie prostsze wbudowane rozwiązanie: ciągi szablonów

Zapewnia podobną funkcjonalność, ale zapewnia również dokładną safe_substitute()metodę częściowego zastępowania . Ciągi szablonów muszą mieć $prefiks (co wydaje się nieco dziwne - ale myślę, że ogólne rozwiązanie jest lepsze).

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'

Utworzono wygodne opakowanie na podstawie tego:

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

Podobnie opakowanie oparte na odpowiedzi Svena, które używa domyślnego formatowania ciągu:

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)
Mohan Raj
źródło
29

Nie jestem pewien, czy jest to w porządku, jako szybkie obejście, ale co powiesz na to

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

? :)

Memphis
źródło
Zrobiłem to samo, żałuję, że nie wiedziałem, czy są jakieś zastrzeżenia.
ramgo
11

Jeśli zdefiniujesz własną, Formatterktóra zastępuje get_valuemetodę, możesz użyć jej do odwzorowania niezdefiniowanych nazw pól na dowolne:

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

Na przykład, możesz zmapować bardo "{bar}"if barnie znajduje się w kwargs.

Wymaga to jednak użycia format()metody obiektu Formatter, a nie metody ciągu format().

Bursztyn
źródło
Wygląda na funkcję w Pythonie> = 2.6.
n611x007
11
>>> 'fd:{uid}:{{topic_id}}'.format(uid=123)
'fd:123:{topic_id}'

Wypróbuj to.

Pengfei.X
źródło
Wow, dokładnie to, czego potrzebuję! Czy mógłbyś to wyjaśnić?
Sergey Chizhik
1
{{i }}jest sposobem na ucieczkę znaczniki formatujące, więc format()nie wykonuje podstawienie i zastępuje {{i }}z {i }, odpowiednio.
7yl4r
Problem z tym rozwiązaniem polega na tym, że podwójny {{ }}działa tylko dla jednego formatu, jeśli chcesz zastosować więcej, musisz dodać więcej {}. dawny. 'fd:{uid}:{{topic_id}}'.format(uid=123).format(a=1)zwróci błąd, ponieważ drugi format nie dostarcza topic_idwartości.
Franzi,
7

Dzięki komentarzowi Amber wymyśliłem to:

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
gatto
źródło
Wygląda na funkcję w Pythonie> = 2.6.
n611x007
Zdecydowanie korzystam z tego rozwiązania :) Dzięki!
astrojuanlu
2
Należy pamiętać, że spowoduje to utratę specyfikacji konwersji i formatu, jeśli one istnieją (i faktycznie zastosuje specyfikację formatu do zwróconej wartości. Np. ( {field!s: >4}Staje się{field}
Brendan Abel
3

Dla mnie to wystarczyło:

>>> 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'
David Veza
źródło
3

Wszystkie znalezione przeze mnie rozwiązania wydawały się mieć problemy z bardziej zaawansowanymi specyfikacjami lub opcjami konwersji. @ SvenMarnach's FormatPlaceholder jest cudownie sprytny, ale nie działa poprawnie z przymusem (np. {a!s:>2s}), Ponieważ wywołuje __str__metodę (w tym przykładzie) zamiast __format__i tracisz dodatkowe formatowanie.

Oto, na czym skończyłem i niektóre z jego kluczowych funkcji:

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}'
  • zapewnia podobny interfejs jak str.format(nie tylko mapowanie)
  • obsługuje bardziej złożone opcje formatowania:
    • przymus {k!s} {!r}
    • zagnieżdżanie {k:>{size}}
    • getattr {k.foo}
    • Zdobądź przedmiot {k[0]}
    • przymus + formatowanie {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)

Odkryłem problemy z różnymi implementacjami po napisaniu kilku testów dotyczących tego, jak chciałem, aby ta metoda zachowywała się. Są poniżej, jeśli ktoś uzna je za wnikliwe.

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)
Sam Bourne
źródło
Dodałem odpowiedź, która jest podobna do kodu @SvenMarnach, ale która poprawnie obsługuje wymuszanie dla twoich testów.
Tohiko
1

Moja sugestia byłaby następująca (przetestowana z Pythonem 3.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'

Aktualizacja: Jeszcze bardziej elegancki sposób (podklasy dicti przeciążanie __missing__(self, key)) pokazano tutaj: https://stackoverflow.com/a/17215533/333403

cknoll
źródło
0

Zakładając, że nie użyjesz ciągu, dopóki nie zostanie całkowicie wypełniony, możesz zrobić coś takiego jak ta klasa:

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)

Przykład:

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'
Brett Beatty
źródło
0

Jest jeszcze jeden sposób, aby to osiągnąć, tj. Używając formati %zastępując zmienne. Na przykład:

>>> s = '{foo} %(bar)s'
>>> s = s.format(foo='my_foo')
>>> s
'my_foo %(bar)s'
>>> s % {'bar': 'my_bar'}
'my_foo my_bar'
Moinuddin Quadri
źródło
0

Bardzo brzydkie, ale dla mnie najprostsze rozwiązanie to po prostu:

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

W ten sposób nadal możesz używać tmpljako zwykłego szablonu i wykonywać częściowe formatowanie tylko wtedy, gdy jest to konieczne. Uważam, że ten problem jest zbyt trywialny, by użyć rozwiązania przesadnego, takiego jak Mohan Raja.

michcio1234
źródło
0

Po przetestowaniu najbardziej obiecujących rozwiązań tu i ówdzie zdałem sobie sprawę, że żadne z nich tak naprawdę nie spełnia następujących wymagań:

  1. ściśle przestrzegać składni rozpoznanej przez str.format_map()szablon;
  2. możliwość zachowania złożonego formatowania, tj. pełne wsparcie dla Format Mini-Language

Napisałem więc własne rozwiązanie, które spełnia powyższe wymagania. ( EDYCJA : teraz wersja autorstwa @SvenMarnach - jak opisano w tej odpowiedzi - wydaje się obsługiwać narożne przypadki, których potrzebowałem).

Zasadniczo skończyło się na przeanalizowaniu ciągu szablonu, znalezieniu pasujących {.*?}grup zagnieżdżonych (za pomocą find_all()funkcji pomocniczej) i zbudowaniu sformatowanego ciągu stopniowo i bezpośrednio przy użyciu, str.format_map()jednocześnie łapiąc jakikolwiek potencjał 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

(Ten kod jest również dostępny w FlyingCircus - ZRZECZENIE SIĘ: Jestem jego głównym autorem.)


Zastosowanie tego kodu wyglądałoby tak:

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

Porównajmy to z moim ulubionym rozwiązaniem (autorstwa @SvenMarnach, który uprzejmie udostępnił tu i tam swój kod ):

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))

Oto kilka testów:

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=[])

i kod do uruchomienia:

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}')

w wyniku:

    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}

jak widać, zaktualizowana wersja wydaje się teraz dobrze radzić sobie z narożnymi przypadkami, w których wcześniejsza wersja zawodziła.


W międzyczasie są w ciągu ok. 50% siebie nawzajem, w zależności od faktycznego textformatu (i prawdopodobnie rzeczywistego source), ale safe_format_map()wydaje się, że mają przewagę w większości przeprowadzonych przeze mnie testów (cokolwiek one oznaczają, oczywiście):

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)
norok2
źródło
Zauważ, że {d[x]}nie jest to prawidłowy ciąg formatu, o ile wiem.
Sven Marnach
@SvenMarnach Oficjalna dokumentacja wyraźnie to mówi, field_name ::= arg_name ("." attribute_name | "[" element_index "]")*jednocześnie str.format()i str.format_map()rozumie. Powiedziałbym, że jest wystarczająco dużo dowodów na to, że jest to prawidłowy ciąg formatu.
norok2
Czy możesz podać przykład użycia str.format()z indeksem niecałkowitym w nawiasach kwadratowych? Mogę sprawić, że działają tylko indeksy całkowite.
Sven Marnach
@SvenMarnach a = dict(b='YAY!'); '{a[b]}'.format_map(dict(a=a))dostajesz `` YAY! ''
norok2
1
O, rozumiem. Zakładałem, że zostanie to zinterpretowane jak a[b]w kodzie Pythona, ale w rzeczywistości jest to a["b"]dzięki!
Sven Marnach
0

Jeśli chcesz rozpakować słownik, aby przekazać argumenty format, jak w tym pokrewnym pytaniu , możesz użyć następującej metody.

Najpierw załóżmy, że ciąg sjest taki sam jak w tym pytaniu:

s = '{foo} {bar}'

a wartości są podane w następującym słowniku:

replacements = {'foo': 'FOO'}

Oczywiście to nie zadziała:

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

Możesz jednak najpierw pobrać setze wszystkich nazwanych argumentóws i utworzyć słownik, który mapuje argument na siebie zawinięty w nawiasy klamrowe:

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

Teraz użyj argssłownika, aby uzupełnić brakujące klucze replacements. W przypadku Pythona 3.5+ możesz to zrobić w jednym wyrażeniu :

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

W przypadku starszych wersji Pythona możesz wywołać update:

args.update(replacements)
print(s.format(**args))
#'FOO {bar}'
pault
źródło
0

Podoba mi się odpowiedź @ sven-marnach. Moja odpowiedź to po prostu jego rozszerzona wersja. Umożliwia formatowanie bez słów kluczowych i ignoruje dodatkowe klucze. Oto przykłady użycia (nazwa funkcji jest odniesieniem do formatowania f-stringów w Pythonie 3.6):

# 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}'

A oto mój kod:

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)
egvo
źródło
0

Jeśli często tworzysz szablony i stwierdzasz, że wbudowana w Pythonie funkcja tworzenia szablonów ciągów znaków jest niewystarczająca lub niezgrabna, spójrz na Jinja2 .

Z dokumentów:

Jinja to nowoczesny i przyjazny dla projektantów język szablonów dla Pythona, wzorowany na szablonach Django.

Vito
źródło
0

Czytając komentarz @Sam Bourne, zmodyfikowałem kod @ SvenMarnach, aby działał poprawnie z przymusem (jak {a!s:>2s}) bez pisania niestandardowego parsera. Podstawowym pomysłem nie jest konwersja na łańcuchy, ale połączenie brakujących kluczy ze znacznikami przymusu.

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)

Użyj (na przykład) w ten sposób

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

Poniższe testy (inspirowane testami z @ norok2) sprawdzają dane wyjściowe dla tradycyjnego format_mapi safe_format_mapopartego na powyższej klasie w dwóch przypadkach: z poprawnymi słowami kluczowymi lub bez nich.

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')

Jakie wyjścia

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>
Tohiko
źródło
-2

Możesz umieścić to w funkcji, która przyjmuje domyślne argumenty:

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

print_foo_bar(bar='BAR') # ' BAR'
Trevor
źródło
Zastępujesz {foo} pustym ciągiem. Pytanie dotyczy częściowego formatowania w celu dalszego formatowania końcowego, bez ignorowania brakujących pól.
egvo