lms.lib package

Subpackages

• lms.lib.courseware_search package
  • Submodules
  • lms.lib.courseware_search.lms_filter_generator module
    • LmsSearchFilterGenerator
      • LmsSearchFilterGenerator.exclude_dictionary()
      • LmsSearchFilterGenerator.field_dictionary()
  • lms.lib.courseware_search.lms_result_processor module
    • LmsSearchResultProcessor
      • LmsSearchResultProcessor.get_course_blocks()
      • LmsSearchResultProcessor.get_course_key()
      • LmsSearchResultProcessor.get_module_store()
      • LmsSearchResultProcessor.get_usage_key()
      • LmsSearchResultProcessor.should_remove()
      • LmsSearchResultProcessor.url
  • lms.lib.courseware_search.lms_search_initializer module
    • LmsSearchInitializer
      • LmsSearchInitializer.initialize()
  • Module contents
• lms.lib.xblock package
  • Module contents

Submodules

lms.lib.utils module

Helper methods for the LMS.

lms.lib.utils.get_parent_unit(xblock)

Finds xblock’s parent unit if it exists.

To find an xblock’s parent unit, we traverse up the xblock’s family tree until we find an xblock whose parent is a sequential xblock, which guarantees that the xblock is a unit. The get_parent() call on both the xblock and the parent block ensure that we don’t accidentally return that a unit is its own parent unit.

Returns:

Returns the parent unit xblock if it exists. If no parent unit exists, returns None

Return type:

xblock

lms.lib.utils.is_unit(xblock)

Checks whether the xblock is a unit.

Get_parent_unit() returns None if the current xblock either does not have a parent unit or is itself a unit. To make sure that get_parent_unit() isn’t returning None because the xblock is an orphan, we check that the xblock has a parent.

Returns:

True if the xblock is itself a unit, False otherwise.

Module contents