NiftyNet icon indicating copy to clipboard operation
NiftyNet copied to clipboard

Migrate configuration files to YAML

Open dzhoshkun opened this issue 7 years ago • 17 comments

This is a sub-task of #166

For a roadmap, see the following comment: https://github.com/NifTK/NiftyNet/issues/166#issuecomment-407015033

Basically:

  • [x] deprecate the current INI parser
  • [ ] implement a new parser along the lines of:

dzhoshkun avatar Jul 24 '18 13:07 dzhoshkun

  • [x] modify the CI script to read (only?) YAML files

dzhoshkun avatar Jul 24 '18 13:07 dzhoshkun

Deprecation warnings are ignored by default, hence no user output in the above build. Apparently this decision has been (and continues to be) strongly debated.

dzhoshkun avatar Jul 30 '18 09:07 dzhoshkun

dzhoshkun avatar Jul 30 '18 09:07 dzhoshkun

  • [ ] compare new YAML files on this branch to INI files on dev branch before merging! (by reverting 9666eb9)

dzhoshkun avatar Aug 06 '18 08:08 dzhoshkun

  • [x] remove INI files?

dzhoshkun avatar Aug 06 '18 09:08 dzhoshkun

  • [ ] default CI sections do not load any configuration files, should test these changes using the slow tests etc.

dzhoshkun avatar Aug 06 '18 09:08 dzhoshkun

  • [x] the last commit fails because there are hard-coded filenames featuring the .ini extension. Those should be replaced, possibly using a global file extension constant

dzhoshkun avatar Aug 06 '18 09:08 dzhoshkun

  • [ ] references to / examples of INI files in documentation should be revised as well

dzhoshkun avatar Aug 07 '18 14:08 dzhoshkun

  • [ ] depends on https://github.com/NifTK/NiftyNetModelZoo/issues/2

dzhoshkun avatar Aug 07 '18 15:08 dzhoshkun

dzhoshkun avatar Aug 10 '18 09:08 dzhoshkun

  • [ ] revert above commit before merging

dzhoshkun avatar Aug 10 '18 10:08 dzhoshkun

  • [ ] possibly implement a new class with same interface as ConfigParser but which can also parse YAML files, that way all the current parameter validation can be kept intact => #203
    • [ ] ConfigParser is used in many places, so make sure the new impersonator ConfigParser does not break existing configuration parsing (possibly put INI files back and run CI)

dzhoshkun avatar Aug 10 '18 10:08 dzhoshkun

  • [ ] add a test checking equivalence of INI and (mirrored-from-INI) YAML files

dzhoshkun avatar Aug 17 '18 10:08 dzhoshkun

  • [ ] use assertEqual instead of assertTrue ?

dzhoshkun avatar Aug 17 '18 11:08 dzhoshkun

  • [ ] make sure tests make sense

dzhoshkun avatar Aug 17 '18 11:08 dzhoshkun

  • [ ] overridden methods with default parameter values cause problems (see above commit, and also fix a369e3e if applicable)

dzhoshkun avatar Aug 20 '18 09:08 dzhoshkun