Skip to content

Commit ba37f68

Browse files
committed
fix: Use constants instead of string values.
This will reduce work if the constants ever change in the future.
1 parent 5558107 commit ba37f68

File tree

1 file changed

+35
-18
lines changed

1 file changed

+35
-18
lines changed

backend/sample_plugin/apps.py

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
"""
44

55
from django.apps import AppConfig
6+
from edx_django_utils.plugins.constants import (
7+
PluginURLs,
8+
PluginSettings,
9+
PluginSignals,
10+
)
611

712

813
class SamplePluginConfig(AppConfig):
@@ -15,38 +20,50 @@ class SamplePluginConfig(AppConfig):
1520
plugin_app = {
1621
"url_config": {
1722
"lms.djangoapp": {
18-
"namespace": "sample_plugin",
19-
"regex": r"^sample-plugin/",
20-
"relative_path": "urls",
23+
PluginURLs.NAMESPACE: "sample_plugin",
24+
PluginURLs.REGEX: r"^sample-plugin/",
25+
PluginURLs.RELATIVE_PATH: "urls",
2126
},
2227
"cms.djangoapp": {
23-
"namespace": "sample_plugin",
24-
"regex": r"^sample-plugin/",
25-
"relative_path": "urls",
28+
PluginURLs.NAMESPACE: "sample_plugin",
29+
PluginURLs.REGEX: r"^sample-plugin/",
30+
PluginURLs.RELATIVE_PATH: "urls",
2631
},
2732
},
28-
"settings_config": {
33+
PluginSettings.CONFIG: {
2934
"lms.djangoapp": {
30-
"common": {"relative_path": "settings.common"},
31-
"test": {"relative_path": "settings.test"},
32-
"production": {"relative_path": "settings.production"},
35+
"common": {
36+
PluginURLs.RELATIVE_PATH: "settings.common",
37+
},
38+
"test": {
39+
PluginURLs.RELATIVE_PATH: "settings.test",
40+
},
41+
"production": {
42+
PluginURLs.RELATIVE_PATH: "settings.production",
43+
},
3344
},
3445
"cms.djangoapp": {
35-
"common": {"relative_path": "settings.common"},
36-
"test": {"relative_path": "settings.test"},
37-
"production": {"relative_path": "settings.production"},
46+
"common": {
47+
PluginURLs.RELATIVE_PATH: "settings.common",
48+
},
49+
"test": {
50+
PluginURLs.RELATIVE_PATH: "settings.test",
51+
},
52+
"production": {
53+
PluginURLs.RELATIVE_PATH: "settings.production",
54+
},
3855
},
3956
},
40-
"signals_config": {
57+
PluginSignals.CONFIG: {
4158
"lms.djangoapp": {
42-
"relative_path": "signals",
43-
"receivers": [
59+
PluginURLs.RELATIVE_PATH: "signals",
60+
PluginSignals.RECEIVERS: [
4461
# Signals handlers can be registered here
4562
],
4663
},
4764
"cms.djangoapp": {
48-
"relative_path": "signals",
49-
"receivers": [
65+
PluginURLs.RELATIVE_PATH: "signals",
66+
PluginSignals.RECEIVERS: [
5067
# Signals handlers can be registered here
5168
],
5269
},

0 commit comments

Comments
 (0)