#226: Add support for rtc files #342
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File structure as discussed. factory.py is a placeholder for convenience functions (.e.g. make_TimeController())) Ref: #226
…uld still be refactored to be usable for the other RTC files.
…l be refactored to be usable for the other RTC files.
|
SonarCloud Quality Gate failed.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this branch I am experimenting a little bit with the RTC XSD files.
With XMLSpy, I converted each XSD to a JSON schema:
In the same window (but maybe this is not really a necessary step):
In each generated JSON schema then replace
:PLACEHOLDERandPLACEHOLDER:with an empty string to remove them.Attributes from XSD are converted to a property in JSON with a
@prefix. Converting this to python will result in a private field. So we need to replace it. In each generated JSON replace"@with"attr_.pip install datamodel-code-generatorExample for rtcDataConfig.json:
datamodel-codegen --input rtcDataConfig.json --input-file-type jsonschema --output . --field-constraints --allow-population-by-field-name --use-subclass-enum --use-schema-descriptionThis command will create some python files.
For each RTC file a folder was created in the repository:
hydrolib.core.io.rtc.rtcDataConfighydrolib.core.io.rtc.rtcToolsConfighydrolib.core.io.rtc.rtcRunimeConfigetc.
In each folder a generated folder is added.
In here the generated files should be stored.
In
models.pywe should put the Model that the user will use directly.This Model will use the generated files under the hood.
In the rtcDataConfig folder a parser and a serializer have been added to create a prototype for reading and writing logic.
Most of the implementation can be used for the other rtc models as well I expect.
I think it would also be a good to add a layer between the generated models and the xml (de)serialization in the final implementation.
Unfortunately the rtcToolsConfig is not converted to valid python code, because the name of a module conflicts with the name of a class:
TimeSeriesSimpleTypeandExternalParameterSimpleTypeIt would also be nice if we could fully automate it (I am not sure yet if this is possible with XML Spy).