Run Configuration : I don't manage to match local and target paths

[bc-109]

Hi,

I'm trying to configure a "Run configuration", or more precisely, an "Upload configuration". I didn't manage to match local and target path as I would like to.

My local tree (PyCharm project) typically looks like that :

Project
    target/
        lib/
            mylib.mpy
        src/
            mylib.py
            mysoftware.py
        boot.py
        user.py
        var.py
    tools/
        compile-mpy-esp8266.bat
        compile-mpy-pico.bat
    doc/
        Documentation.md
    README.md
    CHANGELOG.md

target is the root of what needs to be uploaded to the target.
tools and doc are folders for local scripts or documentation, which will go to the Git server, but not to the target.

On the target, the expected tree is :

lib/
    mylib.mpy
src/
    mylib.py
    mysoftware.py
log/
    boot.log
    user.log
boot.py
user.py
var.py

log is a folder that remains on the target, and that does not need to be synced back to the PC.

Then, I would like to match my local /project/target to / on the target. I didn't manage to do that.

When using an upload configuration of type "path" :
project/target is marked as "source root"
I can set source path as C:\Data\PyCharm\project\target
But when I try to put / in target path, it adds /target at the end.
Then, it tries to sync /project/target (local) to /target and not to /

When using upload configuration of type "Selected" :
The "available sources" box is empty.

I also tried not to use /project/target subfolder locally, and put /src, , /lib and boot.py in the root directory of the PyCharm project. Doing so, I need to put local exclusions on /doc, /tools, README.md, because those files must not be transfered to the target. I find how to declare target exclusions (for /log) but I didn't find how to declare local exclusions.

I think I missed something, but I don't know what :-)

Thank you in advance.

[bc-109]

First mistake : I was marking directories as "Sources root" and not "Micropython sources root" :-)

But even correcting that, I still did not find a suitable configuration for what I want to do..

[lukaskremla]

Hello,

The upload run configurations are lacking documentation - I plan to fix that in the upcoming 0.5.4 release.

The issue with custom path seems like a bug. If you select a file it's meant to take the target path, append the filename to it and upload it to the device to that target path. When you select a folder, it's meant to take the target path and upload the folder's contents there.

Thanks for reporting that!

For your use case the project configuration should work best. What you need is to right click the folder which contains your code, go to "mark folder as" and select MicroPython Sources Root. The project configuration uploads what's in the root of the project. However, as soon at least one MicroPython Sources Root is selected it only uploads the contents of top most MicroPython sources roots. The target paths are built relative to them so:

ProjectName/SomeDirectory/MicroPythonSourcesRoot/lib/library.py

Will upload as:

"lib/library.py"

Basically when you mark a folder as MicroPython Sources Root you can treat it as the "/" root of the device. It seems to me that you should mark the target folder and then just use the project run configuration.

Selected is works similar to the project run configuration - but it requires at least one MicroPython Sources Root and allows you to choose which sources roots get selected. For example you might have one root with .py files and another with .mpy files - you can then have separate run configurations for that.

You can also right click the item you want to upload or drag and drop it to the file system tab - this is more useful for small one off changes, but it's worth being aware of.

I admit that the upload algorithm is difficult to figure out when you're new to using the plugin. I intend on writing documentation for the uploads here on GitHub and then embedding links in the plugin to direct you there. However, if you have any more questions ask away. I'm open to suggestions as well.

[bc-109]

Thank you for your answer.

1/ When using right click to "Upload file", then "Upload relative to Micropython sources root", it works as expected. Anyway, this is not very practical when working on several files at the same time (additional comment : I didn't manage to add the two "upload file" commands as icons in the toolbar)

2/ When using "Run configurations", in "Project" or "Path" mode, and setting project/target as "Micropython sources root", it always add the /target prefix on the target. In your example :
ProjectName/SomeDirectory/MicroPythonSourcesRoot/lib/library.py
uploads as MicroPythonSourcesRoot/lib/library.py instead of /lib/library.py

If I compare with right click / upload behavior, I would say the Run Configuration misses a "Relative" option.

[lukaskremla]

The custom path configuration is bugged - no doubt.

The project run configuration, however, should work. Are you sure you've switched it to type Project and applied it before running it? Maybe try to create a new project upload configuration to test it.

Screenshots

[bc-109]

Sorry, no luck !

I have exactly the same thing on my screenshots (under Windows, not Mac).
I deleted the Run configuration, unmark the target directory, and even refactor/rename the target directory to remote. It still adds /remote prefix on destination !

I'll try on another project right now...

[bc-109]

Tried on another project : it works as expected !

It seems my previous attempts in "path" mode broke something, and some wrong metadata remains somewhere. Any idea ???

[lukaskremla]

That's odd...

Try deleting all MicroPython Tools run configurations and then unmark and re-mark the target directory as MicroPython Sources Root. Then create a new project upload run configuration.

That should just work. If not, which is unlikely, you can try deleting the <projectName>.iml file in the .idea directory, which might require you to toggle the visibility of hidden files for you to be able to find it.

[bc-109]

In "Run configuration", tried to activate "Store as project file" (to see what it would put there), but that does not seem to work : it noes not create the expected file...

[lukaskremla]

That's an option managed by the IDE itself. If you don't manually specify a different directory it will usually save them to a path something along the lines of ProjectRoot/.idea/.run/runConfiguration.xm. You might need to toggle hidden folder/file visibility to see the .idea folder.

[bc-109]

1/ The first attempt (delete run configuration / unmark source) did nothing.
2/ Deleting project.iml seemed to solve the problem !

[lukaskremla]

1/ The first attempt (delete run configuration / unmark source) did nothing. 2/ Deleting project.iml seemed to solve the problem !

Glad it's sorted! project.iml is where the marked folders are serialized to, I suppose that got corrupted somehow...

[bc-109]

Here are the two files, in the hope you can see what was wrong :

New (working) project.iml :

<?xml version="1.0" encoding="UTF-8"?>
<module version="4">
  <component name="NewModuleRootManager">
    <content url="file://$MODULE_DIR$">
      <sourceFolder url="file://$MODULE_DIR$/remote" type="micropython-source" />
    </content>
    <orderEntry type="jdk" jdkName="Python Global" jdkType="Python SDK" />
    <orderEntry type="sourceFolder" forTests="false" />
  </component>
</module>

Old (buggy) project.iml :

<?xml version="1.0" encoding="UTF-8"?>
<module type="PYTHON_MODULE" version="4">
  <component name="FacetManager">
    <facet type="MicroPython" name="MicroPython">
      <configuration>
        <device name="Raspberry Pi Pico" />
      </configuration>
    </facet>
  </component>
  <component name="NewModuleRootManager">
    <content url="file://$MODULE_DIR$">
      <sourceFolder url="file://$MODULE_DIR$/remote" type="micropython-source" />
      <excludeFolder url="file://$MODULE_DIR$/.idea" />
    </content>
    <orderEntry type="inheritedJdk" />
    <orderEntry type="sourceFolder" forTests="false" />
    <orderEntry type="library" name="MicroPython" level="project" />
    <orderEntry type="library" name="MicroPythonTools" level="project" />
  </component>
</module>

[bc-109]

Conclusion :

• Don't use "Path" mode in "Run Configurations" for now, it's buggy :-)
• Problem solved by deleting .idea/<project_name>.iml and reconfiguring project

[lukaskremla]

I'll fix the custom path run configuration in the 0.5.4 release. It should work just fine for files, but it doesn't work as intended for folders.

I doubt the run configuration could somehow mess up the project.iml, it doesn't modify it in any way.

The old file contains configuration data specific to the old JetBrains MicroPython plugin and some odd inheritedJdk orderEntry. Maybe that was conflicting somehow...

[bc-109]

All works as expected now. It upload all files that have been modified. That's just magic !

Congratulations again for your great job, and thank you for your fast answers here.

[bc-109]

Addendum :
Do we have a log / a list of files that have been uploaded ?

[lukaskremla]

The files that were modified or added aren't logged in any way. You can see how the file system will look once the upload is done in the Upload Preview dialog, but the actual changes aren't logged anywhere.

If you have the synchronize option enabled, then files that are on the device, but that are no longer in your project will be deleted (you can exclude on device paths from this behavior). If all files are up to date (verified by CRC32) and there are no extra files on the device you will get a notification saying that everything is up to date.

[lukaskremla]

The custom path run configurations should work now #33.