Last active
July 21, 2020 21:47
-
-
Save tehasdf/3188326 to your computer and use it in GitHub Desktop.
A quick hack to create "forms" using urwid.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
class MyForm(Form): | |
focus_style = 'form-focus' | |
error_style = 'form-error' | |
bar = TextField('Enter some text here:', validators=[includes('bar')]) | |
number_bar = NumberField('Enter a number here:', validators=[lessthan(15)]) | |
boolie = BooleanField("Is it ok?") | |
submit = SubmitField() | |
def save(self): | |
logger.info('Successfully sent a form with data: %r' % self.data) | |
def validate(self): | |
bar = self.data.get('bar', '') | |
number = self.data.get('number_bar', 0) | |
if not 'foo' in bar or number < 3: | |
raise ValueError("Text must include 'foo' and number must be greater than 2!") | |
def handle_errors(self, errors): | |
logger.error('Form had errors: %r' % errors) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import urwid | |
from collections import OrderedDict | |
import logging | |
logger = logging.getLogger('urwid-log') | |
# FORM FIELDS | |
class FormField(urwid.Widget): | |
creation_counter = 0 | |
def __init__(self, msg=None, **kwargs): | |
if msg is None: | |
msg = '' | |
self.msg = None | |
else: | |
msg = self.msg = "%s " % msg | |
self.creation_counter = FormField.creation_counter | |
FormField.creation_counter += 1 | |
self.validators = kwargs.pop('validators', []) | |
super(FormField, self).__init__(msg, **kwargs) | |
def validate(self): | |
for validator in self.validators: | |
validator(self.value) | |
class TextField(FormField, urwid.Edit): | |
@property | |
def value(self): | |
return self.edit_text | |
class NumberField(FormField, urwid.IntEdit): | |
@property | |
def value(self): | |
try: | |
return int(self.edit_text) | |
except ValueError: | |
raise ValueError("Must be a number!") | |
class BooleanField(FormField, urwid.CheckBox): | |
@property | |
def value(self): | |
return self.get_state() | |
class SubmitField(FormField, urwid.Button): | |
def __init__(self, *args, **kwargs): | |
self.value = False | |
super(SubmitField, self).__init__(*args, **kwargs) | |
def render(self, *args, **kwargs): | |
return urwid.Text("< %s >" % self.label).render(*args, **kwargs) | |
def set_caption(self, *args, **kwargs): | |
return super(SubmitField, self).set_label(*args, **kwargs) | |
# THE FORM THING | |
class FormMeta(urwid.widget.WidgetMeta): | |
def __new__(cls, clsname, bases, attrs): | |
fields = {} | |
for name, attr in attrs.items(): | |
if isinstance(attr, FormField): | |
if attr.msg is None: | |
attr.set_caption("%s: " % name) | |
fields[name] = attr | |
fields = OrderedDict(sorted(fields.items(), | |
key=lambda (name, field): field.creation_counter)) | |
attrs['_fields'] = fields | |
return super(FormMeta, cls).__new__(cls, clsname, bases, attrs) | |
class FormErrorsBox(urwid.BoxAdapter): | |
def selectable(self): | |
return False | |
class Form(urwid.LineBox): | |
__metaclass__ = FormMeta | |
field_style = None | |
focus_style = None | |
error_style = None | |
def __init__(self, *args, **kwargs): | |
self.data = {} | |
self.fields = urwid.Pile([ | |
urwid.AttrMap(field, self.field_style, self.focus_style) | |
for field in self._fields.values()]) | |
self.errors = urwid.Pile([ | |
urwid.AttrMap(urwid.Text(''), self.error_style) | |
for _ in self.fields.contents]) | |
self.form_errors = urwid.SimpleListWalker([]) | |
form_errors = urwid.ListBox(self.form_errors) | |
cols = urwid.Columns([self.fields, self.errors]) | |
whole = urwid.Pile([cols, FormErrorsBox(form_errors, 5)]) | |
if 'title' not in kwargs: | |
kwargs['title'] = self.__class__.__name__ | |
super(Form, self).__init__(whole, **kwargs) | |
def keypress(self, size, key): | |
if key == 'enter': | |
field = self.fields.get_focus().base_widget | |
if isinstance(field, SubmitField): | |
self._submit(field) | |
return | |
super(Form, self).keypress(size, 'down') | |
return super(Form, self).keypress(size, key) | |
def save(self): | |
pass | |
def _submit(self, field): | |
field.value = True | |
self.form_errors[:] = [] | |
errors = self._validate() | |
if not errors: | |
self.save() | |
else: | |
self.handle_errors(errors) | |
field.value = False | |
def _validate(self): | |
errors = [] | |
for fieldname, (field, fw), (error_text, ew) in zip(self._fields, | |
self.fields.contents, self.errors.contents): | |
try: | |
field.base_widget.validate() | |
error_text.base_widget.set_text('') | |
self.data[fieldname] = field.base_widget.value | |
except ValueError as e: | |
errors.append(e.message) | |
error_text.base_widget.set_text(e.message) | |
try: | |
self.validate() | |
except ValueError as e: | |
errors.append(e.message) | |
self.form_errors.append( | |
urwid.AttrMap(urwid.Text(e.message), self.error_style)) | |
return errors | |
def validate(self): | |
pass | |
def handle_errors(self, errors): | |
pass | |
# VALIDATORS | |
def includes(text, error_message=None): | |
if error_message is None: | |
error_message = "Must include %r!" % text | |
def validator(value): | |
if not text in value: | |
raise ValueError(error_message) | |
return validator | |
def lessthan(limit, error_message=None): | |
if error_message is None: | |
error_message = "Must be less than %d!" % limit | |
def validator(value): | |
if value >= limit: | |
raise ValueError(error_message) | |
return validator |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is free and unencumbered software released into the public domain. | |
Anyone is free to copy, modify, publish, use, compile, sell, or | |
distribute this software, either in source code form or as a compiled | |
binary, for any purpose, commercial or non-commercial, and by any | |
means. | |
In jurisdictions that recognize copyright laws, the author or authors | |
of this software dedicate any and all copyright interest in the | |
software to the public domain. We make this dedication for the benefit | |
of the public at large and to the detriment of our heirs and | |
successors. We intend this dedication to be an overt act of | |
relinquishment in perpetuity of all present and future rights to this | |
software under copyright law. | |
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | |
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | |
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. | |
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR | |
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, | |
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR | |
OTHER DEALINGS IN THE SOFTWARE. | |
For more information, please refer to <http://unlicense.org/> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
@buxx I've updated the gist to contain a LICENSE file with the "unlicense" license, the snippets are therefore public domain and you may do with them as you please
This code is I think an experiment I had about making (automatically, perhaps) urwid frontends for django's models/forms. I don't think I ever went anywhere with this idea, and I'm not sure if the code works at all, and if it is useful. It might possibly be used as educational material at least, I hope. The code is 7 years old and I don't remember it very well :)