Skip to content

consumers

logger = get_logger() module-attribute

NotebookConsumer

Bases: WebsocketConsumer

Source code in reports/consumers.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
class NotebookConsumer(WebsocketConsumer):
    report_id: UUID
    user: User

    def connect(self):
        self.report_id = self.scope['url_route']['kwargs']['notebook_id']
        self.user = self.scope["user"]

        if not self.report.can_view(self.user):
            self.close()
            return

        async_to_sync(self.channel_layer.group_add)(
            str(self.report_id), self.channel_name
        )
        self.accept()

    def disconnect(self, close_code):
        async_to_sync(self.channel_layer.group_discard)(
            str(self.report_id), self.channel_name
        )

    def receive(self, text_data):
        packet = Packet.loads_json(text_data)
        logger.info(f'Received {packet.type} packet')

        match PacketType(packet.type):
            case PacketType.CELL_RUN:
                if not self.report.can_edit(self.user):
                    return

                report = self.report
                cell_id = UUID(packet.data)
                cell_index = report.notebook.get('content', {}).get('cell_order', []).index(str(cell_id))

                Report.update_cell_outputs(self.report_id, cell_id, [])
                Report.update_cell_state(self.report_id, cell_id, CellState.QUEUED)
                self.report.apply_async(
                    run_cell, (self.report_id, cell_id),
                    creator=self.user,
                    name='Run cell #{}'.format(cell_index)
                )
            case PacketType.CELL_RESULT:
                self.send_packet(PacketType.CELL_RESULT, packet.data)
            case PacketType.CELL_STATE:
                self.send_packet(PacketType.CELL_STATE, packet.data)

    def task_message(self, event):
        self.receive(event['message'])

    def send_packet(self, type: PacketType, data: Any):
        self.send(text_data=Packet(type.value, data).dumps())

    @property
    def report(self) -> Report:
        report, created = Report.objects.get_or_create(
            id=self.report_id,
            defaults={
                'notebook': {
                    'id': self.report_id,
                }
            }
        )

        return report

    def check_permissions(self):
        pass

report_id: UUID class-attribute

user: User class-attribute

check_permissions()

Source code in reports/consumers.py 
82
83
def check_permissions(self):
    pass

connect()

Source code in reports/consumers.py 
20
21
22
23
24
25
26
27
28
29
30
31
def connect(self):
    self.report_id = self.scope['url_route']['kwargs']['notebook_id']
    self.user = self.scope["user"]

    if not self.report.can_view(self.user):
        self.close()
        return

    async_to_sync(self.channel_layer.group_add)(
        str(self.report_id), self.channel_name
    )
    self.accept()

disconnect(close_code)

Source code in reports/consumers.py 
33
34
35
36
def disconnect(self, close_code):
    async_to_sync(self.channel_layer.group_discard)(
        str(self.report_id), self.channel_name
    )

receive(text_data)

Source code in reports/consumers.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
def receive(self, text_data):
    packet = Packet.loads_json(text_data)
    logger.info(f'Received {packet.type} packet')

    match PacketType(packet.type):
        case PacketType.CELL_RUN:
            if not self.report.can_edit(self.user):
                return

            report = self.report
            cell_id = UUID(packet.data)
            cell_index = report.notebook.get('content', {}).get('cell_order', []).index(str(cell_id))

            Report.update_cell_outputs(self.report_id, cell_id, [])
            Report.update_cell_state(self.report_id, cell_id, CellState.QUEUED)
            self.report.apply_async(
                run_cell, (self.report_id, cell_id),
                creator=self.user,
                name='Run cell #{}'.format(cell_index)
            )
        case PacketType.CELL_RESULT:
            self.send_packet(PacketType.CELL_RESULT, packet.data)
        case PacketType.CELL_STATE:
            self.send_packet(PacketType.CELL_STATE, packet.data)

report() property

Source code in reports/consumers.py 
69
70
71
72
73
74
75
76
77
78
79
80
@property
def report(self) -> Report:
    report, created = Report.objects.get_or_create(
        id=self.report_id,
        defaults={
            'notebook': {
                'id': self.report_id,
            }
        }
    )

    return report

send_packet(type, data)

Source code in reports/consumers.py 
66
67
def send_packet(self, type: PacketType, data: Any):
    self.send(text_data=Packet(type.value, data).dumps())

task_message(event)

Source code in reports/consumers.py 
63
64
def task_message(self, event):
    self.receive(event['message'])