"""
Django URL patterns for the prompt app. These are the
endpoints for for the Workbench React app and chat configuration.
how we got here:
- /
- /workbench/<str:name>/config/
"""
from django.urls import include, path
from smarter.common.utils import camel_to_snake
from .api.const import namespace as api_namespace
from .const import namespace
from .views import (
ChatAppWorkbenchView,
ChatConfigView,
ManifestDropZoneView,
PromptLandingView,
PromptListView,
PromptManifestView,
)
app_name = namespace
[docs]
class PromptReverseViews:
"""
Reverse views for the Prompt app.
Provides named references for reversing Prompt-related API endpoints.
This class is used for reverse URL resolution in Django, where each attribute
corresponds to a Prompt command endpoint. The names are derived from the actual
API view class names, ensuring consistency and reducing the risk of typos
when using Django's URL reversing features.
All Prompt endpoints in the Smarter platform are included as attributes
of this class. This centralizes the reverse URL names for all Prompt endpoints,
making it easier to maintain and reference them throughout the codebase.
Usage
-----
Use these attributes with Django's ``reverse()`` function or in templates
to generate URLs for Prompt API endpoints based on the view class names.
Example
-------
.. code-block:: python
from django.urls import reverse
url = reverse(PromptReverseViews.describe, kwargs={'hashed_id': 'rMTAwMDAzOQx'})
# returns manifest of the chatbot with the given hashed_id
retval = PromptReverseViews.describe
print(retval)
"""
namespace = namespace
[docs]
@staticmethod
def camel_case(obj) -> str:
"""
Convert CamelCase to snake_case for URL naming.
:param name: The CamelCase string to convert.
:return: The converted snake_case string.
:rtype: str
"""
return str(camel_to_snake(obj.__name__))
prompt_manifest_by_hashed_id = camel_case(PromptManifestView)
prompt_chat_by_hashed_id = camel_case(ChatAppWorkbenchView)
prompt_config_by_hashed_id = camel_case(ChatConfigView)
prompt_landing_by_hashed_id = camel_case(PromptLandingView)
apply = "apply"
urlpatterns = [
path("", PromptListView.as_view(), name="listview"),
path("api/", include("smarter.apps.prompt.api.urls", namespace=api_namespace)),
path("chatbots/<str:hashed_id>/", PromptLandingView.as_view(), name=PromptReverseViews.prompt_landing_by_hashed_id),
path(
"chatbots/<str:hashed_id>/manifest/",
PromptManifestView.as_view(),
name=PromptReverseViews.prompt_manifest_by_hashed_id,
),
path(
"chatbots/<str:hashed_id>/chat/",
ChatAppWorkbenchView.as_view(),
name=PromptReverseViews.prompt_chat_by_hashed_id,
),
path(
"chatbots/<str:hashed_id>/config/", ChatConfigView.as_view(), name=PromptReverseViews.prompt_config_by_hashed_id
),
path(
"manifest/apply/",
ManifestDropZoneView.as_view(),
name=PromptReverseViews.apply,
),
]