1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
# Copyright 2009-2011 Canonical Ltd. This software is licensed under the
# GNU Affero General Public License version 3 (see the file LICENSE).
# pylint: disable-msg=E0211
"""CodeReviewComment interfaces."""
__metaclass__ = type
__all__ = [
'ICodeReviewComment',
'ICodeReviewCommentDeletion',
]
from lazr.restful.declarations import (
export_as_webservice_entry,
exported,
)
from lazr.restful.fields import Reference
from zope.interface import Interface
from zope.schema import (
Choice,
Datetime,
Int,
Object,
TextLine,
)
from canonical.launchpad import _
from lp.code.enums import CodeReviewVote
from lp.code.interfaces.branchmergeproposal import IBranchMergeProposal
from lp.registry.interfaces.person import IPerson
from lp.services.messages.interfaces.message import IMessage
class ICodeReviewComment(Interface):
"""A link between a merge proposal and a message."""
export_as_webservice_entry()
id = exported(
Int(
title=_('DB ID'), required=True, readonly=True,
description=_("The tracking number for this comment.")))
branch_merge_proposal = exported(
Reference(
title=_('The branch merge proposal'), schema=IBranchMergeProposal,
required=True, readonly=True))
message = Object(schema=IMessage, title=_('The message.'))
author = exported(
Reference(title=_('Comment Author'), schema=IPerson,
required=True, readonly=True))
date_created = exported(
Datetime(title=_('Date Created'), required=True, readonly=True))
vote = exported(
Choice(
title=_('Review'), required=False,
vocabulary=CodeReviewVote))
vote_tag = exported(
TextLine(
title=_('Vote tag'), required=False))
title = exported(
TextLine(
title=_('The title of the comment')))
message_body = exported(
TextLine(
title=_('The body of the code review message.'),
readonly=True))
def getAttachments():
"""Get the attachments from the original message.
:return: two lists, the first being attachments that we would display
(being plain text or diffs), and a second list being any other
attachments.
"""
def getOriginalEmail():
"""An email object of the original raw email if there was one."""
as_quoted_email = exported(
TextLine(
title=_('The message as quoted in email.'),
readonly=True))
class ICodeReviewCommentDeletion(Interface):
"""This interface provides deletion of CodeReviewComments.
This is the only mutation of CodeReviewCommentss that is permitted.
"""
def destroySelf():
"""Delete this message."""
|