Update to_xml() methods by orlandoisepic · Pull Request #3 · precice/config-graph

orlandoisepic · 2026-02-23T17:22:35Z

They now have a clearer indent (tabs vs spaces) and the elements follow the order described in precice/config-format#2

Instead of spaces

This was the previously used name.

In this case the / needs to be at the beginning

@fsimonis

According to @fsimonis order in precice/config-format#2

fsimonis

We consistently use spaces in preCICE, using tabs here will break this convention.

I propose two ways regarding the formatting:

Generate output that leads to no changes when applying precice-config-format to it.
Generate unformatted output, then load precice-config-format as a library and use it to format the output.

I would personally tend towards the latter option, as it doesn't require any future changes.

orlandoisepic · 2026-04-09T11:54:52Z

Thank you for the feedback.

Generate unformatted output, then load precice-config-format as a library and use it to format the output

Currently, this is not possible as the to_xml() methods (producing a string) are only defined on the nodes themselves. The graph does not create an XML file.
This means that the user calls these 5 methods and receives the XML string, which can then be used to create the XML file, or whatever.

However, it would be possible to simply create a "global" to_xml() method, that receives a graph-object and then creates a formatted XML file.

If this is not desired, then I see only the option to modify the to_xml() methods of the nodes themselves.

and other indent issues

Default values

I moved the functions in their own directories based on their purpose.

Used default helper values

to use the new graph pacakge

fsimonis · 2026-04-10T10:55:50Z

Currently, this is not possible as the to_xml() methods (producing a string) are only defined on the nodes themselves. The graph does not create an XML file.

At some point you call, to_xml() and generate the string that needs to be written to file. This is the place where you can format the output.

Added missing attribute and made api_access optional.

fix the bug

fix wrong names

That are expected / optional in our nodes. Still doesnt cover all possible arguments (tags), but at least the most important ones

the test tests that the created config is equivalent to the orginal one and that formatting works as expected.

they now check all available tags

create method for generating only the string.

Optional dependency when creating file.

Now the graph package will be found

and now the optional generate dependency will be installed for testing

Fix imports with new structure

orlandoisepic · 2026-04-10T15:16:21Z

To summarize what this does now (because it is a bit more than anticipated):

Parse all attributes that the graph nodes have from a config file
There are global create_config_file(graph) and create_config_str(graph) now that format the config string with precice-config-format
There are corresponding tests
Old tests were updated to match the new functionality
Default values / constants are now stored centrally in helper.py
Graph manipulation is split into builder (creates the graph), operations (equivalence tests and config creation) and visualizer (plots the graph, used only in the CLI)

fsimonis

A general improvement would be to switch to single ticks for strings including escaped quotes:

"attrib=\"val\"" → 'attrib="val"'

fsimonis · 2026-04-14T10:59:09Z

+    try:
+        from preciceconfigformat.cli import parseXML, PrettyPrinter
+    except ImportError:
+        raise ImportError("The precice-config-format library is not installed. "


You can add this as a dependency to the package. This way you can assume that the formatter is importable.

fsimonis · 2026-04-14T10:59:48Z

+import networkx as nx
+try:
+    import matplotlib.pyplot as plt
+except ImportError:


Similar story here. You can just add this as a dependency.

fsimonis · 2026-04-14T11:00:43Z

+    THIN_PLATE_SPLINE = "thin-plate-splines"
+    VOLUME_SPLINE = "volume-splines"


The enums are now inconsistent though 😉

fsimonis · 2026-04-14T11:03:47Z

+    return _format_config_string(config_str)
+
+
+def _create_unformatted_config_str(config_dict: dict[str, list[n.ParticipantNode |


The generated string is still formatted.
I suggest removing all kinds of indentation.
Theoretically, you could even remove the newlines, but this can make debugging a challenge.

The key is simple code.

fsimonis · 2026-04-14T11:14:22Z

+                       f"{h.INDENT}{h.INDENT}{h.INDENT}filter=\"%Severity% > debug\"\n"
+                       f"{h.INDENT}{h.INDENT}{h.INDENT}format=\"---[precice] %ColorizedSeverity% %Message%\"\n"
+                       f"{h.INDENT}{h.INDENT}{h.INDENT}enabled=\"true\" />\n"


Suggested change

f"{h.INDENT}{h.INDENT}{h.INDENT}filter=\"%Severity% > debug\"\n"

f"{h.INDENT}{h.INDENT}{h.INDENT}format=\"---[precice] %ColorizedSeverity% %Message%\"\n"

f"{h.INDENT}{h.INDENT}{h.INDENT}enabled=\"true\" />\n"

f"{h.INDENT}{h.INDENT}{h.INDENT}format=\"---[precice] %ColorizedSeverity% %Message%\" />\n"

orlandoisepic added 4 commits February 23, 2026 18:09

Indent with tabs

14345f6

Instead of spaces

Update Nodes.md

68f6130

This was the previously used name.

Fix mapping closing

2889465

In this case the / needs to be at the beginning

Change sub element order

1ae2112

According to @fsimonis order in precice/config-format#2

orlandoisepic requested a review from fsimonis February 23, 2026 17:23

fsimonis requested changes Apr 2, 2026

View reviewed changes

orlandoisepic added 7 commits April 10, 2026 09:48

replace tabs with spaces

b186fcd

and other indent issues

Create helper.py

3fc8d04

Default values

Move graph methods

102d17d

I moved the functions in their own directories based on their purpose.

Update nodes.py

4a504f9

Used default helper values

Update tests

14c6d6b

to use the new graph pacakge

fix indent

c0ab585

now it is fixed

66821c6

fsimonis reviewed Apr 10, 2026

View reviewed changes

Comment thread precice_config_graph/graph/operations.py Outdated

orlandoisepic added 13 commits April 10, 2026 16:37

Update helper.py

d3a6f52

Update nodes.py

fa92800

Added missing attribute and made api_access optional.

Update operations.py

40fa006

fix the bug

Update enums.py

b86ec0b

fix wrong names

Parse all arguments

020be9b

That are expected / optional in our nodes. Still doesnt cover all possible arguments (tags), but at least the most important ones

Test for creating a configuration file

52e7ec6

the test tests that the created config is equivalent to the orginal one and that formatting works as expected.

update tests

b463e52

they now check all available tags

Update operations.py

5b69bdb

create method for generating only the string.

Update pyproject.toml

452569a

Optional dependency when creating file.

Update pyproject.toml

803d11e

Now the graph package will be found

Update tox.ini

4c4339e

and now the optional generate dependency will be installed for testing

Rename to visualizer

710d08a

Update cli.py

f96f60d

Fix imports with new structure

orlandoisepic requested a review from fsimonis April 10, 2026 15:16

fsimonis reviewed Apr 14, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update to_xml() methods#3

Update to_xml() methods#3
orlandoisepic wants to merge 24 commits intomainfrom
to_xml_methods

orlandoisepic commented Feb 23, 2026

Uh oh!

fsimonis left a comment

Uh oh!

orlandoisepic commented Apr 9, 2026 •

edited

Loading

Uh oh!

Uh oh!

fsimonis commented Apr 10, 2026

Uh oh!

orlandoisepic commented Apr 10, 2026

Uh oh!

fsimonis left a comment

Uh oh!

fsimonis Apr 14, 2026

Uh oh!

fsimonis Apr 14, 2026

Uh oh!

fsimonis Apr 14, 2026

Uh oh!

fsimonis Apr 14, 2026

Uh oh!

fsimonis Apr 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		THIN_PLATE_SPLINE = "thin-plate-splines"
		VOLUME_SPLINE = "volume-splines"

		return _format_config_string(config_str)


		def _create_unformatted_config_str(config_dict: dict[str, list[n.ParticipantNode \|

Uh oh!

Conversation

orlandoisepic commented Feb 23, 2026

Uh oh!

fsimonis left a comment

Choose a reason for hiding this comment

Uh oh!

orlandoisepic commented Apr 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

fsimonis commented Apr 10, 2026

Uh oh!

orlandoisepic commented Apr 10, 2026

Uh oh!

fsimonis left a comment

Choose a reason for hiding this comment

Uh oh!

fsimonis Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

fsimonis Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

fsimonis Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

fsimonis Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

fsimonis Apr 14, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

orlandoisepic commented Apr 9, 2026 •

edited

Loading