Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions openedx_learning/apps/authoring/components/apps.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ def ready(self) -> None:
"""
Register Component and ComponentVersion.
"""
from ..publishing.api import register_content_models # pylint: disable=import-outside-toplevel
from ..publishing.api import register_publishable_models # pylint: disable=import-outside-toplevel
from .models import Component, ComponentVersion # pylint: disable=import-outside-toplevel

register_content_models(Component, ComponentVersion)
register_publishable_models(Component, ComponentVersion)
8 changes: 4 additions & 4 deletions openedx_learning/apps/authoring/publishing/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
"set_draft_version",
"soft_delete_draft",
"reset_drafts_to_published",
"register_content_models",
"register_publishable_models",
"filter_publishable_entities",
# 🛑 UNSTABLE: All APIs related to containers are unstable until we've figured
# out our approach to dynamic content (randomized, A/B tests, etc.)
Expand Down Expand Up @@ -789,7 +789,7 @@ def reset_drafts_to_published(
set_draft_version(draft, published_version_id)


def register_content_models(
def register_publishable_models(
content_model_cls: type[PublishableEntityMixin],
content_version_model_cls: type[PublishableEntityVersionMixin],
) -> PublishableContentModelRegistry:
Expand All @@ -805,10 +805,10 @@ def register_content_models(
method. For example, in the components app, this looks like:

def ready(self):
from ..publishing.api import register_content_models
from ..publishing.api import register_publishable_models
from .models import Component, ComponentVersion

register_content_models(Component, ComponentVersion)
register_publishable_models(Component, ComponentVersion)

There may be a more clever way to introspect this information from the model
metadata, but this is simple and explicit.
Expand Down
4 changes: 2 additions & 2 deletions openedx_learning/apps/authoring/publishing/apps.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ def ready(self):
"""
Register Container and ContainerVersion.
"""
from .api import register_content_models # pylint: disable=import-outside-toplevel
from .api import register_publishable_models # pylint: disable=import-outside-toplevel
from .models import Container, ContainerVersion # pylint: disable=import-outside-toplevel

register_content_models(Container, ContainerVersion)
register_publishable_models(Container, ContainerVersion)
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ class PublishableEntityMixin(models.Model):
Please see docstring for PublishableEntity for more details.

If you use this class, you *MUST* also use PublishableEntityVersionMixin and
the publishing app's api.register_content_models (see its docstring for
the publishing app's api.register_publishable_models (see its docstring for
details).
"""
# select these related entities by default for all queries
Expand Down Expand Up @@ -551,7 +551,7 @@ class PublishableEntityVersionMixin(models.Model):
Please see docstring for PublishableEntityVersion for more details.

If you use this class, you *MUST* also use PublishableEntityMixin and the
publishing app's api.register_content_models (see its docstring for
publishing app's api.register_publishable_models (see its docstring for
details).
"""

Expand Down Expand Up @@ -609,7 +609,7 @@ def register(
Register what content model maps to what content version model.

If you want to call this from another app, please use the
``register_content_models`` function in this app's ``api`` module
``register_publishable_models`` function in this app's ``api`` module
instead.
"""
if not issubclass(content_model_cls, PublishableEntityMixin):
Expand Down
4 changes: 2 additions & 2 deletions openedx_learning/apps/authoring/sections/apps.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ def ready(self):
"""
Register Section and SectionVersion.
"""
from ..publishing.api import register_content_models # pylint: disable=import-outside-toplevel
from ..publishing.api import register_publishable_models # pylint: disable=import-outside-toplevel
from .models import Section, SectionVersion # pylint: disable=import-outside-toplevel

register_content_models(Section, SectionVersion)
register_publishable_models(Section, SectionVersion)
4 changes: 2 additions & 2 deletions openedx_learning/apps/authoring/subsections/apps.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ def ready(self):
"""
Register Subsection and SubsectionVersion.
"""
from ..publishing.api import register_content_models # pylint: disable=import-outside-toplevel
from ..publishing.api import register_publishable_models # pylint: disable=import-outside-toplevel
from .models import Subsection, SubsectionVersion # pylint: disable=import-outside-toplevel

register_content_models(Subsection, SubsectionVersion)
register_publishable_models(Subsection, SubsectionVersion)
4 changes: 2 additions & 2 deletions openedx_learning/apps/authoring/units/apps.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ def ready(self):
"""
Register Unit and UnitVersion.
"""
from ..publishing.api import register_content_models # pylint: disable=import-outside-toplevel
from ..publishing.api import register_publishable_models # pylint: disable=import-outside-toplevel
from .models import Unit, UnitVersion # pylint: disable=import-outside-toplevel

register_content_models(Unit, UnitVersion)
register_publishable_models(Unit, UnitVersion)