-
Notifications
You must be signed in to change notification settings - Fork 320
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor(createpackages): use jinja for mf6 module code generation #2333
base: develop
Are you sure you want to change the base?
Conversation
a3b7c2e
to
af1e7a5
Compare
d1e8a21
to
a7f2644
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't looked through everything, but I left you a PR on your own branch with indications on how I would probably approach this. Let's take a look at it together and see if we can get rid of the shim :)
bab83ac
to
cf68432
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## develop #2333 +/- ##
=========================================
+ Coverage 68.4% 76.5% +8.0%
=========================================
Files 294 300 +6
Lines 59390 63072 +3682
=========================================
+ Hits 40652 48261 +7609
+ Misses 18738 14811 -3927
|
f95ad8c
to
6d57fae
Compare
…tr from generated classes
outdated@deltamarnix after considering I think your work in progress (removing the legacy `dfn` attr on the generated classes) should go before this. This PR has shrunk a lot with the dfn -> toml conversion provided by devtools. It would be messy to try to preserve or reconstruct the old unstructured format when the whole point is to drop it and clean things up. So I took the `dfn` attr out of the templates in the last commit here. Let's discuss. |
Carved out of #2317 — just move to Jinja as an initial step, type hints can come afterwards as they will take some effort to get right. The aim here is to match the old
createpackages.py
capabilities without relying onmfstructure.py
. This is an initial step to movemfstructure.py
to a leaner representation of the input spec.mfstructure.py
is still used at runtime which will need to be unraveled in followup work.Introduce a
flopy.mf6.utils.codegen
module with some new machinery for loading an input specification from DFN files into an intermediate representation, and generating code with Jinja. This includes a "shim" of filters handling quirks of the generated classes which we can aim to gradually eliminate. The templates should also get simpler over time.The codegen module uses devtools to parse DFNs and convert them to TOML. I figure we can tweak the new format under the hood in flopy until we're happy with it then continue the migration upstream in mf6.
Jinja2
andmodflow-devtools
are added to a new optional dependency groupcodegen
. These are required to use the code generation utilities.Miscellaneous:
flopy/mf6/data/mfdatastorage.py
to avoid referencing a variable before it exists