Package: python-wofi
A Python module to make simple GUIs usingWofi.
(forked from the originalpython-rofimodule)What is Wofi?Wofi is a launcher/menu program for wlroots based wayland compositors such as
sway. Its basic operation is to display a list of options and let the user
pick one. The following screenshot is shamelessly hotlinked from the wofi
website (which you should probably visit if you want actual details about
wofi!).What is this module?It simplifies making simple GUIs using Wofi. It provides a class with a number
of methods for various GUI actions (show messages, pick one of these options,
enter some text / a number). These are translated to the appropriate Wofi
command line options, and then the standardsubprocessmodule is used to run
Wofi. Any output is then processed and returned to you to do whatever you like
with.ExamplesData entryThe simplest example is to create a Wofi instance and prompt the user to enter
a piece of text:from wofi import Wofi
r = Wofi()
name = r.text_entry('What is your name? ')There are also entry methods for integers, floating-point numbers, and decimal
numbers:age = r.integer_entry('How old are you? ')
height = r.float_entry('How tall are you? ')
price = r.decimal_entry('How much are you willing to spend? ')All of these return the corresponding Python type. Dates and times can also be
requested:dob = r.date_entry('What is your date of birth? ')
start = r.time_entry('When do you start work? ')
reminder = r.datetime_entry('When do you want to be alerted? ')Again, these return the corresponding Python type. By default, they expect the
user to enter something in the appropriate format for the current locale. You
can override this by providing a list of format specifiers to any of these
functions. The available specifiers are detailed in the Python documentation
for thedatetimemodule. For example:start = r.time_entry('When do you start work? ', formats=['%H:%M'])All of these entry methods are specialisations of thegeneric_entry()method. You can use this to create your own entry types. All you need to do is
create a validator function which takes the text entered by the user, and
returns either the Python object or an error message. For example, to enforce a
minimum length on an entered piece of text:validator = lambda s: (s, None) if len(s) > 6 else (None, "Too short!")
r.generic_entry('Enter a 7-character or longer string: ', validator)Note that all of these methods returnNoneif the dialog is cancelled.ErrorsTo show an error message to the user:r.error('I cannot let you do that.')
r.exit_with_error('I cannot let you do that.')The latter shows the error message and then exits.SelectionsTo give the user a list of things to select from, and return the index of the
option they chose:options = ['Red', 'Green', 'Blue', 'White', 'Silver', 'Black', 'Other']
index, key = r.select('What colour car do you drive?', options)The returnedkeyvalue tells you what key the user pressed. For Enter, the
value is 0, while -1 indicates they cancelled the dialog. You can also specify
custom key bindings:index, key = r.select('What colour car do you drive?', options, key5=('Alt+n', "I don't drive"))In this case, the returnedkeywill be 5 if they press Alt+n.StatusTo display a status message to the user:r.status("I'm working on that...")This is the only non-blocking method (all the others wait for the user to
finish before returning control to your script). To close the status message:r.close()Calling a display or entry method will also close any status message currently
displayed.MessagesAny of the entry methods and the select method have an optional argumentmessage. This is a string which is displayed below the prompt. The string
can containPangomarkup:r.text_entry('What are your goals for this year? ', message='Be <b>bold</b>!')If you need to escape a string to avoid it being mistaken for markup, use theWofi.escape()class method:msg = Wofi.escape('Format: <firstname> <lastname>')
r.text_entry('Enter your name: ', message=msg)CustomisationThere are a number of options available to customise the display. These can be
set in the initialiser to apply to every dialog displayed, or you can pass them
to any of the display methods to change just that dialog. See the Wofi
documentation for full details of these parameters.lines: The maximum number of lines to show before scrolling.fixed_lines: Keep a fixed number of lines visible.width: If positive but not more than 100, this is the percentage of the
screen’s width the window takes up. If greater than 100, it is the width in
pixels. If negative, it estimates the width required for the corresponding
number of characters, i.e., -30 would set the width so approximately 30
characters per row would show.fullscreen: If True, use the full height and width of the screen.location:  The position of the window on the screen.You can also pass in arbitrary arguments to wofi through thewofi_argsparameter. These have to be passed in as a list of strings, with every
argument in a seperate string. For example, to make a selection case
insensitive:r = Wofi()
r.select('Choose one', ['option 1', 'option 2', 'option 3'],
    wofi_args=['-i'])or, to choose a different style for an instance ofWofi:r = Wofi(wofi_args=['-theme', 'path/to/theme.rasi'])
r.status('Stuff is happening, please wait...')RequirementsYou need to have thewofiexecutable available on the system path (i.e.,
install Wofi!). Everything else that python-wofi needs is provided by the
Python standard libraries.What Python versions are supported?Itshouldwork with any version of Python from 2.7 onwards. It may work with
older versions, though no specific support for them will be added. It is
developed on Python 2.7 and Python 3.6 – the latest versions of the Python 2
and 3 branches respectively.What license does it use?The MIT license, the same as python-wofi.Bug reportsThe project is developed onGitHub. Please file any bug reports or feature
requests on theIssuespage there.