Module control.cust.review_record

Expand source code 
from config import Config as C, Names as N
from control.record import Record
from control.html import HtmlElements as H
from control.utils import pick as G, E


CW = C.web

ORPHAN = H.icon(CW.unknown[N.reviewKind])


class ReviewR(Record):
    """Logic for review records.

    Review records have a customised title,
    showing when the ereview was made and by whom.

    There is also a `compact` method to present these records,
    just the title, remarks and decision.

    !!! hint
        If the `reviewEntry` record is not part of the workflow, the behaviour
        of this class falls back to the base class `control.record.Record`.
    """

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

    def title(self, *args, **kwargs):
        kind = self.kind
        uid = self.uid
        record = self.record

        creatorId = G(record, N.creator)
        markup = kwargs.get("markup", True)
        datetime = self.field(N.dateCreated).wrapBare(markup=markup)
        date = datetime.split(maxsplit=1)[0]
        creator = self.field(N.creator).wrapBare(markup=markup)
        youRep = f""" ({N.you})""" if creatorId == uid else E
        kindRep = kind or ORPHAN

        return (
            H.span(f"""{kindRep} on {date} by {creator}{youRep}""", cls="small")
            if markup
            else f"""{kindRep} on {date} by {creator}"""
        )

    def bodyCompact(self, myMasters=None, hideMasters=False):
        perm = self.perm

        theTitle = self.title()

        remarks = H.div(
            self.field(N.remarks).wrap(withLabel=False, asEdit=G(perm, N.isEdit)),
        )
        decisionPart = H.div(
            self.field(N.decision).wrap(withLabel=False, asEdit=G(perm, N.isEdit))
        )

        return H.div([decisionPart, theTitle, remarks], cls="review")

Classes

class ReviewR (*args, **kwargs)

Logic for review records.

Review records have a customised title, showing when the ereview was made and by whom.

There is also a compact method to present these records, just the title, remarks and decision.

Hint

If the reviewEntry record is not part of the workflow, the behaviour of this class falls back to the base class Record.

Initialization

Store the incoming information.

A number of properties will be inherited from the table object that spawns a record object.

Parameters

tableObj : object
See below.
eid, record, withDetails, readonly, bodyMethod
See Table.record()
Expand source code 
class ReviewR(Record):
    """Logic for review records.

    Review records have a customised title,
    showing when the ereview was made and by whom.

    There is also a `compact` method to present these records,
    just the title, remarks and decision.

    !!! hint
        If the `reviewEntry` record is not part of the workflow, the behaviour
        of this class falls back to the base class `control.record.Record`.
    """

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

    def title(self, *args, **kwargs):
        kind = self.kind
        uid = self.uid
        record = self.record

        creatorId = G(record, N.creator)
        markup = kwargs.get("markup", True)
        datetime = self.field(N.dateCreated).wrapBare(markup=markup)
        date = datetime.split(maxsplit=1)[0]
        creator = self.field(N.creator).wrapBare(markup=markup)
        youRep = f""" ({N.you})""" if creatorId == uid else E
        kindRep = kind or ORPHAN

        return (
            H.span(f"""{kindRep} on {date} by {creator}{youRep}""", cls="small")
            if markup
            else f"""{kindRep} on {date} by {creator}"""
        )

    def bodyCompact(self, myMasters=None, hideMasters=False):
        perm = self.perm

        theTitle = self.title()

        remarks = H.div(
            self.field(N.remarks).wrap(withLabel=False, asEdit=G(perm, N.isEdit)),
        )
        decisionPart = H.div(
            self.field(N.decision).wrap(withLabel=False, asEdit=G(perm, N.isEdit))
        )

        return H.div([decisionPart, theTitle, remarks], cls="review")

Ancestors

Methods

def bodyCompact(self, myMasters=None, hideMasters=False)
Expand source code 
def bodyCompact(self, myMasters=None, hideMasters=False):
    perm = self.perm

    theTitle = self.title()

    remarks = H.div(
        self.field(N.remarks).wrap(withLabel=False, asEdit=G(perm, N.isEdit)),
    )
    decisionPart = H.div(
        self.field(N.decision).wrap(withLabel=False, asEdit=G(perm, N.isEdit))
    )

    return H.div([decisionPart, theTitle, remarks], cls="review")

Inherited members