feat(filters): add kwargs support to indent filter for Jinja2 parity

The indent filter now accepts width, first, and blank as keyword
arguments in both Rust and Go, matching Jinja2's signature.  #864

Author: mitsuhiko

CHANGELOG.md

@@ -4,6 +4,7 @@ All notable changes to MiniJinja are documented here.
 
 ## Unreleased
 
+* Added keyword argument support (`width`, `first`, `blank`) to the `indent` filter for Jinja2 compatibility in Rust and Go.  #864
 * Added support for dotted integer lookup (for example `foo.0`) in Rust and Go for Jinja compatibility.  #881
 * Added support for dotted filter and test names (including `foo . bar . baz`) for Jinja compatibility.  #879
 * Fixed string escape handling to preserve unknown escapes (such as `\s`) for Jinja compatibility in Rust and Go.  #880

minijinja-go/filters/filters.go

@@ -2265,6 +2265,9 @@ func FilterAttr(_ State, val value.Value, args []value.Value, _ map[string]value
 // optional parameter determines whether to indent the first line (default: false).
 // The third optional parameter determines whether to indent blank lines (default: false).
 //
+// Parameters can also be provided as keyword arguments for Jinja2 compatibility:
+// width, first, and blank.
+//
 // Example:
 //
 //	env := minijinja.NewEnvironment()
@@ -2276,35 +2279,51 @@ func FilterAttr(_ State, val value.Value, args []value.Value, _ map[string]value
 //	{{ yaml_content|indent(2) }}
 //	{{ yaml_content|indent(2, true) }}
 //	{{ yaml_content|indent(2, true, true) }}
+//	{{ yaml_content|indent(width=4, first=true, blank=false) }}
 func FilterIndent(_ State, val value.Value, args []value.Value, kwargs map[string]value.Value) (value.Value, error) {
 	s, ok := val.AsString()
 	if !ok {
 		return val, nil
 	}
 
-	if len(kwargs) > 0 {
-		return value.Undefined(), mjerrors.NewError(mjerrors.ErrTooManyArguments, "too many keyword arguments")
-	}
-
 	width := 4
 	if len(args) > 0 {
 		if w, ok := args[0].AsInt(); ok {
 			width = int(w)
 		}
+	} else if v, ok := kwargs["width"]; ok {
+		if w, ok := v.AsInt(); ok {
+			width = int(w)
+		}
+		delete(kwargs, "width")
 	}
 
 	first := false
 	if len(args) > 1 {
 		if b, ok := args[1].AsBool(); ok {
 			first = b
 		}
+	} else if v, ok := kwargs["first"]; ok {
+		if b, ok := v.AsBool(); ok {
+			first = b
+		}
+		delete(kwargs, "first")
 	}
 
 	blank := false
 	if len(args) > 2 {
 		if b, ok := args[2].AsBool(); ok {
 			blank = b
 		}
+	} else if v, ok := kwargs["blank"]; ok {
+		if b, ok := v.AsBool(); ok {
+			blank = b
+		}
+		delete(kwargs, "blank")
+	}
+
+	if len(kwargs) > 0 {
+		return value.Undefined(), mjerrors.NewError(mjerrors.ErrTooManyArguments, "too many keyword arguments")
 	}
 
 	indent := strings.Repeat(" ", width)

minijinja/src/filters.rs

@@ -1083,13 +1083,21 @@ mod builtins {
     /// {{ global_config|indent(2,true) }}     # indent whole Value with two spaces
     /// {{ global_config|indent(2,true,true)}} # indent whole Value and all blank lines
     /// ```
+    ///
+    /// The parameters can also be provided as keyword arguments for
+    /// compatibility with Jinja2: `width`, `first`, and `blank`.
+    ///
+    /// ```jinja
+    /// {{ global_config|indent(width=4, first=true, blank=false) }}
+    /// ```
     #[cfg_attr(docsrs, doc(cfg(all(feature = "builtins"))))]
     pub fn indent(
         mut value: String,
-        width: usize,
+        width: Option<usize>,
         indent_first_line: Option<bool>,
         indent_blank_lines: Option<bool>,
-    ) -> String {
+        kwargs: Kwargs,
+    ) -> Result<String, Error> {
         fn strip_trailing_newline(input: &mut String) {
             if input.ends_with('\n') {
                 input.truncate(input.len() - 1);
@@ -1099,17 +1107,31 @@ mod builtins {
             }
         }
 
+        let width: usize = match width {
+            Some(width) => width,
+            None => ok!(kwargs.get::<Option<usize>>("width")).unwrap_or(4),
+        };
+        let indent_first_line: bool = match indent_first_line {
+            Some(v) => v,
+            None => ok!(kwargs.get::<Option<bool>>("first")).unwrap_or(false),
+        };
+        let indent_blank_lines: bool = match indent_blank_lines {
+            Some(v) => v,
+            None => ok!(kwargs.get::<Option<bool>>("blank")).unwrap_or(false),
+        };
+        ok!(kwargs.assert_all_used());
+
         strip_trailing_newline(&mut value);
         let indent_with = " ".repeat(width);
         let mut output = String::new();
         let mut iterator = value.split('\n');
-        if !indent_first_line.unwrap_or(false) {
+        if !indent_first_line {
             output.push_str(iterator.next().unwrap());
             output.push('\n');
         }
         for line in iterator {
             if line.is_empty() {
-                if indent_blank_lines.unwrap_or(false) {
+                if indent_blank_lines {
                     output.push_str(&indent_with);
                 }
             } else {
@@ -1118,7 +1140,7 @@ mod builtins {
             output.push('\n');
         }
         strip_trailing_newline(&mut output);
-        output
+        Ok(output)
     }
 
     /// URL encodes a value.

minijinja/tests/inputs/filters.txt

@@ -91,6 +91,11 @@ slice-fill: {{ range(10)|slice(3, '-') }}
 items: {{ dict(a=1)|items }}
 indent: {{ "foo\nbar\nbaz"|indent(2)|tojson }}
 indent-first-line: {{ "foo\nbar\nbaz"|indent(2, true)|tojson }}
+indent-kwargs-width: {{ "foo\nbar\nbaz"|indent(width=4)|tojson }}
+indent-kwargs-first: {{ "foo\nbar\nbaz"|indent(4, first=true)|tojson }}
+indent-kwargs-blank: {{ "foo\nbar\n\nbaz"|indent(4, first=false, blank=true)|tojson }}
+indent-kwargs-all: {{ "foo\nbar\n\nbaz"|indent(width=2, first=true, blank=true)|tojson }}
+indent-default: {{ "foo\nbar\nbaz"|indent|tojson }}
 int-abs: {{ -42|abs }}
 float-abs: {{ -42.5|abs }}
 int-round: {{ 42|round }}

minijinja/tests/snapshots/[email protected]

@@ -1,7 +1,7 @@
 ---
 source: minijinja/tests/test_templates.rs
 assertion_line: 137
-description: "lower: {{ word|lower }}\nupper: {{ word|upper }}\ntitle: {{ word|title }}\ntitle-sentence: {{ \"the bIrd, is The:word\"|title }}\ntitle-three-words: {{ three_words|title }}\ncapitalize: {{ word|capitalize }}\ncapitalize-three-words: {{ three_words|capitalize }}\nreplace: {{ word|replace(\"B\", \"th\") }}\nescape: {{ \"<\"|escape }}\ne: {{ \"<\"|e }}\ndouble-escape: {{ \"<\"|escape|escape }}\nsafe: {{ \"<\"|safe|escape }}\nlist-length: {{ list|length }}\nlist-from-list: {{ list|list }}\nlist-from-map: {{ map|list }}\nlist-from-word: {{ word|list }}\nlist-from-undefined: {{ undefined|list }}\nbool-empty-string: {{ \"\"|bool }}\nbool-non-empty-string: {{ \"hello\"|bool }}\nbool-empty-list: {{ []|bool }}\nbool-non-empty-list: {{ [42]|bool }}\nbool-undefined: {{ undefined|bool }}\nmap-length: {{ map|length }}\nstring-length: {{ word|length }}\nstring-count: {{ word|count }}\nreverse-list: {{ list|reverse }}\nreverse-string: {{ word|reverse }}\ntrim: |{{ word_with_spaces|trim }}|\ntrim-bird: {{ word|trim(\"Bd\") }}\njoin-default: {{ list|join }}\njoin-pipe: {{ list|join(\"|\") }}\njoin_string: {{ word|join('-') }}\njoin-empty-strings: {{ [undefined, \"\", \"blub\", \"\", undefined, 42]|join('|') }}\ndefault: {{ undefined|default == \"\" }}\ndefault-value: {{ undefined|default(42) }}\ndefault-value-falsy: {{ \"\"|default(\"b\", true) }}\nd: {{ undefined|d == \"\" }}\nd-value: {{ undefined|d(42) }}\nfirst-list: {{ list|first }}\nfirst-word: {{ word|first }}\nfirst-undefined: {{ []|first is undefined }}\nlast-list: {{ list|last }}\nlast-word: {{ word|last }}\nlast-undefined: {{ []|first is undefined }}\nmin: {{ other_list|min }}\nmax: {{ other_list|max }}\nsort: {{ other_list|sort }}\nsort-reverse: {{ other_list|sort(reverse=true) }}\nsort-case-insensitive: {{ [\"B\", \"a\", \"C\", \"z\"]|sort }}\nsort-case-sensitive: {{ [\"B\", \"a\", \"C\", \"z\"]|sort(case_sensitive=true) }}\nsort-case-insensitive-mixed: {{ [0, 1, \"true\", \"false\", \"True\", \"False\", true, false]|sort }}\nsort-case-sensitive-mixed: {{ [0, 1, \"true\", \"false\", \"True\", \"False\", true, false]|sort(case_sensitive=true) }}\nsort-attribute {{ objects|sort(attribute=\"name\") }}\nd: {{ undefined|d == \"\" }}\njson: {{ map|tojson }}\njson-pretty: {{ map|tojson(true) }}\njson-scary-html: {{ scary_html|tojson }}\nurlencode: {{ \"hello world/foo-bar_baz.txt\"|urlencode }}\nurlencode-kv: {{ dict(a=\"x y\", b=2, c=3, d=None)|urlencode }}\nbatch: {{ range(10)|batch(3) }}\nbatch-fill: {{ range(10)|batch(3, '-') }}\nslice: {{ range(10)|slice(3) }}\nslice-fill: {{ range(10)|slice(3, '-') }}\nitems: {{ dict(a=1)|items }}\nindent: {{ \"foo\\nbar\\nbaz\"|indent(2)|tojson }}\nindent-first-line: {{ \"foo\\nbar\\nbaz\"|indent(2, true)|tojson }}\nint-abs: {{ -42|abs }}\nfloat-abs: {{ -42.5|abs }}\nint-round: {{ 42|round }}\nfloat-round: {{ 42.5|round }}\nfloat-round-prec2: {{ 42.512345|round(2) }}\nselect-odd: {{ [1, 2, 3, 4, 5, 6]|select(\"odd\") }}\nselect-truthy: {{ [undefined, null, 0, 42, 23, \"\", \"aha\"]|select }}\nreject-truthy: {{ [undefined, null, 0, 42, 23, \"\", \"aha\"]|reject }}\nreject-odd: {{ [1, 2, 3, 4, 5, 6]|reject(\"odd\") }}\nselect-attr: {{ [dict(active=true, key=1), dict(active=false, key=2)]|selectattr(\"active\") }}\nreject-attr: {{ [dict(active=true, key=1), dict(active=false, key=2)]|rejectattr(\"active\") }}\nselect-attr: {{ [dict(active=true, key=1), dict(active=false, key=2)]|selectattr(\"key\", \"even\") }}\nreject-attr: {{ [dict(active=true, key=1), dict(active=false, key=2)]|rejectattr(\"key\", \"even\") }}\nmap-maps: {{ [-1, -2, 3, 4, -5]|map(\"abs\") }}\nmap-attr: {{ [dict(a=1), dict(a=2), {}]|map(attribute='a', default=None) }}\nmap-attr-undefined: {{ [dict(a=1), dict(a=2), {}]|map(attribute='a', default=definitely_undefined) }}\nmap-attr-deep: {{ [dict(a=[1]), dict(a=[2]), dict(a=[])]|map(attribute='a.0', default=None) }}\nmap-attr-int: {{ [[1], [1, 2]]|map(attribute=1, default=999) }}\nattr-filter: {{ map|attr(\"a\") }}\nunique-filter: {{ [1, 1, 1, 4, 3, 0, 0, 5]|unique }}\nunique-filter-ci: {{ [\"a\", \"A\", \"b\", \"c\", \"b\", \"D\", \"d\"]|unique }}\nunique-filter-cs: {{ [\"a\", \"A\", \"b\", \"c\", \"b\", \"D\", \"d\"]|unique(case_sensitive=true) }}\nunique-attr-filter: {{ [{'x': 1}, {'x': 1, 'y': 2}, {'x': 2}]|unique }}\npprint-filter: {{ objects|pprint }}\nint-filter: {{ true|int }}, {{ \"42\"|int }}, {{ \"-23\"|int }}, {{ 42.0|int }}, {{ 42.42|int }}, {{ \"42.42\"|int }}\nfloat-filter: {{ true|float }}, {{ \"42\"|float }}, {{ \"-23.5\"|float }}, {{ 42.5|float }}\nsplit: {{ three_words|split|list }}\nsplit-at-and: {{ three_words|split(\" and \")|list }}\nsplit-n-ws: {{ three_words|split(none, 1)|list }}\nsplit-n-d: {{ three_words|split(\"d\", 1)|list }}\nsplit-n-ws-filter-empty: {{ \"  foo    bar baz  \"|split(none, 1)|list }}\nsum: {{ range(10)|sum }}\nsum-empty: {{ []|sum }}\nsum-float: {{ [0.5, 1.0]|sum }}\nlines: {{ \"foo\\nbar\\r\\nbaz\"|lines }}\nstring: {{ [1|string, 2|string] }}\nchain-lists: {{ list|chain(list2)|list }}\nchain-multiple: {{ list|chain(list2, list3)|list }}\nchain-maps: {{ map|chain(map2) }}\nchain-and-length: {{ list|chain(list2)|length }}\nchain-iteration: {% for item in list|chain(list2) %}{{ item }}{% if not loop.last %},{% endif %}{% endfor %}\nchain-indexing: {{ (list|chain(list2))[4] }}\nzip-lists: {{ list|zip(list2)|list }}\nzip-multiple: {{ list|zip(list2, list3)|list }}\nzip-different-lengths: {{ list|zip(other_list)|list }}\nzip-iteration: {% for a, b in list|zip(list2) %}{{ a }}-{{ b }}{% if not loop.last %},{% endif %}{% endfor %}\nzip-empty: {{ []|zip(list)|list }}\nzip-single: {{ list|zip()|list }}"
+description: "lower: {{ word|lower }}\nupper: {{ word|upper }}\ntitle: {{ word|title }}\ntitle-sentence: {{ \"the bIrd, is The:word\"|title }}\ntitle-three-words: {{ three_words|title }}\ncapitalize: {{ word|capitalize }}\ncapitalize-three-words: {{ three_words|capitalize }}\nreplace: {{ word|replace(\"B\", \"th\") }}\nescape: {{ \"<\"|escape }}\ne: {{ \"<\"|e }}\ndouble-escape: {{ \"<\"|escape|escape }}\nsafe: {{ \"<\"|safe|escape }}\nlist-length: {{ list|length }}\nlist-from-list: {{ list|list }}\nlist-from-map: {{ map|list }}\nlist-from-word: {{ word|list }}\nlist-from-undefined: {{ undefined|list }}\nbool-empty-string: {{ \"\"|bool }}\nbool-non-empty-string: {{ \"hello\"|bool }}\nbool-empty-list: {{ []|bool }}\nbool-non-empty-list: {{ [42]|bool }}\nbool-undefined: {{ undefined|bool }}\nmap-length: {{ map|length }}\nstring-length: {{ word|length }}\nstring-count: {{ word|count }}\nreverse-list: {{ list|reverse }}\nreverse-string: {{ word|reverse }}\ntrim: |{{ word_with_spaces|trim }}|\ntrim-bird: {{ word|trim(\"Bd\") }}\njoin-default: {{ list|join }}\njoin-pipe: {{ list|join(\"|\") }}\njoin_string: {{ word|join('-') }}\njoin-empty-strings: {{ [undefined, \"\", \"blub\", \"\", undefined, 42]|join('|') }}\ndefault: {{ undefined|default == \"\" }}\ndefault-value: {{ undefined|default(42) }}\ndefault-value-falsy: {{ \"\"|default(\"b\", true) }}\nd: {{ undefined|d == \"\" }}\nd-value: {{ undefined|d(42) }}\nfirst-list: {{ list|first }}\nfirst-word: {{ word|first }}\nfirst-undefined: {{ []|first is undefined }}\nlast-list: {{ list|last }}\nlast-word: {{ word|last }}\nlast-undefined: {{ []|first is undefined }}\nmin: {{ other_list|min }}\nmax: {{ other_list|max }}\nsort: {{ other_list|sort }}\nsort-reverse: {{ other_list|sort(reverse=true) }}\nsort-case-insensitive: {{ [\"B\", \"a\", \"C\", \"z\"]|sort }}\nsort-case-sensitive: {{ [\"B\", \"a\", \"C\", \"z\"]|sort(case_sensitive=true) }}\nsort-case-insensitive-mixed: {{ [0, 1, \"true\", \"false\", \"True\", \"False\", true, false]|sort }}\nsort-case-sensitive-mixed: {{ [0, 1, \"true\", \"false\", \"True\", \"False\", true, false]|sort(case_sensitive=true) }}\nsort-attribute {{ objects|sort(attribute=\"name\") }}\nd: {{ undefined|d == \"\" }}\njson: {{ map|tojson }}\njson-pretty: {{ map|tojson(true) }}\njson-scary-html: {{ scary_html|tojson }}\nurlencode: {{ \"hello world/foo-bar_baz.txt\"|urlencode }}\nurlencode-kv: {{ dict(a=\"x y\", b=2, c=3, d=None)|urlencode }}\nbatch: {{ range(10)|batch(3) }}\nbatch-fill: {{ range(10)|batch(3, '-') }}\nslice: {{ range(10)|slice(3) }}\nslice-fill: {{ range(10)|slice(3, '-') }}\nitems: {{ dict(a=1)|items }}\nindent: {{ \"foo\\nbar\\nbaz\"|indent(2)|tojson }}\nindent-first-line: {{ \"foo\\nbar\\nbaz\"|indent(2, true)|tojson }}\nindent-kwargs-width: {{ \"foo\\nbar\\nbaz\"|indent(width=4)|tojson }}\nindent-kwargs-first: {{ \"foo\\nbar\\nbaz\"|indent(4, first=true)|tojson }}\nindent-kwargs-blank: {{ \"foo\\nbar\\n\\nbaz\"|indent(4, first=false, blank=true)|tojson }}\nindent-kwargs-all: {{ \"foo\\nbar\\n\\nbaz\"|indent(width=2, first=true, blank=true)|tojson }}\nindent-default: {{ \"foo\\nbar\\nbaz\"|indent|tojson }}\nint-abs: {{ -42|abs }}\nfloat-abs: {{ -42.5|abs }}\nint-round: {{ 42|round }}\nfloat-round: {{ 42.5|round }}\nfloat-round-prec2: {{ 42.512345|round(2) }}\nselect-odd: {{ [1, 2, 3, 4, 5, 6]|select(\"odd\") }}\nselect-truthy: {{ [undefined, null, 0, 42, 23, \"\", \"aha\"]|select }}\nreject-truthy: {{ [undefined, null, 0, 42, 23, \"\", \"aha\"]|reject }}\nreject-odd: {{ [1, 2, 3, 4, 5, 6]|reject(\"odd\") }}\nselect-attr: {{ [dict(active=true, key=1), dict(active=false, key=2)]|selectattr(\"active\") }}\nreject-attr: {{ [dict(active=true, key=1), dict(active=false, key=2)]|rejectattr(\"active\") }}\nselect-attr: {{ [dict(active=true, key=1), dict(active=false, key=2)]|selectattr(\"key\", \"even\") }}\nreject-attr: {{ [dict(active=true, key=1), dict(active=false, key=2)]|rejectattr(\"key\", \"even\") }}\nmap-maps: {{ [-1, -2, 3, 4, -5]|map(\"abs\") }}\nmap-attr: {{ [dict(a=1), dict(a=2), {}]|map(attribute='a', default=None) }}\nmap-attr-undefined: {{ [dict(a=1), dict(a=2), {}]|map(attribute='a', default=definitely_undefined) }}\nmap-attr-deep: {{ [dict(a=[1]), dict(a=[2]), dict(a=[])]|map(attribute='a.0', default=None) }}\nmap-attr-int: {{ [[1], [1, 2]]|map(attribute=1, default=999) }}\nattr-filter: {{ map|attr(\"a\") }}\nunique-filter: {{ [1, 1, 1, 4, 3, 0, 0, 5]|unique }}\nunique-filter-ci: {{ [\"a\", \"A\", \"b\", \"c\", \"b\", \"D\", \"d\"]|unique }}\nunique-filter-cs: {{ [\"a\", \"A\", \"b\", \"c\", \"b\", \"D\", \"d\"]|unique(case_sensitive=true) }}\nunique-attr-filter: {{ [{'x': 1}, {'x': 1, 'y': 2}, {'x': 2}]|unique }}\npprint-filter: {{ objects|pprint }}\nint-filter: {{ true|int }}, {{ \"42\"|int }}, {{ \"-23\"|int }}, {{ 42.0|int }}, {{ 42.42|int }}, {{ \"42.42\"|int }}\nfloat-filter: {{ true|float }}, {{ \"42\"|float }}, {{ \"-23.5\"|float }}, {{ 42.5|float }}\nsplit: {{ three_words|split|list }}\nsplit-at-and: {{ three_words|split(\" and \")|list }}\nsplit-n-ws: {{ three_words|split(none, 1)|list }}\nsplit-n-d: {{ three_words|split(\"d\", 1)|list }}\nsplit-n-ws-filter-empty: {{ \"  foo    bar baz  \"|split(none, 1)|list }}\nsum: {{ range(10)|sum }}\nsum-empty: {{ []|sum }}\nsum-float: {{ [0.5, 1.0]|sum }}\nlines: {{ \"foo\\nbar\\r\\nbaz\"|lines }}\nstring: {{ [1|string, 2|string] }}\nchain-lists: {{ list|chain(list2)|list }}\nchain-multiple: {{ list|chain(list2, list3)|list }}\nchain-maps: {{ map|chain(map2) }}\nchain-and-length: {{ list|chain(list2)|length }}\nchain-iteration: {% for item in list|chain(list2) %}{{ item }}{% if not loop.last %},{% endif %}{% endfor %}\nchain-indexing: {{ (list|chain(list2))[4] }}\nzip-lists: {{ list|zip(list2)|list }}\nzip-multiple: {{ list|zip(list2, list3)|list }}\nzip-different-lengths: {{ list|zip(other_list)|list }}\nzip-iteration: {% for a, b in list|zip(list2) %}{{ a }}-{{ b }}{% if not loop.last %},{% endif %}{% endfor %}\nzip-empty: {{ []|zip(list)|list }}\nzip-single: {{ list|zip()|list }}"
 info:
   word: Bird
   word_with_spaces: " Spacebird\n"
@@ -104,6 +104,11 @@ slice-fill: [[0, 1, 2, 3], [4, 5, 6, "-"], [7, 8, 9, "-"]]
 items: [["a", 1]]
 indent: "foo\n  bar\n  baz"
 indent-first-line: "  foo\n  bar\n  baz"
+indent-kwargs-width: "foo\n    bar\n    baz"
+indent-kwargs-first: "    foo\n    bar\n    baz"
+indent-kwargs-blank: "foo\n    bar\n    \n    baz"
+indent-kwargs-all: "  foo\n  bar\n  \n  baz"
+indent-default: "foo\n    bar\n    baz"
 int-abs: 42
 float-abs: 42.5
 int-round: 42