Add docstrings

This commit is contained in:
Paul Konstantin Gerke 2022-03-05 12:47:16 +01:00
parent b7e15e6da9
commit 2c408ea479
1 changed files with 34 additions and 0 deletions

View File

@ -6,6 +6,16 @@ from . import models
class TagsEditor(Widget):
"""
Custom widget that provides an alternative editor for tags provided by the
taggit library.
The widget makes use of bootstrap v4 and its badge/pill feature and renders
a list of tags as badges that can be clicked to remove or add a tag to
the list of set tags. In addition, a user can dynamically add new, custom
tags, using a text editor.
"""
class Media:
js = ("babybuddy/js/tags_editor.js",)
@ -14,14 +24,29 @@ class TagsEditor(Widget):
@staticmethod
def __unpack_tag(tag: models.Tag):
"""
Tiny utility function used to translate a tag to a serializable
dictionary of strings.
"""
return {"name": tag.name, "color": tag.color}
def format_value(self, value: Any) -> Optional[str]:
"""
Override format_value to provide a list of dictionaries rather than
a flat, comma-separated list of tags. This allows for the more
complex rendering of tags provided by this plugin.
"""
if value is not None and not isinstance(value, str):
value = [self.__unpack_tag(tag) for tag in value]
return value
def build_attrs(self, base_attrs, extra_attrs=None):
"""
Bootstrap integration adds form-control to the classes of the widget.
This works only for "plain" input-based widgets however. In addition,
we need to add a custom class "babybuddy-tags-editor" for the javascript
file to detect the widget and take control of its contents.
"""
attrs = super().build_attrs(base_attrs, extra_attrs)
class_string = attrs.get("class", "")
class_string = class_string.replace("form-control", "")
@ -29,6 +54,15 @@ class TagsEditor(Widget):
return attrs
def get_context(self, name: str, value: Any, attrs) -> Dict[str, Any]:
"""
Adds extra information to the payload provided to the widget's template.
Specifically:
- Query a list if "recently used" tags (max 256 to not cause
DoS issues) from the database to be used for auto-completion. ("most")
- Query a smaller list of 5 tags to be made available from a quick
selection widget ("quick").
"""
most_tags = models.Tag.objects.order_by("-last_used").all()[:256]
result = super().get_context(name, value, attrs)