projectal.entities.note

 1import copy
 2
 3import projectal
 4from projectal.entity import Entity
 5from projectal.linkers import *
 6
 7
 8class Note(Entity, TagLinker):
 9    """
10    Implementation of the [Note](https://projectal.com/docs/latest/#tag/Note) API.
11    """
12
13    _path = "note"
14    _name = "note"
15    _links = [TagLinker]  # TODO: user?
16
17    @classmethod
18    def create(cls, holder, entity):
19        """Create a Note
20
21        `holder`: `uuId` of the owner
22
23        `entity`: The fields of the entity to be created
24        """
25        holder_id = holder["uuId"] if isinstance(holder, dict) else holder
26        params = "?holder=" + holder_id
27        out = super().create(entity, params)
28        # Notes use "empty linkers" during creation which don't go through our
29        # usual linker pipeline where the internal list is updated. Do it here
30        # manually.
31        if isinstance(holder, Entity):
32            nl = holder.get("noteList", [])
33            nl.append(out)
34            holder.set_readonly("noteList", copy.deepcopy(nl))
35
36        # Notes contain references to the objects that made and hold them. We don't get this
37        # information from the creation api method, but we can insert them ourselves because
38        # we know what they are.
39        time = projectal.response_timestamp
40
41        def add_fields(obj):
42            obj.set_readonly("created", time)
43            obj.set_readonly("modified", time)
44            obj.set_readonly("author", projectal.api_auth_details.get("name"))
45            obj.set_readonly("authorRef", projectal.api_auth_details.get("uuId"))
46            obj.set_readonly("holderRef", holder_id)
47            tag = None
48            if isinstance(holder, Entity):
49                tag = holder._name.upper()
50            obj.set_readonly("holderTag", tag)
51
52        if isinstance(out, dict):
53            add_fields(out)
54        if isinstance(out, list):
55            for obj in out:
56                add_fields(obj)
57        return out