Skip to content

feat: Add ability to check events that are type annotated #535

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bmtcril wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat: Add ability to check events that are type annotated #535

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 33 additions & 7 deletions edx_lint/pylint/events_annotation/events_annotation_check.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
Pylint plugin: checks that Open edX Events are properly annotated.
"""

from astroid.nodes.node_classes import Name
from astroid.nodes.node_classes import AnnAssign, Name
from pylint.checkers import utils

from edx_lint.pylint.annotations_check import AnnotationBaseChecker, check_all_messages
Expand Down Expand Up @@ -59,7 +59,7 @@ class EventsAnnotationChecker(AnnotationBaseChecker):
(
"When an Open edX event object is created, a corresponding annotation must be present above in the"
" same module and with a matching type",
)
),
),
}

Expand Down Expand Up @@ -109,7 +109,11 @@ def check_annotation_group(self, search, annotations, node):
elif annotation["annotation_token"] == ".. event_description:":
event_description = annotation["annotation_data"]
if event_type and event_data and event_name:
self.current_module_annotation_group_map[line_number] = (event_type, event_data, event_name,)
self.current_module_annotation_group_map[line_number] = (
event_type,
event_data,
event_name,
)

if not event_type:
self.add_message(
Expand Down Expand Up @@ -180,9 +184,13 @@ def _is_annotation_missing_or_incorrect(self, node):
if annotation_line_number > node.tolineno:
# The next annotation is located after the current node
return True
annotation_line_number = self.current_module_annotation_group_line_numbers.pop(0)
annotation_line_number = self.current_module_annotation_group_line_numbers.pop(
0
)

current_annotation_group = self.current_module_annotation_group_map[annotation_line_number]
current_annotation_group = self.current_module_annotation_group_map[
annotation_line_number
]
if not current_annotation_group:
# The annotation group with type or data or name for the line is empty, but should be caught by the
# annotation checks
Expand All @@ -195,10 +203,28 @@ def _is_annotation_missing_or_incorrect(self, node):
# event_type="org.openedx.subdomain.action.emitted.v1",
# event_data={"my_data": MyEventData},
# )
#
# A type annotated event like this needs slightly different handling
# MyEvnet: OpenEdxPublicSignal = OpenEdxPublicSignal(
# event_type="org.openedx.analytics.tracking.event.emitted.v1",
# data={
# "tracking_log": TrackingLogData,
# },
# )

# If the node is type annotated it will be an AnnAssign
if isinstance(node.parent, AnnAssign):
node_event_name = node.parent.target.name
else:
node_event_name = node.parent.targets[0].name

node_event_type = node.keywords[0].value.value
node_event_data = node.keywords[1].value.items[0][1].name
node_event_name = node.parent.targets[0].name
if node_event_type != event_type or node_event_data != event_data or node_event_name != event_name:
if (
node_event_type != event_type
or node_event_data != event_data
or node_event_name != event_name
):
return True

return False
Loading