Push/Pop and addImagePath

With Python scripting and SikuliX, the smoothest way to organise your images is the following:

what you name a context can be a module named someContext.sikuli, containing:

img1 = "someImage.png"
img1P1 = Pattern(img1).exact() #optional
img1P2 = Pattern(img1P1).targetOffset(x, y) #optional

the variableness of course should be along some naming convention and "speaking" to some extent.

Having such a module you now can do the following in your main workflow:

import someContext

click(someContext.img1P2)

now you have separated code and images.

With the latest build of 1.1.0 this is supported in the IDE:

write in a blank line
someImage =

leave the cursor in that line, press the capture button and capture.
Coming back to the IDE, you will see that the image file is named "someImage.png" automatically.
Repeating the action (e.g. to optimise the image shot) the image file will be overwritten without notice (which is what one would expect)

to address your question:
I do not understand the difference between a combination of addImagePath/removeImagePath and glPushContext/glPopContext.
in both cases you have to say somewhere setupNewContext and somewhere else later teardownNewContext.

Hm, but what will happen if the image name is in someContext.sikuli, but the actual search function is in entirely separate module?

I usually do stuff like SupportModule.findEntity(imageName). will it search ONLY the context of someContext? Otherwise it will either not find it or there will be a clash.

Image names not given as absolute path will always be searched on the current image path, where the current bundle path (main script) will always be the first entry.
addImagePath() always adds to the end.
To find an imagefile, the imagePath is scanned from first to last entry and stops with the first success.

LOL, writing this, I have to admit, that you are half right:
- an imagefile will always be found, since each import of a .sikuli adds to the image path as well (where ever it was issued)
- but nameclashes are still possible, since the file search is not restricted and always on the complete current image path (and we do not have an unimport yet)

So to implement your approach, the directory structure has to be converted into a structure filename:

instead of
Project/Module/Window/Name1.png

you would have
Project/Module/Images.sikuli

and in Images.Sikuli
img1 = "Window_someImage.png"

supposing the level Window is the differentiating level.

Another possibility would be:
Project/Module.sikuli

and inside you have subdirectories
Project/Module.sikuli/Window/Name1.png

and then
img1 = "Window/someImage.png"

nevertheless: interesting discussion - adds to what I will implement in version 2 with ImageGroup. Thanks.

Kinda related to that:
I want some selector in the ide where I can (with 1 click) choose from a set of directories one that is currently used to save screenshots.

Say, I want to do some mail screenshots, I click Drive:\Project\Mail in this element and the next time I make a screenshot it will save into that folder.

The reason I need this for is because of the way my screenshots are organized I always have to
1) make a screenshot into .sikuli folder
2) copy/paste it into folder it really supposed to live in

@Zeks
could you please post a [request] bug for that.
So you can see, how and when I plan to implement this.