Config Key normalization

[martinjankoehler]

Reason for #2284 is the following.

Problem

Calling

config_key = 'vector_file_export/lru_runsets'
config_value = '["/Users/martin/Source/klayout/export.json"]'
pya.Application.instance().save_config(config_key, config_value)

This results in a klayoutrc entry:

 <vector_file_export/lru_runsets>["/Users/martin/Source/klayout/export.json"]</vector_file_export/lru_runsets>

This then results in Problem reading config file /Users/martin/.klayout/klayoutrc: XML parser error: error occurred while parsing element in line 1456, column 22.

Analysis

Reason for this is that the / characters are not normalized. They should be escaped as `&slash;

save_config should either normalize / to a character from {., -, _}, or should throw an InvalidConfigKeyException

[klayoutmatthias]

Or you don't use a slash in the config key? :)

My suggestion would be ".", like `vector_file_export.lru_runsets" (BTW: I use kebab case, i.e. "vector-file-export.lru-runsets").

I guess that most other characters also are not allowed. The config key has to be a valid XML entity name, i.e.

Matthias

[martinjankoehler]

Yeah, I'm already using ., like you suggested,
but just thought from an API perspective the exception would be proper.

Yes, only . / - / _ besides letters for tag names.

[klayoutmatthias]

I have updated the documentation. I hope, this avoids problems like yours in the future :)

Matthias