Module control.typ.cust.user

Expand source code 
from control.html import HtmlElements as H
from control.typ.value import Value


class User(Value):
    """Type class for users.

    !!! note
        This is an example of a type class that needs
        `control.auth.Auth` (which it gets through
        `control.context.Context`) in order
        to display titles for users cautiously.

    !!! caution
        Do not reveal too many details to unauthenticated users.
    """

    needsContext = True

    def __init__(self, context):
        super().__init__(context)

    def titleStr(self, record, markup=True, withRole=True, **kwargs):
        context = self.context
        auth = context.auth

        valBare = auth.identity(record, markup=markup, withRole=withRole)
        return valBare if markup is None else H.he(valBare)

Classes

class User (context)

Type class for users.

Note

This is an example of a type class that needs Auth (which it gets through Context) in order to display titles for users cautiously.

Caution

Do not reveal too many details to unauthenticated users.

Initialization

Store a handle to the Context singleton.

Parameters

context : object
See below.
Expand source code 
class User(Value):
    """Type class for users.

    !!! note
        This is an example of a type class that needs
        `control.auth.Auth` (which it gets through
        `control.context.Context`) in order
        to display titles for users cautiously.

    !!! caution
        Do not reveal too many details to unauthenticated users.
    """

    needsContext = True

    def __init__(self, context):
        super().__init__(context)

    def titleStr(self, record, markup=True, withRole=True, **kwargs):
        context = self.context
        auth = context.auth

        valBare = auth.identity(record, markup=markup, withRole=withRole)
        return valBare if markup is None else H.he(valBare)

Ancestors

Class variables

var needsContext

Methods

def titleStr(self, record, markup=True, withRole=True, **kwargs)
Expand source code 
def titleStr(self, record, markup=True, withRole=True, **kwargs):
    context = self.context
    auth = context.auth

    valBare = auth.identity(record, markup=markup, withRole=withRole)
    return valBare if markup is None else H.he(valBare)

Inherited members