HTML tables for use with the Flask micro-framework
Project description
Flask Table
===========
Because writing HTML is fiddly and all of your tables are basically
the same.
Quick Start
===========
```python
# import things
from flask_table import Table, Col
# Declare your table
class MyTable(Table):
name = Col('Name')
description = Col('Description')
# Get some objects
class Item(object):
def __init__(self, name, description):
self.name = name
self.description = description
items = [Item('Name1', 'Desc1'), Item('Name2', 'Desc2')]
# Populate the table
table = MyTable(items)
# Print the html
print(table.__html__())
# or just {{ table }} from within a Jinja template
```
Extra things:
* The attribute used for each column in the declaration of the column
is used as the default thing to lookup in each object.
* There are also LinkCol and ButtonCol that allow links and buttons,
which is where the Flask-specific-ness comes in.
* There are also DateCol and DatetimeCol that format dates and
datetimes.
* Oh, and BoolCol, which does Yes/No.
* But most importantly, Col is easy to subclass.
Subclassing Col
===============
(Look in examples/subclassing.py for a more concrete example)
Suppose our item has an attribute, but we don't want to output the
value directly, we need to alter it first. If the value that we get
from the item gives us all the information we need, then we can just
override the td_format method:
```python
class LangCol(Col):
def td_format(self, content):
if content == 'en_GB':
return 'British English'
elif content == 'de_DE':
return 'German'
elif content == 'fr_FR':
return 'French'
else:
return 'Not Specified'
```
If you need access to all of information in the item, then we can go a
stage earlier in the process and override the td_contents method:
```python
from flask import Markup
def td_contents(self, i, attr_list):
# by default this does
# return self.td_format(self.from_attr_list(i, attr_list))
return Markup.escape(self.from_attr_list(i, attr_list) + ' for ' + item.name)
```
At present, you do still need to be careful about escaping things as
you override these methods. Also, because of the way that the Markup
class works, you need to be careful about how you concatenate these
with other strings.
===========
Because writing HTML is fiddly and all of your tables are basically
the same.
Quick Start
===========
```python
# import things
from flask_table import Table, Col
# Declare your table
class MyTable(Table):
name = Col('Name')
description = Col('Description')
# Get some objects
class Item(object):
def __init__(self, name, description):
self.name = name
self.description = description
items = [Item('Name1', 'Desc1'), Item('Name2', 'Desc2')]
# Populate the table
table = MyTable(items)
# Print the html
print(table.__html__())
# or just {{ table }} from within a Jinja template
```
Extra things:
* The attribute used for each column in the declaration of the column
is used as the default thing to lookup in each object.
* There are also LinkCol and ButtonCol that allow links and buttons,
which is where the Flask-specific-ness comes in.
* There are also DateCol and DatetimeCol that format dates and
datetimes.
* Oh, and BoolCol, which does Yes/No.
* But most importantly, Col is easy to subclass.
Subclassing Col
===============
(Look in examples/subclassing.py for a more concrete example)
Suppose our item has an attribute, but we don't want to output the
value directly, we need to alter it first. If the value that we get
from the item gives us all the information we need, then we can just
override the td_format method:
```python
class LangCol(Col):
def td_format(self, content):
if content == 'en_GB':
return 'British English'
elif content == 'de_DE':
return 'German'
elif content == 'fr_FR':
return 'French'
else:
return 'Not Specified'
```
If you need access to all of information in the item, then we can go a
stage earlier in the process and override the td_contents method:
```python
from flask import Markup
def td_contents(self, i, attr_list):
# by default this does
# return self.td_format(self.from_attr_list(i, attr_list))
return Markup.escape(self.from_attr_list(i, attr_list) + ' for ' + item.name)
```
At present, you do still need to be careful about escaping things as
you override these methods. Also, because of the way that the Markup
class works, you need to be careful about how you concatenate these
with other strings.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Flask-Table-0.1.2.tar.gz
(4.2 kB
view details)
File details
Details for the file Flask-Table-0.1.2.tar.gz.
File metadata
- Download URL: Flask-Table-0.1.2.tar.gz
- Upload date:
- Size: 4.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2df0507b75272130f643b1afe09a6d0fdc73494c6be63bb6021eb0934113e56e |
|
| MD5 | fbcaa572efdb57736ed181cbbce0a31d |
|
| BLAKE2b-256 | 74f045dff31712f320d84d391a9f12064ebc5d8ba843185a4358425dc8a13418 |
