def test_get_pending_and_all_nodes_in_story(self):
result = story_fetchers.get_pending_and_all_nodes_in_story(
self.USER_ID, self.STORY_ID)
pending_nodes = result['pending_nodes']
self.assertEqual(len(pending_nodes), 1)
self.assertEqual(pending_nodes[0].description, '')
self.assertEqual(pending_nodes[0].title, 'Title 1')
self.assertEqual(pending_nodes[0].id, self.NODE_ID_1)
self.assertEqual(pending_nodes[0].exploration_id, None)
def get_canonical_story_dicts(
user_id: str, topic: topic_domain.Topic
) -> List[CannonicalStoryDict]:
"""Returns a list of canonical story dicts in the topic.
Args:
user_id: str. The ID of the user.
topic: Topic. The topic domain object.
Returns:
list(dict). A list of canonical story dicts in the given topic.
"""
canonical_story_ids: List[str] = topic.get_canonical_story_ids(
include_only_published=True)
canonical_story_summaries: List[Optional[story_domain.StorySummary]] = [
story_fetchers.get_story_summary_by_id(
canonical_story_id) for canonical_story_id
in canonical_story_ids]
canonical_story_dicts = []
for story_summary in canonical_story_summaries:
# Ruling out the possibility of None for mypy type checking.
assert story_summary is not None
pending_and_all_nodes_in_story = (
story_fetchers.get_pending_and_all_nodes_in_story(
user_id, story_summary.id))
all_nodes = pending_and_all_nodes_in_story['all_nodes']
pending_nodes = pending_and_all_nodes_in_story['pending_nodes']
pending_node_titles = [node.title for node in pending_nodes]
completed_node_titles = utils.compute_list_difference(
story_summary.node_titles, pending_node_titles)
# Here, the return type of 'to_human_readable_dict()' method is
# HumanReadableStorySummaryDict which does not have topic_url_fragment,
# story_is_published and other keys. To overcome this missing keys
# issues, we defined a CannonicalStoryDict and assigned it to the
# `story_summary_dict`. Due this a conflict in type assignment is
# raised which cause MyPy to throw `Incompatible types in assignment`
# error. Thus to avoid error, we used ignore here.
story_summary_dict: CannonicalStoryDict = (
story_summary.to_human_readable_dict() # type: ignore[assignment]
)
story_summary_dict['topic_url_fragment'] = topic.url_fragment
story_summary_dict['classroom_url_fragment'] = (
classroom_services.get_classroom_url_fragment_for_topic_id(
topic.id))
story_summary_dict['story_is_published'] = True
story_summary_dict['completed_node_titles'] = completed_node_titles
story_summary_dict['all_node_dicts'] = [
node.to_dict() for node in all_nodes]
canonical_story_dicts.append(story_summary_dict)
return canonical_story_dicts
def get_canonical_story_dicts(user_id, topic):
"""Returns a list of canonical story dicts in the topic.
Args:
user_id: str. The ID of the user.
topic: Topic. The topic domain object.
Returns:
list(dict). A list of canonical story dicts in the given topic.
"""
canonical_story_ids = topic.get_canonical_story_ids(
include_only_published=True)
canonical_story_summaries = [
story_fetchers.get_story_summary_by_id(canonical_story_id)
for canonical_story_id in canonical_story_ids
]
canonical_story_dicts = []
for story_summary in canonical_story_summaries:
pending_and_all_nodes_in_story = (
story_fetchers.get_pending_and_all_nodes_in_story(
user_id, story_summary.id))
all_nodes = pending_and_all_nodes_in_story['all_nodes']
pending_nodes = pending_and_all_nodes_in_story['pending_nodes']
pending_node_titles = [node.title for node in pending_nodes]
completed_node_titles = utils.compute_list_difference(
story_summary.node_titles, pending_node_titles)
story_summary_dict = story_summary.to_human_readable_dict()
story_summary_dict['topic_url_fragment'] = topic.url_fragment
story_summary_dict['classroom_url_fragment'] = (
classroom_services.get_classroom_url_fragment_for_topic_id(
topic.id))
story_summary_dict['story_is_published'] = True
story_summary_dict['completed_node_titles'] = completed_node_titles
story_summary_dict['all_node_dicts'] = [
node.to_dict() for node in all_nodes
]
canonical_story_dicts.append(story_summary_dict)
return canonical_story_dicts
def get(self, topic_name):
"""Handles GET requests."""
topic = topic_fetchers.get_topic_by_name(topic_name)
canonical_story_ids = topic.get_canonical_story_ids(
include_only_published=True)
additional_story_ids = topic.get_additional_story_ids(
include_only_published=True)
canonical_story_summaries = [
story_fetchers.get_story_summary_by_id(
canonical_story_id) for canonical_story_id
in canonical_story_ids]
additional_story_summaries = [
story_fetchers.get_story_summary_by_id(
additional_story_id) for additional_story_id
in additional_story_ids]
canonical_story_dicts = []
for story_summary in canonical_story_summaries:
all_nodes = story_fetchers.get_pending_and_all_nodes_in_story(
self.user_id, story_summary.id)['all_nodes']
pending_nodes = story_fetchers.get_pending_and_all_nodes_in_story(
self.user_id, story_summary.id)['pending_nodes']
pending_node_titles = [node.title for node in pending_nodes]
completed_node_titles = utils.compute_list_difference(
story_summary.node_titles, pending_node_titles)
story_summary_dict = story_summary.to_human_readable_dict()
story_summary_dict['story_is_published'] = True
story_summary_dict['completed_node_titles'] = completed_node_titles
story_summary_dict['all_node_dicts'] = [
node.to_dict() for node in all_nodes]
canonical_story_dicts.append(story_summary_dict)
additional_story_dicts = []
for story_summary in additional_story_summaries:
all_nodes = story_fetchers.get_pending_and_all_nodes_in_story(
self.user_id, story_summary.id)['all_nodes']
pending_nodes = story_fetchers.get_pending_and_all_nodes_in_story(
self.user_id, story_summary.id)['pending_nodes']
pending_node_titles = [node.title for node in pending_nodes]
completed_node_titles = utils.compute_list_difference(
story_summary.node_titles, pending_node_titles)
story_summary_dict = story_summary.to_human_readable_dict()
story_summary_dict['story_is_published'] = True
story_summary_dict['completed_node_titles'] = completed_node_titles
story_summary_dict['all_node_dicts'] = [
node.to_dict() for node in all_nodes]
additional_story_dicts.append(story_summary_dict)
uncategorized_skill_ids = topic.get_all_uncategorized_skill_ids()
subtopics = topic.get_all_subtopics()
all_skill_ids = topic.get_all_skill_ids()
skill_descriptions, deleted_skill_ids = (
skill_services.get_descriptions_of_skills(
all_skill_ids))
if deleted_skill_ids:
deleted_skills_string = ', '.join(deleted_skill_ids)
logging.exception(
'The deleted skills: %s are still present in topic with id %s'
% (deleted_skills_string, topic.id)
)
if feconf.CAN_SEND_EMAILS:
email_manager.send_mail_to_admin(
'Deleted skills present in topic',
'The deleted skills: %s are still present in topic with '
'id %s' % (deleted_skills_string, topic.id))
if self.user_id:
degrees_of_mastery = skill_services.get_multi_user_skill_mastery(
self.user_id, all_skill_ids)
else:
degrees_of_mastery = {}
for skill_id in all_skill_ids:
degrees_of_mastery[skill_id] = None
self.values.update({
'topic_id': topic.id,
'topic_name': topic.name,
'topic_description': topic.description,
'canonical_story_dicts': canonical_story_dicts,
'additional_story_dicts': additional_story_dicts,
'uncategorized_skill_ids': uncategorized_skill_ids,
'subtopics': subtopics,
'degrees_of_mastery': degrees_of_mastery,
'skill_descriptions': skill_descriptions,
'practice_tab_is_displayed': topic.practice_tab_is_displayed,
'meta_tag_content': topic.meta_tag_content,
'page_title_fragment_for_web': topic.page_title_fragment_for_web
})
self.render_json(self.values)
