When package name is of the format str.str.str then copier doesn't parse it correctly

[schandrika]

Issue: when package name is given as volttron.historian.mysql then copier creates a package directory named "volttron.historian.mysql" and creates a method in agent.py "def volttron.historian.mysql()" Expected behavior:

1. copier should create the directory tree. For example, in pycharm if you create a new python package "volttron.historian.mysql", it creates 3 directories - volttron, volttron/historian, and volttron/historian/mysql. pycharm creates init.py in all three folders but this is not required. single init.py in the last folder is sufficient
2. agent.py can have a generic method name instead of "def volttron.historian.mysql()". For example, "def initialize_agent()"

[bonicim]

@schandrika I've modified the method name to a generic name in this working branch to address expected behavior 2.

On expected behavior number 1, @kefeimo how much effort will it take to support the expected behavior 1 as described above? Does it require any changes on the copier program itself?

[kefeimo]

@schandrika @bonicim , for behavior number 1, to clarify

• You would like a "tree-like" folder, e.g., volttron/historian/mysql/
• You also want to create a method (e.g., def mysql(...), i.e., with namespace volttron.historian) inside agent.py. --Please correct me if this is not the method name you want.
• Besides, you want to create __init__.py at volttron/historian/mysql/ but not at volttron/historian/ or volttron/

P.S.: is behavior number 1 related to issue Poetry install fails #32?

Pre-mature answer:

• I would spend 2 hour max to explore and play with agent.py.jinja, along with the naming for src/[[ python_package_import_name ]]
• Guideline: since Copier is not that controllable as to generate any desired structure based on my experience. (An example of negative user-experience is described in issue Poetry install fails #32). Unless there is significant improvement since April for Copier or finding new walk-around/back-gate, we might have to stick with the src/[[ python_package_import_name structure.
• issue Poetry install fails #32 is also a reminder, we need to test the structure change right away if we decide to do that.

[schandrika]

1. Yes. create package volttron.historian.mysql should create a tree-like folder
2. The method name change in agent.py - I think Mark took care of it
3. Ideally init.py is needed only in the leaf level package for python3 but it might be required if using setup.py instead of poetry. Let me confirm this though.

[craig8]

but since this is specifically a copier repository the init is not necessary