bukuserver package

bukuserver.filters module

class bukuserver.filters.BaseFilter(name, options=None, data_type=None, key_name=None)

Bases: flask_admin.model.filters.BaseFilter

apply(query, value)

Apply search criteria to the query and return new query.

Parameters

• query – Query

• value – Search criteria

operation()

Return readable operation name.

For example: u’equals’

class bukuserver.filters.BookmarkBaseFilter(name, operation_text=None, apply_func=None, filter_type=None, options=None, data_type=None)

Bases: bukuserver.filters.BaseFilter

clean(value)

Parse value into python format. Occurs before .apply()

Parameters

value – Value to parse

class bukuserver.filters.BookmarkBukuFilter(*args, **kwargs)

Bases: bukuserver.filters.BaseFilter

apply(query, value)

Apply search criteria to the query and return new query.

Parameters

• query – Query

• value – Search criteria

operation()

Return readable operation name.

For example: u’equals’

class bukuserver.filters.BookmarkField(value)

Bases: enum.Enum

An enumeration.

DESCRIPTION = 4

ID = 0

TAGS = 3

TITLE = 2

URL = 1

class bukuserver.filters.BookmarkTagNumberEqualFilter(*args, **kwargs)

Bases: bukuserver.filters.BookmarkBaseFilter

clean(value)

Parse value into python format. Occurs before .apply()

Parameters

value – Value to parse

class bukuserver.filters.BookmarkTagNumberGreaterFilter(*args, **kwargs)

Bases: bukuserver.filters.BookmarkTagNumberEqualFilter

class bukuserver.filters.BookmarkTagNumberNotEqualFilter(*args, **kwargs)

Bases: bukuserver.filters.BookmarkTagNumberEqualFilter

class bukuserver.filters.BookmarkTagNumberSmallerFilter(*args, **kwargs)

Bases: bukuserver.filters.BookmarkBaseFilter

clean(value)

Parse value into python format. Occurs before .apply()

Parameters

value – Value to parse

class bukuserver.filters.FilterType(value)

Bases: enum.Enum

An enumeration.

BOTTOM_X = {'func': <function bottom_x_func>, 'text': 'bottom x'}

EQUAL = {'func': <function equal_func>, 'text': 'equals'}

GREATER = {'func': <function greater_func>, 'text': 'greater than'}

IN_LIST = {'func': <function in_list_func>, 'text': 'in list'}

NOT_EQUAL = {'func': <function not_equal_func>, 'text': 'not equal'}

NOT_IN_LIST = {'func': <function not_in_list_func>, 'text': 'not in list'}

SMALLER = {'func': <function smaller_func>, 'text': 'smaller than'}

TOP_X = {'func': <function top_x_func>, 'text': 'top x'}

class bukuserver.filters.TagBaseFilter(name, operation_text=None, apply_func=None, filter_type=None, options=None, data_type=None)

Bases: bukuserver.filters.BaseFilter

clean(value)

Parse value into python format. Occurs before .apply()

Parameters

value – Value to parse

bukuserver.filters.bottom_x_func(query, value, index)

bukuserver.filters.equal_func(query, value, index)

bukuserver.filters.greater_func(query, value, index)

bukuserver.filters.in_list_func(query, value, index)

bukuserver.filters.not_equal_func(query, value, index)

bukuserver.filters.not_in_list_func(query, value, index)

bukuserver.filters.smaller_func(query, value, index)

bukuserver.filters.top_x_func(query, value, index)

bukuserver.forms module

Forms module.

class bukuserver.forms.BookmarkForm(*args, **kwargs)

Bases: flask_wtf.form.FlaskForm

description = <UnboundField(TextAreaField, (), {})>

tags = <UnboundField(StringField, (), {})>

title = <UnboundField(StringField, (), {})>

url = <UnboundField(StringField, (), {'validators': [<wtforms.validators.DataRequired object>]})>

class bukuserver.forms.HomeForm(*args, **kwargs)

Bases: bukuserver.forms.SearchBookmarksForm

keyword = <UnboundField(StringField, ('Keyword',), {})>

class bukuserver.forms.SearchBookmarksForm(*args, **kwargs)

Bases: flask_wtf.form.FlaskForm

all_keywords = <UnboundField(BooleanField, ('Match all keywords',), {})>

deep = <UnboundField(BooleanField, ('Deep search',), {})>

keywords = <UnboundField(FieldList, (<UnboundField(StringField, ('Keywords',), {})>,), {'min_entries': 1})>

regex = <UnboundField(BooleanField, ('Regex',), {})>

bukuserver.response module

bukuserver.server module

Server module.

class bukuserver.server.ApiBookmarkRangeView

Bases: flask.views.MethodView

delete(starting_id: int, ending_id: int)

get(starting_id: int, ending_id: int)

methods = {'DELETE', 'GET', 'PUT'}

A list of methods this view can handle.

put(starting_id: int, ending_id: int)

class bukuserver.server.ApiBookmarkSearchView

Bases: flask.views.MethodView

delete()

get()

methods = {'DELETE', 'GET'}

A list of methods this view can handle.

class bukuserver.server.ApiBookmarkView

Bases: flask.views.MethodView

delete(rec_id: Optional[int])

get(rec_id: Optional[int])

methods = {'DELETE', 'GET', 'POST', 'PUT'}

A list of methods this view can handle.

post(rec_id: None = None)

put(rec_id: int)

class bukuserver.server.ApiTagView

Bases: flask.views.MethodView

get(tag: Optional[str])

methods = {'GET', 'PUT'}

A list of methods this view can handle.

put(tag: str)

class bukuserver.server.BookmarkletView

Bases: flask.views.MethodView

get()

methods = {'GET'}

A list of methods this view can handle.

class bukuserver.server.CustomFlaskGroup(**kwargs)

Bases: flask.cli.FlaskGroup

bukuserver.server.create_app(db_file=None)

create app.

bukuserver.server.get_bool_from_env_var(key: str, default_value: bool) → bool

Get bool value from env var.

bukuserver.server.get_bukudb()

get bukudb instance

bukuserver.server.get_custom_version(ctx, param, value)

bukuserver.server.get_tags()

get tags.

bukuserver.server.get_tiny_url(rec_id)

bukuserver.server.handle_network()

bukuserver.server.refresh_bookmark(rec_id: Optional[int])

bukuserver.server.search_bookmarks()

bukuserver.server.search_tag(db: buku.BukuDb, stag: Optional[str] = None, limit: Optional[int] = None) → Tuple[List[str], Dict[str, int]]

search tag.

db:

buku db instance

stag:

search tag

limit:

positive integer limit

Returns

list of unique tags sorted alphabetically and dictionary of tag and its usage count

Return type

tuple

Raises

ValueError – if limit is not positive

bukuserver.server.update_tag(tag)

bukuserver.views module

views module.

class bukuserver.views.BookmarkModelView(*args, **kwargs)

Bases: flask_admin.model.base.BaseModelView

action_view()

Mass-model action view.

ajax_lookup()

ajax_update()

Edits a single column of a record in list view.

can_set_page_size = True

Allows to select page size via dropdown list

can_view_details = True

Setting this to true will enable the details view. This is recommended when there are too many columns to display in the list_view.

column_filters = ['buku', 'id', 'url', 'title', 'tags']

Collection of the column filters.

Can contain either field names or instances of BaseFilter classes.

Example:

class MyModelView(BaseModelView):
    column_filters = ('user', 'email')

column_formatters = {'Entry': <function BookmarkModelView._list_entry>}

Dictionary of list view column formatters.

For example, if you want to show price multiplied by two, you can do something like this:

class MyModelView(BaseModelView):
    column_formatters = dict(price=lambda v, c, m, p: m.price*2)

or using Jinja2 macro in template:

from flask_admin.model.template import macro

class MyModelView(BaseModelView):
    column_formatters = dict(price=macro('render_price'))

# in template
{% macro render_price(model, column) %}
    {{ model.price * 2 }}
{% endmacro %}

The Callback function has the prototype:

def formatter(view, context, model, name):
    # `view` is current administrative view
    # `context` is instance of jinja2.runtime.Context
    # `model` is model instance
    # `name` is property name
    pass

column_list = ['Entry']

Collection of the model field names for the list view. If set to None, will get them from the model.

For example:

class MyModelView(BaseModelView):
    column_list = ('name', 'last_name', 'email')

(Added in 1.4.0) SQLAlchemy model attributes can be used instead of strings:

class MyModelView(BaseModelView):
    column_list = ('name', User.last_name)

When using SQLAlchemy models, you can reference related columns like this::

class MyModelView(BaseModelView):

column_list = (‘<relationship>.<related column name>’,)

create_form(obj=None)

Instantiate model creation form and return it.

Override to implement custom behavior.

create_modal = True

Setting this to true will display the create_view as a modal dialog.

create_modal_template = 'bukuserver/bookmark_create_modal.html'

Default create modal template

create_model(form)

Create model from the form.

Returns the model instance if operation succeeded.

Must be implemented in the child class.

Parameters

form – Form instance

create_template = 'bukuserver/bookmark_create.html'

Default create template

create_view()

Create model view

delete_model(model)

Delete model.

Returns True if operation succeeded.

Must be implemented in the child class.

Parameters

model – Model instance

delete_view()

Delete model view. Only POST method is allowed.

details_modal = True

Setting this to true will display the details_view as a modal dialog.

details_view()

Details model view

edit_modal = True

Setting this to true will display the edit_view as a modal dialog.

edit_modal_template = 'bukuserver/bookmark_edit_modal.html'

Default edit modal template

edit_template = 'bukuserver/bookmark_edit.html'

Default edit template

edit_view()

Edit model view

export(export_type)

get_list(page, sort_field, sort_desc, _, filters, page_size=None)

Return a paginated and sorted list of models from the data source.

Must be implemented in the child class.

Parameters

• page – Page number, 0 based. Can be set to None if it is first page.

• sort_field – Sort column name or None.

• sort_desc – If set to True, sorting is in descending order.

• search – Search query

• filters – List of filter tuples. First value in a tuple is a search index, second value is a search value.

• page_size – Number of results. Defaults to ModelView’s page_size. Can be overriden to change the page_size limit. Removing the page_size limit requires setting page_size to 0 or False.

get_one(id)

Return one model by its id.

Must be implemented in the child class.

Parameters

id – Model id

get_pk_value(model)

Return PK value from a model object.

index_view()

List view

named_filter_urls = True

Set to True to use human-readable names for filters in URL parameters.

False by default so as to be robust across translations.

Changing this parameter will break any existing URLs that have filters.

scaffold_filters(name)

Generate filter object for the given name

Parameters

name – Name of the field

scaffold_form()

Create form.BaseForm inherited class from the model. Must be implemented in the child class.

scaffold_list_columns()

Return list of the model field names. Must be implemented in the child class.

Expected return format is list of tuples with field name and display text. For example:

['name', 'first_name', 'last_name']

scaffold_list_form(widget=None, validators=None)

Create form for the index_view using only the columns from self.column_editable_list.

Parameters

• widget – WTForms widget class. Defaults to XEditableWidget.

• validators – form_args dict with only validators {‘name’: {‘validators’: [DataRequired()]}}

Must be implemented in the child class.

scaffold_sortable_columns()

Returns dictionary of sortable columns. Must be implemented in the child class.

Expected return format is a dictionary, where keys are field names and values are property names.

update_model(form: bukuserver.forms.BookmarkForm, model: argparse.Namespace)

Update model from the form.

Returns True if operation succeeded.

Must be implemented in the child class.

Parameters

• form – Form instance

• model – Model instance

class bukuserver.views.CustomAdminIndexView(name=None, category=None, endpoint=None, url=None, template='admin/index.html', menu_class_name=None, menu_icon_type=None, menu_icon_value=None)

Bases: flask_admin.base.AdminIndexView

index()

search()

redirect to bookmark search

class bukuserver.views.CustomBukuDbModel(bukudb_inst, name)

Bases: object

class bukuserver.views.StatisticView(*args, **kwargs)

Bases: flask_admin.base.BaseView

index()

class bukuserver.views.TagModelView(*args, **kwargs)

Bases: flask_admin.model.base.BaseModelView

action_view()

Mass-model action view.

ajax_lookup()

ajax_update()

Edits a single column of a record in list view.

can_create = False

Is model creation allowed

can_set_page_size = True

Allows to select page size via dropdown list

column_filters = ['name', 'usage_count']

Collection of the column filters.

Can contain either field names or instances of BaseFilter classes.

Example:

class MyModelView(BaseModelView):
    column_filters = ('user', 'email')

column_formatters = {'name': <function TagModelView._name_formatter>}

Dictionary of list view column formatters.

For example, if you want to show price multiplied by two, you can do something like this:

class MyModelView(BaseModelView):
    column_formatters = dict(price=lambda v, c, m, p: m.price*2)

or using Jinja2 macro in template:

from flask_admin.model.template import macro

class MyModelView(BaseModelView):
    column_formatters = dict(price=macro('render_price'))

# in template
{% macro render_price(model, column) %}
    {{ model.price * 2 }}
{% endmacro %}

The Callback function has the prototype:

def formatter(view, context, model, name):
    # `view` is current administrative view
    # `context` is instance of jinja2.runtime.Context
    # `model` is model instance
    # `name` is property name
    pass

create_model(form)

Create model from the form.

Returns the model instance if operation succeeded.

Must be implemented in the child class.

Parameters

form – Form instance

create_view()

Create model view

delete_model(model)

Delete model.

Returns True if operation succeeded.

Must be implemented in the child class.

Parameters

model – Model instance

delete_view()

Delete model view. Only POST method is allowed.

details_view()

Details model view

edit_view()

Edit model view

export(export_type)

get_list(page: int, sort_field: str, sort_desc: bool, search: Optional[Any], filters: List[Tuple[int, str, str]], page_size: Optional[int] = None) → Tuple[int, List[types.SimpleNamespace]]

Return a paginated and sorted list of models from the data source.

Must be implemented in the child class.

Parameters

• page – Page number, 0 based. Can be set to None if it is first page.

• sort_field – Sort column name or None.

• sort_desc – If set to True, sorting is in descending order.

• search – Search query

• filters – List of filter tuples. First value in a tuple is a search index, second value is a search value.

• page_size – Number of results. Defaults to ModelView’s page_size. Can be overriden to change the page_size limit. Removing the page_size limit requires setting page_size to 0 or False.

get_one(id)

Return one model by its id.

Must be implemented in the child class.

Parameters

id – Model id

get_pk_value(model)

Return PK value from a model object.

index_view()

List view

scaffold_filters(name)

Generate filter object for the given name

Parameters

name – Name of the field

scaffold_form()

Create form.BaseForm inherited class from the model. Must be implemented in the child class.

scaffold_list_columns()

Return list of the model field names. Must be implemented in the child class.

Expected return format is list of tuples with field name and display text. For example:

['name', 'first_name', 'last_name']

scaffold_list_form(widget=None, validators=None)

Create form for the index_view using only the columns from self.column_editable_list.

Parameters

• widget – WTForms widget class. Defaults to XEditableWidget.

• validators – form_args dict with only validators {‘name’: {‘validators’: [DataRequired()]}}

Must be implemented in the child class.

scaffold_sortable_columns()

Returns dictionary of sortable columns. Must be implemented in the child class.

Expected return format is a dictionary, where keys are field names and values are property names.

update_model(form, model)

Update model from the form.

Returns True if operation succeeded.

Must be implemented in the child class.

Parameters

• form – Form instance

• model – Model instance

bukuserver.views.chunks(arr, n)