Skip to main content
  • Home
  • Development
  • Documentation
  • Donate
  • Operational login
  • Browse the archive

swh logo
SoftwareHeritage
Software
Heritage
Archive
Features
  • Search

  • Downloads

  • Save code now

  • Add forge now

  • Help

  • ec325a8
  • /
  • byceps
  • /
  • util
  • /
  • forms.py
Raw File Download

To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Hash IDentifiers (SWHIDs) must be used.
Select below a type of object currently browsed in order to display its associated SWHID and permalink.

  • content
  • directory
content badge
swh:1:cnt:baabbc677b7efd5b281ca6fcf6c767c0d4b7de54
directory badge
swh:1:dir:311f5825a93c38f2f525a744a4e68987da6cc405

This interface enables to generate software citations, provided that the root directory of browsed objects contains a citation.cff or codemeta.json file.
Select below a type of object currently browsed in order to generate citations for them.

  • content
  • directory
(requires biblatex-software package)
Generating citation ...
(requires biblatex-software package)
Generating citation ...
forms.py
"""
byceps.util.forms
~~~~~~~~~~~~~~~~~

:Copyright: 2014-2025 Jochen Kupperschmidt
:License: Revised BSD (see `LICENSE` file for details)
"""

from flask_babel import lazy_gettext
from wtforms import Field, SelectMultipleField
from wtforms.widgets import CheckboxInput, ListWidget, TextInput

from byceps.services.user import user_service
from byceps.services.user.models.user import User


class MultiCheckboxField(SelectMultipleField):
    widget = ListWidget(prefix_label=False)
    option_widget = CheckboxInput()

    class _Option(SelectMultipleField._Option):
        def __init__(self, *args, **kwargs) -> None:
            # Do not pass validators to checkbox sub-widgets to prevent
            # them from always having the `required` flag set.
            kwargs.pop('validators', None)
            super().__init__(*args, **kwargs)


class UserScreenNameField(Field):
    """A field which takes a user screen name and stores the
    corresponding user object.
    """

    widget = TextInput()

    def __init__(self, label=None, validators=None, **kwargs) -> None:
        super().__init__(label, validators, **kwargs)

    def _value(self) -> str:
        if self.raw_data:
            return self.raw_data[0]

        if self.data is not None:
            # As user was found via screen name, the user object's
            # screen name cannot be empty.
            return self.data.screen_name  # type: ignore

        return ''

    def process_data(self, value) -> None:
        if value is None:
            self.data = None
            return

        screen_name = value.strip()
        user = _find_user_by_screen_name(screen_name)
        if user is None:
            self.data = None
            raise ValueError(lazy_gettext('Unknown username'))

        self.data = user

    def process_formdata(self, valuelist) -> None:
        if not valuelist:
            return

        screen_name = valuelist[0].strip()
        user = _find_user_by_screen_name(screen_name)
        if user is None:
            self.data = None
            raise ValueError(lazy_gettext('Unknown username'))

        self.data = user


def _find_user_by_screen_name(screen_name: str) -> User | None:
    return user_service.find_user_by_screen_name(screen_name)

back to top

Software Heritage — Copyright (C) 2015–2026, The Software Heritage developers. License: GNU AGPLv3+.
The source code of Software Heritage itself is available on our development forge.
The source code files archived by Software Heritage are available under their own copyright and licenses.
Terms of use: Archive access, API— Content policy— Contact— JavaScript license information— Web API