Make pretty print indentation configurable

[janhavlin]

📒 Description

Hello, I'd like to be able to customize the indentation when pretty print is enabled. So this patch is adding a setting SerializerConfig.pretty_print_indent, allowing to set indentation string per level when pretty_print is True.

Simple example:

from xsdata.formats.dataclass.serializers.config import SerializerConfig
from xsdata.formats.dataclass.serializers import XmlSerializer
from xsdata.formats.dataclass.serializers.writers.lxml import LxmlEventWriter
from xsdata.formats.dataclass.serializers.writers.native import XmlEventWriter
import dataclasses

@dataclasses.dataclass
class Bar:
    nested_a: int
    nested_b: int

@dataclasses.dataclass
class Foo:
    foo: int
    bar: Bar

f = Foo(1, Bar(2, 3))

print(XmlSerializer(
    config=SerializerConfig(pretty_print=True, pretty_print_indent="            "),
    writer=LxmlEventWriter
).render(f))

print(XmlSerializer(
    config=SerializerConfig(pretty_print=True, pretty_print_indent=" "),
    writer=XmlEventWriter
).render(f))

Which results in:

<?xml version="1.0" encoding="UTF-8"?>
<Foo>
            <foo>1</foo>
            <bar>
                        <nested_a>2</nested_a>
                        <nested_b>3</nested_b>
            </bar>
</Foo>

<?xml version="1.0" encoding="UTF-8"?>
<Foo>
 <foo>1</foo>
 <bar>
  <nested_a>2</nested_a>
  <nested_b>3</nested_b>
 </bar>
</Foo>

🛫 Checklist

• Updated docs
• Added unit-tests
• Sample tests pass
• W3C tests pass

[tefra]

Hi @janhavlin can you also take care of the JsonSerializer?

[janhavlin]

Sure! Pushed an additional change.

[codecov]

Codecov Report

Patch coverage: 100.00% and project coverage change: +0.02 🎉

Comparison is base (8e2e446) 99.96% compared to head (9fdde1c) 99.98%.

❗ Current head 9fdde1c differs from pull request most recent head 2529a2f. Consider uploading reports for the commit 2529a2f to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #780      +/-   ##
==========================================
+ Coverage   99.96%   99.98%   +0.02%     
==========================================
  Files         104      101       -3     
  Lines        9102     8916     -186     
  Branches     2035     1980      -55     
==========================================
- Hits         9099     8915     -184     
+ Partials        3        1       -2     

Impacted Files	Coverage Δ
xsdata/formats/dataclass/serializers/config.py	100.00% <100.00%> (ø)
xsdata/formats/dataclass/serializers/json.py	100.00% <100.00%> (ø)
...data/formats/dataclass/serializers/writers/lxml.py	100.00% <100.00%> (ø)
...ta/formats/dataclass/serializers/writers/native.py	100.00% <100.00%> (ø)

... and 18 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[tefra]

Looks great thank you for contributing!

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication