Closed imagejan closed 3 months ago
I don't know what the best practice is here.
I think I had the files in CamelCase because I wanted to name them like the class inside. Maybe this is a java thing which I tried to replicate.
But definitely in favor of fixing this.
We currently have CamelCase class names inside CamelCase module files with the same name, and expose classes on module level by importing them in
__init__.py
, e.g.:https://github.com/fmi-faim/faim-ipa/blob/f4191359d3f35144190188e59dcdb90eebcefb78/src/faim_ipa/hcs/cellvoyager/__init__.py#L1-L2 https://github.com/fmi-faim/faim-ipa/blob/f4191359d3f35144190188e59dcdb90eebcefb78/src/faim_ipa/hcs/imagexpress/__init__.py#L1-L5
This is problematic, as changing the order of imports such as:
leads to errors like this:
.. as we mix modules and classes with the same name.
We should instead use all-lower-case names for the module files, and
CamelCase
exclusively for the class names. What do you think, @tibuch?