Problem when installing in editable mode

[TeresiaOlsson]

I'm wondering if it should work to install the package in editable mode? Importing the module works fine if I do pip install . after cloning the repository but if I do pip install -e . I get the following error:

PyAMLConfigException: An exception occurred while building key 'instruments.controls.[0].[0]': Module referenced in type cannot be founded: 'tango.pyaml.controlsystem' /home/a3744/Documents/software/pyAML/pyaml/tests/config/EBSTune.yaml at line 11, column 9.

For some reason it seems like the submodule pyaml isn't found in editable mode. If editable mode isn't supposed to work, what is the correct way to install the package to be able to edit? When I install in not editable mode I currently have the following error that I want to fix:

SyntaxError: f-string: unmatched '[' (controlsystem.py, line 93)

[TeresiaOlsson]

@gupichon Do you know the solution to this? Currently I'm stuck trying to run the ESRF example because I can't install the tango bindings in editable mode and fix the bug.

[TeresiaOlsson]

I figured it out. There was an __init__.py missing at one level and after that the editable installation also works.

[TeresiaOlsson]

This problem seems to be back again.

[gubaidulinvadim]

@Amoutardier Did you have a similar issue recently?

[Amoutardier]

Hello,
Yes, I had the same issue. The editing mode does not work for me because it was installed in "site-packages" directly and not in "site-packages/tango" and tango does not recognise it as a submodule.

I bypass the issue by creating a symbolic link between my editable folder and "site-packages/tango/" but it is not a "proper" wait to do it I think.
In linux command line it looks like :
cd /home/amoutardier/miniconda3/envs/pyaml/lib/python3.14/site-packages/tango/
ln -s /home/amoutardier/pyAML/codes/tango-pyaml/tango/pyaml/ ./

I don't know the equivalent for windows, but it should exist.

[TeresiaOlsson]

I think a proper solution is needed or we will likely spend a lot of time fixing this problem at the workshop for every participant. For me it was previously fixed by adding the __init__ in the tango folder but that file now looks different. Maybe that's what caused the problem to appear again?

[TeresiaOlsson]

@JeanLucPons Do you perhaps have a guess for why this happens?

[JeanLucPons]

It is because tango-pyaml is installed as a sub module of tango.
To make it work, we would need to rename modules:
tango.pyaml to tango_pyaml for instance.

[TeresiaOlsson]

Hmm... How do you and @gupichon do when you need to edit it? Maybe there is some other option for the development installation than installing in editable mode?

[JeanLucPons]

May be, but i think if editable mode is needed the best is to rename the modules.
From pip help,

  -e, --editable <path/url>   Install a project in editable mode (i.e. setuptools "develop mode") from a local project path or a VCS url.

and we use hatch for the build system, may be some incompatibilities...

[TeresiaOlsson]

This problem is still there which I think makes it unnecessary complicated to do development of this package. I have found no solution so I think @JeanLucPons suggestion to rename the modules is the best approach. Or is there some reason why you would prefer it to be a subpackage under tango rather than it's own separate package?

If we should do the work to rename it, should we at the same time also change the name from tango-pyaml to pyaml-tango?