Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Refactor or deprecate parent-child relationships between XBlocks

未关闭
#729 2 条评论 0 个 reaction 已指派 1 人 在 GitHub 查看

@kdmccormick 已经在做这个了。

开始于 2025年11月10日。

评估

这个 Issue 还没有评估数据。

描述

This would be a long-term initiative. It probably belongs on the platform-roadmap.

Context

We have decided that parent-child relationships should only exist at/below the VerticalBlock: https://github.com/openedx/edx-platform/blob/master/docs/decisions/0006-role-of-xblock.rst

We have further discussed that parent-child relationships in their entirety should be removed; I'm not sure if we came to a consensus on that.

TODO -- Add more context ( @ormsbee , @kdmccormick , and @bradenmacdonald ).

Tasks

Off the top of my head...

  • File a DEPR encompassing our plan to:
    • Remove parent-child relationships on the base XBlock class. Delete the _HasChildrenMetaclass. Move all parent-child logic to a new subclass, XBlockWithChildren. Make it XBlock.has_children a read-only class property. Some details.
    • Raise an exception if get_parent is called at or above the VerticalBlock level.
    • For all XBlockWithChildren subclasses above the VerticalBlock (so, CourseBlock, SectionBlock, and SequenceBlock): Move their implementations to either Learning Core or edx-platform djangoapps.
  • Decide: Should parent-child relationships still exist at/below the Vertical block?
    • Either way -> ADR it.
    • Yes -> We're done.
    • No -> File another DEPR encompassing our plan to:
      • Raise deprecation warnings on the XBlockWithChildren class.
      • For all remaining XBlockWithChildren subclasses in edx-platform (eg, LibraryContentBlock, SplitTestBlock):
        Move their implementations to either Learning Core or edx-platform djangoapps.
      • Write guidance on how custom XBlockWithChildren subclasses can be similarly migrated. Ensure that, for example, OpenCraft's ProblemBuilder block can be migrated using this guide.
      • Delete the XBlockWithChildren class, and delete all parent-child logic from the XBlock repository.
      • Delete all parent-child logic from modulestore and edx-platform's XBlock runtimes.
主要语言
Python
星标
470
派生
231
平均合并
2 天 14 小时
30 天内合并 PR
7

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

openedx/XBlock 的其他 Issue

查看 openedx/XBlock 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。