325fbe4eb2
All code in this PR should be removed after REVE-52 is merged and mobile traffic from older app versions falls to < 5% of the mobile traffic to the course_blocks api
44 lines
1.4 KiB
Python
44 lines
1.4 KiB
Python
"""
|
|
Hide Empty Transformer implementation.
|
|
"""
|
|
# TODO: Remove this file after REVE-52 lands and old-mobile-app traffic falls to < 5% of mobile traffic
|
|
from openedx.core.djangoapps.content.block_structure.transformer import (
|
|
BlockStructureTransformer
|
|
)
|
|
|
|
|
|
class HideEmptyTransformer(BlockStructureTransformer):
|
|
"""
|
|
A transformer that removes any block from the course that could have
|
|
children but doesn't.
|
|
"""
|
|
WRITE_VERSION = 1
|
|
READ_VERSION = 1
|
|
|
|
@classmethod
|
|
def name(cls):
|
|
"""
|
|
Unique identifier for the transformer's class;
|
|
same identifier used in setup.py.
|
|
"""
|
|
return "hide_empty"
|
|
|
|
@classmethod
|
|
def collect(cls, block_structure):
|
|
"""
|
|
Collects any information that's necessary to execute this
|
|
transformer's transform method.
|
|
"""
|
|
block_structure.request_xblock_fields('children', 'has_children')
|
|
|
|
def transform(self, usage_info, block_structure):
|
|
def _filter(block_key):
|
|
has_children = block_structure.get_xblock_field(block_key, 'has_children')
|
|
children = block_structure.get_xblock_field(block_key, 'children')
|
|
return has_children and not any(child in block_structure for child in children)
|
|
|
|
for _ in block_structure.post_order_traversal(
|
|
filter_func=block_structure.create_removal_filter(_filter)
|
|
):
|
|
pass
|