Little Dialog-wrapper for PythonScript

Alan Kilborn

@Ekopalypse said in Little Dialog-wrapper for PythonScript:

on_click != onClick

It works better that way. :-)

Probably the code in test_different_ways_to_create_dialogs.py in the __test__ folder needs the same change?

One more oddity: With the aformentioned test_button.py script, I have to press the Close Dialog button TWICE before the script ends.

It seems that the dialog IS closing with the first press, but something is reopening it?

Alan Kilborn

@rdipardo

Your changes did indeed allow the dictionary-lookup script to run for me. Thanks!

For others that might be interested, here’s a full version of Michael Vincent’s dictionary script with rdipardo’s changes:

import json
import urllib.request as requests
import urllib.parse
from Npp import editor

from WinDialog import Button, DefaultButton, Dialog, Label, ListBox, TextBox
from WinDialog.win_helper import WindowStyle as WS

TITLE = "Dictionary"

class Returns(object):
    """The input / output for the Dictionary service."""
    def __init__(self, word=""):
        self.word = word
        self.definition = ""
        self.synonyms = []
        self.antonyms = []
        self.replace = None

class Dictionary(Dialog):
    """A Dictionary dialog interface."""
    def __init__(self, ret=Returns()):
        super().__init__(                title=TITLE      , center = True      , size=(220, 250))
        self.word       = TextBox(                          position=(10, 12)  , size=(150, 14) )
        self.lookup     = DefaultButton( title='&Lookup'  , position=(165, 13) , size=(45, 11)  )
        self.definition = TextBox(                          position=(10, 30)  , size=(200, 100))
        self.label1     = Label(         title='Synonyms' , position=(10, 140) , size=(45, 11)  )
        self.synonyms   = ListBox(                          position=(10, 155) , size=(90, 65)  )
        self.replsyn    = Button(        title='Re&place' , position=(10, 220),  size=(45, 11)  )
        self.label2     = Label(         title='Antonyms' , position=(120, 140), size=(45, 11)  )
        self.antonyms   = ListBox(                          position=(120, 155), size=(90, 65)  )
        self.replant    = Button(        title='Repl&ace' , position=(120, 220), size=(45, 11)  )
        self.close      = Button(        title='&Close'   , position=(165, 235), size=(45, 11)  )

        self.ret = ret

        self.onIdOk          = self.on_lookup
        self.lookup.onClick  = self.on_lookup
        self.replsyn.onClick = self.on_replace_syn
        self.replant.onClick = self.on_replace_ant
        self.close.onClick   = self.on_close

        self.definition.style = self.definition.style | WS.VSCROLL | WS.HSCROLL # | WS.DISABLED
        self.synonyms.style   = self.synonyms.style   | WS.TABSTOP
        self.antonyms.style   = self.antonyms.style   | WS.TABSTOP

        self.show()

    def _initialize(self):
        self.ret = Returns(self.ret.word)

        self.word.setText(self.ret.word)
        self.synonyms.clear()
        self.antonyms.clear()

    def initialize(self):
        """Initialize the dialog."""
        self._on_lookup()

    def _on_lookup(self):
        """Lookup the word."""
        self._initialize()

        text_encoded = urllib.parse.quote(self.word.getText())
        r = requests.urlopen(requests.Request(f"http://api.dictionaryapi.dev/api/v2/entries/en/{text_encoded}"))
        if r.status != 200:
            r.close()
            return

        synonyms = []
        antonyms = []
        response = ""
        for idx, defs in enumerate(json.loads(r.read().decode('utf8'))[0]['meanings']):
            response += f"{idx+1} : {defs['partOfSpeech']}\r\n"
            for pos in defs['definitions']:
                response += f"    {pos['definition']}\r\n"
                synonyms.extend(pos['synonyms'])
                antonyms.extend(pos['antonyms'])
            synonyms.extend(defs['synonyms'])
            antonyms.extend(defs['antonyms'])

        self.ret.definition = response
        self.definition.setText(self.ret.definition)

        # Need case insensitive since ListBox has style SORT, which is case insensitive
        self.ret.synonyms = sorted(set(synonyms), key=str.casefold)
        self.ret.antonyms = sorted(set(antonyms), key=str.casefold)
        self.synonyms.addStrings(self.ret.synonyms)
        self.antonyms.addStrings(self.ret.antonyms)
        r.close()

    def on_lookup(self):
        self.ret.word = self.word.getText()
        self._on_lookup()

    def on_replace_syn(self):
        item = self.synonyms.getSelectedItem()
        if item < 0:
            return

        self.ret.replace = self.synonyms._ListBox__items[item].value
        editor.replaceSel(self.ret.replace)
        self.terminate()

    def on_replace_ant(self):
        item = self.antonyms.getSelectedItem()
        if item < 0:
            return

        self.ret.replace = self.antonyms._ListBox__items[item].value
        editor.replaceSel(self.ret.replace)
        self.terminate()

    def on_close(self):
        """Close dialog."""
        self.terminate()

def editor_getWordAtCaretOrSelection():
    retval = ''
    (sel_start, sel_end) = (editor.getSelectionStart(), editor.getSelectionEnd())
    if editor.getSelections() == 1 and sel_start != sel_end:
        retval = editor.getTextRange(sel_start, sel_end)
    else:
        start_of_word_pos = editor.wordStartPosition(editor.getCurrentPos(), True)
        end_of_word_pos = editor.wordEndPosition(start_of_word_pos, True)
        if start_of_word_pos != end_of_word_pos:
            retval = editor.getTextRange(start_of_word_pos, end_of_word_pos)
            editor.setSelection(end_of_word_pos, start_of_word_pos)
    return retval

def lookup():
    word = ""
    if editor.getSelectionEmpty():
        word = editor_getWordAtCaretOrSelection()
    else:
        word = editor.getSelText()

    if len(word) <= 0:
        notepad.messageBox('Select a word (or put the caret in a word) before running.', 'Error')
        return

    ret = Returns(word)
    Dictionary(ret)
    # print(ret.word)
    # print(ret.definition)
    # print(ret.synonyms)
    # print(ret.antonyms)
    # print(ret.replace)

if __name__ == '__main__':
    lookup()

Alan Kilborn

@Ekopalypse

Something is definitely up with having to close things twice.

When trying out various scripts from the __test__ folder, e.g. test_progressbar.py, test_statusbar.py, I have to press the X in the upper right of the window TWICE before the script truly ends.

Ekopalypse

@Alan-Kilborn

Yeah, lol, apparently my code isn’t really self-explanatory, too bad, was hoping it was.
Each test_{control} script executes once the dialog by rc-generation and once as a class example.

Alan Kilborn

@Ekopalypse said in Little Dialog-wrapper for PythonScript:

Each test_{control} script executes once the dialog by rc-generation and once as a class example.

Ha, okay, I wasn’t really digging into any of the code (yet!), just running things like a dumb user (success!) and misunderstanding what results were obtained.

Thanks for the clarification.

What I like to do if I have code that runs two ways is to let it only one way run via a controlling variable at the top. That way someone trying it can change one line (to change the variable) and the rest will run differently.

Michael Vincent

@Alan-Kilborn said in Little Dialog-wrapper for PythonScript:

For others that might be interested, here’s a full version of Michael Vincent’s dictionary script with rdipardo’s changes:

@rdipardo

Sorry I haven’t been around in a while, just getting back now. Thank you for the updates; I’ve converted my dictionary and translator scripts to use the more portable method as urllib does indeed come with PythonScript. And yes, I have the PythonScript plugin set to “see” my installed Python3 - which had the requests module installed.

Happy we’re getting some traction out of @Ekopalypse 's Dialog-wrapper - truly ingenious and adds lots of menu / dialog functionality to PythonScripts.

Cheers.

Ekopalypse

@Alan-Kilborn said in Little Dialog-wrapper for PythonScript:

Probably the code in test_different_ways_to_create_dialogs.py in the test folder needs the same change?

Yes, correct and done, thanks for pointing it out.

What I like to do if I have code that runs two ways is …

They are tests, actually not meant as examples, my point was rather,
that the dialogs generated in each case, or more precisely, the resulting ByteArrays are compared,
but I understand what you mean. If I have a little more time sometime in the future,
I will tackle that.

Right now I’m using my meager free time to get the NppLspClient plugin into beta status, and then I wanted to rewrite the NppDebugger because my employer won’t allow me to release the existing plugin.
(The downside, if you develop something during working hours, suddenly it doesn’t belong to you anymore) :-(
(The advantage is that I can learn and use a new language, probably Rust or Zig, but I don’t know for sure yet) :-)

Alan Kilborn

@Ekopalypse said in Little Dialog-wrapper for PythonScript:

They are tests, actually not meant as examples,

Without a specific set of examples, the tests become the examples. :-)

Actually, I think Michael led me down the road of the tests being examples…I didn’t think too hard about it at first.

my employer won’t allow me to release the existing plugin.
(The downside, if you develop something during working hours, suddenly it doesn’t belong to you anymore

It is reasonable that it doesn’t belong to you, but it seems unreasonable that your employer won’t release it. It would be understandable if your employer was a developer of rocket fuel and your plugin calculated optimized rocket fuel ingredient proportions… But as a general purpose tool that won’t give a competitor some sort of edge, why not share it? Sigh.

Alan Kilborn

@Michael-Vincent

Not to get too far off-track with this thread, as it’s meant to highlight the Little Dialog-wrapper, but I noticed that in your “dictionary” script, if the selected “word” to look up isn’t spelled correctly (such that it isn’t a real word), unhandled exceptions occur (just check the PS console window).

Before I noticed this I got to thinking about the utility of dictionary programs. They’re fine if you know how the word is spelled and you want other info about it. But if you don’t know the spelling, it is hard to get you where you need to go.

Perhaps the script, if it doesn’t get an exact match, it should do a web search on the word of questionable spelling, e.g. N++'s Edit > On selection > Search on Internet. From that output, the user could correct the spelling input to the script and get further info about the word.

Michael Vincent

@Alan-Kilborn said in Little Dialog-wrapper for PythonScript:

selected “word” to look up isn’t spelled correctly (such that it isn’t a real word), unhandled exceptions occur (just check the PS console window).

Indeed. Quick fix:

    def _on_lookup(self):
        """Lookup the word."""
        self._initialize()

        text_encoded = urllib.parse.quote(self.word.getText())
        headers = {"User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.77 Safari/537.36"}
        try:
            r = requests.urlopen(requests.Request(url=f"http://api.dictionaryapi.dev/api/v2/entries/en/{text_encoded}", headers=headers))
        except urllib.error.HTTPError:
            notepad.messageBox('No definitions found.  Perhaps misspelled?', 'Error')
            self.terminate()
            return
        if r.status != 200:
            self.terminate()
            return

Cheers.

Alan Kilborn

So I was attempting to do something “real” with the Little Dialog Wrapper, and it fell a bit short in capability in a couple of areas.

I’m not complaining, mind you, I just thought I’d share my findings. And, of course, I could be doing something wrong that is indeed quite simple to do correctly.

I wanted my dialog to start up with a checkbox in the checked state and I found no easy way to do it. I tried the obvious:

self.my_checkbox.setCheckState(BST.CHECKED)

right before the call to self.show(), but this did not achieve the goal.

The workaround that I came up with that did work was:

import threading
threading.Timer(0.25, lambda : self.my_checkbox.setCheckState(BST.CHECKED)).start()

I also found no obvious function (meaning part of the WinDialog hierarchy) to call to disable a control. With a little ctypes help I worked around by doing:

from ctypes import WinDLL
user32 = WinDLL('user32')
user32.EnableWindow(self.my_checkbox.hwnd, False)

And again, this didn’t work if I wanted to start up with a control disabled. So I resorted to:

threading.Timer(0.25, lambda : user32.EnableWindow(self.my_checkbox.hwnd, False)).start()

for that.

Michael Vincent

@Alan-Kilborn said in Little Dialog-wrapper for PythonScript:

I wanted my dialog to start up with a checkbox in the checked state and I found no easy way to do it. I tried the obvious:

The way I got it to work was:

class Returns(object):
    def __init__(self, U=None, I=False, X=False):
        self.user_input = U
        self.IGNORECASE = I
        self.REGEX      = X
        self._RESET      = False
        self._OK         = False

class FilerLinesEditDlg(Dialog):
    def __init__(self, ret=Returns()):
        super().__init__(            title=TITLE                 , center = True,      size=(250, 75) )
        self.ok     = DefaultButton( title='&OK'                 , position=(135, 55), size=(50, 11)  )
        self.label  = Label(         title='Filter for:'         , position=(10, 12),  size=(30, 11)  )
        self.edit   = TextBox(                                     position=(45, 10),  size=(195, 14) )
        self.case   = CheckBoxButton(title='Case &Sensitive'     , position=(45, 30),  size=(80, 14)  )
        self.regex  = CheckBoxButton(title='Regular E&xpression' , position=(145, 30), size=(80, 14)  )
        self.cancel = Button(        title='&Cancel'             , position=(190, 55), size=(50, 11)  )
        self.reset  = Button(        title='&Reset'              , position=(45, 55),  size=(50, 11)  )

        self.ret = ret

        self.onIdOk         = self.on_ok
        self.ok.onClick     = self.on_ok
        self.cancel.onClick = self.on_cancel
        self.reset.onClick  = self.on_reset
        self.case.onClick   = self.on_case
        self.regex.onClick  = self.on_regex

        self.show()

    def initialize(self):
        self.edit.setText(self.ret.user_input)
        SendMessage(self.case.hwnd,  BM.SETCHECK, self.ret.IGNORECASE, 0)
        SendMessage(self.regex.hwnd, BM.SETCHECK, self.ret.REGEX, 0)

This is the “relevant” parts of a larger script - my version of your filter lines editing actually.

I create an object to store the values so then I can return them and save them in the global PythonScript object so next time I call it I can set the checkboxes appropriately. The initialize() function does the checkbox-ing.

Cheers.

Ekopalypse

@Alan-Kilborn

@Michael-Vincent is correct, to quote from the Dialog help

 |  initialize(self)
 |      Initializes the dialog and its controls at runtime.
 |      
 |      This method is intended to be overridden by a concrete class.
 |      It is executed after all controls have been created but before the dialog is displayed.
 |      Concrete implementations should provide custom logic to set up initial values, states, and configurations of the controls.

It might be worth adding function(s) to enable or disable controls, yes. PRs are welcome :-)

Ekopalypse

@Alan-Kilborn

simple example

from WinDialog import Dialog, CheckBoxButton
from WinDialog.controls.button import BST

class Example(Dialog):
    def __init__(self):
        super().__init__(size=(100, 100))
        self.btn1 = CheckBoxButton(title='Click me', position=(35, 40), size=(50, 14))
        self.show()

    def initialize(self):
        self.btn1.setCheckState(BST.CHECKED)
        
Example()

Alan Kilborn

@Michael-Vincent said in Little Dialog-wrapper for PythonScript:

I create an object to store the values so then I can return them and save them in the global PythonScript object so next time I call it I can set the checkboxes appropriately.

This is interesting. How do you kick off the saving of the current values? Meaning, if user presses Esc to close the dialog, or presses the red X in the title bar of the dialog, are you able to capture this and save your current control values? Maybe in your script you wouldn’t want to save in these circumstances, but OTOH maybe you would…

Ekopalypse

@Alan-Kilborn

You have an initial state when you start the dialog and from there I would use the control events to get the values you need. Something like

from WinDialog import Dialog, CheckBoxButton
from WinDialog.controls.button import BST

class Example(Dialog):
    def __init__(self):
        super().__init__(size=(100, 100))
        self.counter = 0
        self.btn1 = CheckBoxButton(title='Click me', position=(35, 40), size=(50, 14))
        self.btn1.onClick = self.on_click
        self.show()

    def initialize(self):
        self.btn1.setCheckState(BST.CHECKED)
        
    def on_click(self):
        self.counter += 1
        
e = example()
print(e.counter)

Alan Kilborn

@Ekopalypse said in Little Dialog-wrapper for PythonScript:

… use the control events to get the values you need.

Sure, but that’s the obvious case.

That’s why I specifically asked MV “…if user presses Esc to close the dialog, or presses the red X in the title bar of the dialog…”

As far as I can tell, and yes I’ve read some of the docs now :-), these aren’t capturable events?

Alan Kilborn

@Ekopalypse

BTW, I sort of missed this at first from the github page:

help(WinDialog)

I guess I’m just not used to documentation being provided in only this way, at least not any more. It’s totally fine, though, just maybe not super obvious for a newbie (would there be any newbies wanting to experiment with LDW??).

So maybe I’ll offer this on the off-chance that a newbie is reading; this is what I did to make it easier to refer to (note: nothing rocket sciencey here…):

go to PythonScript console window area, right-click, and choose Clear from the popup menu
at the >>> prompt, type import WinDialog and press return
type help(WinDialog) and press return
right-click again and choose Select All and then press Ctrl+c
create a new tab in Notepad++ and paste there
save the tab for later reference

Michael Vincent

@Alan-Kilborn said in Little Dialog-wrapper for PythonScript:

That’s why I specifically asked MV “…if user presses Esc to close the dialog, or presses the red X in the title bar of the dialog…”

They get saved. That’s why I use a return class object that’s part of the main script. So in the example I provided, I want to remember the setting for “ignore case” and “regex” so the checkboxes have an onClick event that toggles the boolean value stored in the return class.

    def on_case(self):
        self.ret.IGNORECASE = not self.ret.IGNORECASE

    def on_regex(self):
        self.ret.REGEX = not self.ret.REGEX

That happens whenever the users clicks the checkbox. So if they later just press ‘Esc’ or red ‘X’, the value has already been stored and then next time it launches, it is checked (or unchecked) appropriately in the initialize().

Cheers.

Alan Kilborn

@Michael-Vincent said in Little Dialog-wrapper for PythonScript:

They get saved.

It’s not what I was truly getting at, but I understand how you’ve made it work. Thanks.