Rendering lists in XML may produce unexpected results #151

New Issue

adam · 2025-12-30T01:21:34+01:00

adam commented

2025-12-30 01:21:34 +01:00

Originally created by @jsundin on GitHub (Apr 28, 2024).

This was discovered during evaluation, and is not a case we actually need supported. It does feel unexpected and just thought it was worth mentioning.

Given the following example.pkl file:

adminIdList = List(1, 2, 3)

We can produce the following json file:

$ pkl eval -f json example.pkl 
{
  "adminIdList": [
    1,
    2,
    3
  ]
}

However, when we try to produce the XML representation of this we get:

$ pkl eval -f xml example.pkl 
<?xml version="1.0" encoding="UTF-8"?>
<root>
  <adminIdList>123</adminIdList>
</root>

This does seem unexpected and prone to mistakes, as it has a completely different meaning. There are tests expecting this behaviour, for example input and output.

The following XML could be the expected behaviour for me in this particular case. But honestly, lists and XML can be tricky. How would you deal with adminIdList = null in this case? And how would that solution compare to that of an empty list?

<root>
  <adminIdList>1</adminIdList>
  <adminIdList>2</adminIdList>
  <adminIdList>3</adminIdList>
</root>

The properties renderer just bails out for this case, which could also be reasonable.

The above has been tested using the following versions:

Pkl 0.25.3 (Linux 5.15.0-1053-aws, native)
Pkl 0.26.0-dev+3a31188 (Linux 5.4.0-177-generic, native)

Originally created by @jsundin on GitHub (Apr 28, 2024). This was discovered during evaluation, and is not a case we actually need supported. It does feel unexpected and just thought it was worth mentioning. Given the following `example.pkl` file: ``` adminIdList = List(1, 2, 3) ``` We can produce the following json file: ``` $ pkl eval -f json example.pkl { "adminIdList": [ 1, 2, 3 ] } ``` However, when we try to produce the XML representation of this we get: ``` $ pkl eval -f xml example.pkl <?xml version="1.0" encoding="UTF-8"?> <root> <adminIdList>123</adminIdList> </root> ``` This does seem unexpected and prone to mistakes, as it has a completely different meaning. There are tests expecting this behaviour, for example [input](https://github.com/apple/pkl/blob/main/pkl-core/src/test/files/LanguageSnippetTests/input/api/xmlRenderer4.pkl) and [output](https://github.com/apple/pkl/blob/main/pkl-core/src/test/files/LanguageSnippetTests/output/api/xmlRenderer4.pcf). The following XML could be the expected behaviour for me in this particular case. But honestly, lists and XML can be tricky. How would you deal with `adminIdList = null` in this case? And how would that solution compare to that of an empty list? ``` <root> <adminIdList>1</adminIdList> <adminIdList>2</adminIdList> <adminIdList>3</adminIdList> </root> ``` The properties renderer just bails out for this case, which could also be reasonable. The above has been tested using the following versions: - `Pkl 0.25.3 (Linux 5.15.0-1053-aws, native)` - `Pkl 0.26.0-dev+3a31188 (Linux 5.4.0-177-generic, native)`

adam commented

2025-12-30 01:21:35 +01:00

@holzensp commented on GitHub (Apr 29, 2024):

The problem here is that the standard representation of a list of things in XML is to write out the elements consecutively. This is actually quite central in the XML spec.

Given

import "pkl:xml"

class Foo {
  bar: Int
}

elements: Listing<Foo> = new {
  new { bar = 1 }
  new { bar = 2 }
}

output {
  renderer = new xml.Renderer {}
}

you get

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <elements>
    <Foo>
      <bar>1</bar>
    </Foo>
    <Foo>
      <bar>2</bar>
    </Foo>
  </elements>
</root>

It would be unexpected, at least, to get

<?xml version="1.0" encoding="UTF-8"?>
<root>
  <elements>
    <Foo>
      <bar>1</bar>
    </Foo>
  </elements>
  <elements>
    <Foo>
      <bar>2</bar>
    </Foo>
  </elements>
</root>

It is admittedly awkward that 1, 2, and 3 come out as 123, which is "just" because Int is a primitive type. That said, if you need repetition of the element tag, or even just line breaks to separate elements of the list, the solution is to use converters.

@holzensp commented on GitHub (Apr 29, 2024): The problem here is that the standard representation of a list of things in XML is to write out the elements consecutively. This is actually quite central in the XML spec. Given ``` import "pkl:xml" class Foo { bar: Int } elements: Listing<Foo> = new { new { bar = 1 } new { bar = 2 } } output { renderer = new xml.Renderer {} } ``` you get ``` <?xml version="1.0" encoding="UTF-8"?> <root> <elements> <Foo> <bar>1</bar> </Foo> <Foo> <bar>2</bar> </Foo> </elements> </root> ``` It would be unexpected, at least, to get ``` <?xml version="1.0" encoding="UTF-8"?> <root> <elements> <Foo> <bar>1</bar> </Foo> </elements> <elements> <Foo> <bar>2</bar> </Foo> </elements> </root> ``` It is admittedly awkward that `1`, `2`, and `3` come out as `123`, which is "just" because `Int` is a primitive type. That said, if you need repetition of the element tag, or even just line breaks to separate elements of the list, the solution is to use `converters`.

adam referenced this issue

2025-12-30 01:24:26 +01:00

[PR #151] [MERGED] Add Gradle task "testNative" #429

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/pkl#151