Andal.LND/edx-platform
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #28129 from edx/jhynes/microba-1289_overviews

Browse Source 
refactor!: remove the `get_course_overview` function in favor of `get_course_overview_or_none`
This commit is contained in:
Justin Hynes
2021-07-13 07:59:49 -04:00
committed by GitHub
parent b04082dd40 725793a8f9
commit 9f5b9ba915
6 changed files with 15 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
openedx/core/djangoapps/content/course_overviews/api.py
View File

@@ -11,13 +11,6 @@ from openedx.core.djangoapps.content.course_overviews.serializers import (
log = logging.getLogger(__name__)
def get_course_overview(course_id):
"""
Retrieve and return course overview data for the provided course id.
"""
return CourseOverview.get_from_id(course_id)
def get_course_overview_or_none(course_id):
"""
Retrieve and return course overview data for the provided course id.
@@ -25,7 +18,7 @@ def get_course_overview_or_none(course_id):
If the course overview does not exist, return None.
"""
try:
return get_course_overview(course_id)
return CourseOverview.get_from_id(course_id)
except CourseOverview.DoesNotExist:
log.warning(f"Course overview does not exist for {course_id}")
return None

9
openedx/core/djangoapps/content/course_overviews/tests/test_api.py
View File

@@ -5,7 +5,6 @@ course_overview api tests
from opaque_keys.edx.keys import CourseKey
from openedx.core.djangoapps.content.course_overviews.api import (
get_course_overview,
get_course_overview_or_none,
get_course_overviews
)
@@ -24,14 +23,6 @@ class TestCourseOverviewsApi(ModuleStoreTestCase):
for _ in range(3):
CourseOverviewFactory.create()
def test_get_course_overview(self):
"""
Test for `get_course_overview` function to retrieve a single course overview.
"""
course_overview = CourseOverviewFactory.create()
retrieved_course_overview = get_course_overview(course_overview.id)
assert course_overview.id == retrieved_course_overview.id
def test_get_course_overview_or_none(self):
"""
Test for `test_get_course_overview_or_none` function when the overview exists.