Jinja: 재정의 가능한 자동 이스케이프

자동 이스케이프가 이를 수행하는 적절한 방법인지 확실하지 않습니다.

필터를 사용하는 것이 좋습니다. tojson 는 yaml이 json의 상위 집합이기 때문에 좋은 후보로 보입니다.

그 외에도 YAML을 빌드하기 위해 문자열 기반 템플릿을 사용하는 이유가 있습니까? Python 사전을 YAML로 직렬화하는 것이 훨씬 깔끔해 보입니다. 이것이 충분하지 않을 수 있는 유일한 경우는 주석을 포함하려는 경우입니다. 그러나 이 경우 비파괴적 읽기/쓰기를 처리하는 YAML 엔진을 사용할 수 있으므로 주석과 빈 항목이 있는 YAML 템플릿을 로드한 다음 데이터를 업데이트하고 YAML로 다시 직렬화하면 됩니다.

자동 이스케이프를 사용하는 요점은 모든 단일 변수 확장에 필터를 적용하고 싶지 않다는 것입니다.

우리의 사용 사례는 마이크로 서비스에 대한 구성 파일을 작성하는 것입니다. 각 서비스에 포함된 "템플릿"이 있으며 해당 템플릿에 특정한 환경별 구성으로 채우고 싶습니다. 나는 YAML을 직접 사용하는 것이 더 깨끗하다는 데 동의하지만 아직 위치를 알지 못하는 변수를 대체하는 방법을 알고 있는 일반 "엔진"을 찾을 수 없습니다. (YAML 별칭과 참조가 있지만 실제로는 적합하지 않습니다. 순환 구조를 직렬화하는 데 더 적합합니다.) YAML을 사용하여 이것을 작동하게 하는 방법을 생각할 수 있지만, 일종의 해키도. 이 설정은 또한 우리가 수행할 수 있는 대체 유형에 대한 더 많은 제어를 제공하지만 실제로는 실제로 이를 사용하지 않습니다.

jinja 플러그인을 사용하여 모든 변수에 필터를 적용할 수 있습니다. i18n 블록을 사용할 필요가 없다면 그렇게 어렵지 않습니다. 내가 얼마 전에 작성한 것에서 아이디어를 얻을 수 있습니다. https://github.com/indico/indico/blob/master/indico/web/flask/templating.py#L187

이것은 매우 도움이 됩니다. 감사합니다! 예를 들어 변수에 |safe 플래그를 지정할 수 있기 때문에 자동 이스케이프가 여전히 문제를 해결하는 데 괜찮은 접근 방식이라고 생각합니다. 그러나 개념적으로 이것은 자동 이스케이프와 같지 않다는 점을 인정합니다. 변수가 유효한 YAML인지 확인하는 것이 아니라 특정 방식으로 형식을 지정하기 때문입니다. 확장자를 쓰겠습니다.

@glasserc 이 확장으로 성공하셨나요? 비슷한 문제가 있습니다. 해결책을 지적하거나 몇 가지 아이디어를 공유할 수 있습니까?

내 솔루션의 첫 번째 부분은 필터를 통해 모든 변수 호출을 실행하는 확장이었습니다. 이것이 내가 작업을 수행하는 데 필요한 최소한의 것입니다.

import jinja2.ext
from jinja2.lexer import Token

class YAMLEverythingExtension(jinja2.ext.Extension):
    """
    Insert a `|yaml` filter at the end of every variable substitution.

    This will ensure that all injected values are converted to YAML.
    """
    def filter_stream(self, stream):
        # This is based on https://github.com/indico/indico/blob/master/indico/web/flask/templating.py.
        for token in stream:
            if token.type == 'variable_end':
                yield Token(token.lineno, 'pipe', '|')
                yield Token(token.lineno, 'name', 'yaml')
            yield token

예를 들어 변수 블록에 명시적으로 safe 또는 yaml 필터가 있는 경우 필터 삽입을 건너뛸 수 있습니다. 그러나 나는 결코 그것을 위한 시간을 필요로/가지는 것을 끝내지 못했습니다.

두 번째 부분은 필터 자체입니다. yaml.dump 사용하는 것만으로는 충분히 정교하지 않았기 때문에 yaml 내부를 약간 찔러야 했습니다.

import cStringIO
import yaml

def yaml_filter(val):
    """Serialize some value in isolation, not as part of any document.

    We can't just use yaml.dump because that outputs an entire document, including newlines, which isn't helpful for
    inserting into a YAML document."""
    if isinstance(val, jinja2.Undefined):
        val._fail_with_undefined_error()
    stream = cStringIO.StringIO()
    dumper = yaml.dumper.Dumper(stream)
    dumper.open()
    node = dumper.represent_data(val)
    dumper.serialize(node)
    # The serialized node tends to have a \n at the end.  The template might not
    # want a \n inserted here, e.g. if two variables are on the same line, so
    # strip.
    return stream.getvalue().strip()

이것은 주어진 이름의 필터가 환경에서 사용 가능한지 확인하는 것을 포함하여 모든 것을 하나로 묶습니다.

from jinja2 import loaders
from jinja2 import Environment, StrictUndefined

def get_environment():
    """Create a standard Jinja environment that has everything in it.
    """
    jinja_env = Environment(extensions=(YAMLEverythingExtension,),
                            # some other options that we use at work
                            loader=loaders.FileSystemLoader(['.', '/']),
                            undefined=StrictUndefined)
    jinja_env.filters["yaml"] = yaml_filter
    return jinja_env

이것은 HTML이 아닌 템플릿을 이스케이프하는 데 여전히 유용합니다. Jinja2를 사용하여 JSON을 생성하고 HTML 이스케이프 대신 JSON 이스케이프를 사용하고 싶습니다.

JSON을 생성하기 위해 Jinja 템플릿 또는 기타 문자열 기반 템플릿 언어 또는 문자열 작업을 사용하는 것은 잘못된 것입니다. YAML도 인간 친화적이기 때문에 YAML에 대해 이렇게 하는 이유를 알 수 있지만 JSON은 예를 들어 Jinja 템플릿이 아니라 Python dict에서 생성되어야 합니다.

(그런데 왜 하고 싶은지, 무엇을 하려고 하는지 궁금합니다 :p)

그게 말이 되는 것 같아요. :-) 나는 #571을 닫을 것이다.

JSON은 Jinja에서 생성하는 것이 좋지 않을 수도 있지만 jinja를 사용하여 LaTeX를 생성하고 있기 때문에 이런 종류의 기능에 매우 관심이 있습니다. block_start_string 및 block_end_string 및 기타 Environment 를 수정하여 대부분의 방법을 얻었습니다. 지금은 autoescape = False 를 설정했지만 이상적으로는 자신을 탈출하기 위해 무언가를 전달하고 싶습니다(정규식처럼).

이는 일반 텍스트 및 마크다운 생성에도 적용됩니다. Jinja는 지금까지 비-html 문서를 템플릿화하는 훌륭한 도구였습니다.

여러 조건부 쿼리 부분이 필요한 경우 str.format() 를 사용하면 지저분해질 수 있기 때문에 jinja를 사용하여 SQL 쿼리를 생성하는 방법을 찾고 있었습니다.

이를 수행하는 라이브러리, 즉 사용자 정의 이스케이프 기능과 jinjasql 을 허용하는 jinja-vanish 가 이미 있습니다.
첫 번째는 컴파일 시 상수 평가를 비활성화해야 하는데, 이는 약간 좋지 않습니다. 다른 하나
필터 접근 방식을 사용하여 모든 변수 표현식에 괜찮지만 옳지 않다고 느끼는 특수 필터를 추가합니다.

자세히 들여다보지는 않았지만 구현하는 것은 그리 어렵지 않은 것 같습니다. 이것이 고려될 수 있거나 라이브러리의 범위를 벗어났습니까?