feat: create built-in template engine, create settings

Author: alexeev-prog

CHANGELOG.md

@@ -1,3 +1,9 @@
+commit fc58f8f30efd759f59b4ec87800442a105f5c592
+Author: alexeev-prog <[email protected]>
+Date:   Mon Oct 28 21:23:05 2024 +0700
+
+    docs/feat/fix: improve routing views (fix bugs), improve readme
+
 commit 313ad646d2fdb10c45692e564b4381b548fe3a55
 Author: alexeev-prog <[email protected]>
 Date:   Mon Oct 28 00:34:48 2024 +0700

Doxyfile

@@ -48,7 +48,7 @@ PROJECT_NAME           = "pyEchoNext"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "0.2.1"
+PROJECT_NUMBER         = "0.3.1"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a

README.md

@@ -107,37 +107,43 @@ Once installed, you can start using the library in your Python projects. Check o
 ## 💻 Usage Examples
 
 ### Advanced app with flask-like and django-like routes
-Django-line classes with get-post methods and routing pages:
+Django-line classes with get-post methods and routing pages. And with the built-in template engine!
 
 ```python
+import os
 from pyechonext.app import ApplicationType, EchoNext
 from pyechonext.views import View
 from pyechonext.urls import URL, IndexView
+from pyechonext.config import Settings
+from pyechonext.template_engine.builtin import render_template
 
 
 class UsersView(View):
 	def get(self, request, response, **kwargs):
-		return "users get"
+		return render_template(
+			request, "index.html", user_name="User", friends=["Bob", "Anna", "John"]
+		)
 
 	def post(self, request, response, **kwargs):
-		return "users post"
+		return {"users": "post"}
 
 
-url_patterns = [
-	URL(url='/', view=IndexView),
-	URL(url='/users', view=UsersView)
-]
-
-echonext = EchoNext(__name__, urls=url_patterns, application_type=ApplicationType.HTML)
+url_patterns = [URL(url="/", view=IndexView), URL(url="/users", view=UsersView)]
+settings = Settings(
+	BASE_DIR=os.path.dirname(os.path.abspath(__file__)), TEMPLATES_DIR="templates"
+)
+echonext = EchoNext(
+	__name__, settings, urls=url_patterns, application_type=ApplicationType.HTML
+)
 
 
 @echonext.route_page("/book")
 class BooksResource(View):
 	def get(self, request, response, **kwargs):
-		return f"Books Page: {request.query_params}"
+		return f"GET Params: {request.GET}"
 
 	def post(self, request, response, **kwargs):
-		return "Endpoint to create a book"
+		return f"POST Params: {request.POST}"
 ```
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
@@ -146,14 +152,18 @@ class BooksResource(View):
 In this example we are using SQLSymphony ORM (our other project, a fast and simple ORM for python)
 
 ```python
+import os
 from pyechonext.app import ApplicationType, EchoNext
+from pyechonext.config import Settings
 from sqlsymphony_orm.datatypes.fields import IntegerField, RealField, TextField
 from sqlsymphony_orm.models.session_models import SessionModel
 from sqlsymphony_orm.models.session_models import SQLiteSession
-from sqlsymphony_orm.queries import QueryBuilder
 
 
-echonext = EchoNext(__name__, application_type=ApplicationType.HTML)
+settings = Settings(
+	BASE_DIR=os.path.dirname(os.path.abspath(__file__)), TEMPLATES_DIR="templates"
+)
+echonext = EchoNext(__name__, settings, application_type=ApplicationType.HTML)
 session = SQLiteSession("echonext.db")
 
 
@@ -170,7 +180,7 @@ class User(SessionModel):
 
 @echonext.route_page("/")
 def home(request, response):
-	user = User(name='John', cash=100.0)
+	user = User(name="John", cash=100.0)
 	session.add(user)
 	session.commit()
 	response.body = "Hello from the HOME page"
@@ -179,8 +189,9 @@ def home(request, response):
 @echonext.route_page("/users")
 def about(request, response):
 	users = session.get_all_by_model(User)
-	
+
 	response.body = f"Users: {[f'{user.name}: {user.cash}$' for user in users]}"
+
 ```
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>

SECURITY.md

@@ -7,9 +7,10 @@ currently being supported with security updates.
 
 | Version | Supported          |
 | ------- | ------------------ |
+| 0.3.1  | :white_check_mark:  |
 | 0.2.1  | :white_check_mark:  |
 | 0.1.1  | :white_check_mark:  |
-| 0.1.0  | :white_check_mark:  |
+| 0.1.0  | :x                  |
 
 ## Reporting a Vulnerability
 

examples/advanced_app.py

@@ -1,6 +1,8 @@
+import os
 from pyechonext.app import ApplicationType, EchoNext
 from pyechonext.views import View
 from pyechonext.urls import URL, IndexView
+from pyechonext.config import Settings
 
 
 class UsersView(View):
@@ -12,14 +14,18 @@ def post(self, request, response, **kwargs):
 
 
 url_patterns = [URL(url="/", view=IndexView), URL(url="/users", view=UsersView)]
-
-echonext = EchoNext(__name__, urls=url_patterns, application_type=ApplicationType.HTML)
+settings = Settings(
+	BASE_DIR=os.path.dirname(os.path.abspath(__file__)), TEMPLATES_DIR="templates"
+)
+echonext = EchoNext(
+	__name__, settings, urls=url_patterns, application_type=ApplicationType.HTML
+)
 
 
 @echonext.route_page("/book")
 class BooksResource(View):
 	def get(self, request, response, **kwargs):
-		return f"Books Page: {request.query_params}"
+		return f"Books Page: {request.GET}"
 
 	def post(self, request, response, **kwargs):
 		return "Endpoint to create a book"

examples/simple_api.py

@@ -0,0 +1,34 @@
+import os
+from pyechonext.app import ApplicationType, EchoNext
+from pyechonext.views import View
+from pyechonext.urls import URL, IndexView
+from pyechonext.response import Response
+from pyechonext.config import Settings
+
+
+class UsersView(View):
+	def get(self, request, response, **kwargs):
+		return Response(body={"users": "get"})
+
+	def post(self, request, response, **kwargs):
+		return {"users": "post"}
+
+
+url_patterns = [URL(url="/", view=IndexView), URL(url="/users", view=UsersView)]
+
+settings = Settings(
+	BASE_DIR=os.path.dirname(os.path.abspath(__file__)), TEMPLATES_DIR="templates"
+)
+
+echonext = EchoNext(
+	__name__, settings, urls=url_patterns, application_type=ApplicationType.JSON
+)
+
+
+@echonext.route_page("/book")
+class BooksResource(View):
+	def get(self, request, response, **kwargs):
+		return {"params": {request.GET}, "page": "books"}
+
+	def post(self, request, response, **kwargs):
+		return {"params": {request.POST}, "page": "books"}

examples/simple_app.py

@@ -1,10 +1,15 @@
+import os
 from pyechonext.app import ApplicationType, EchoNext
+from pyechonext.config import Settings
 from sqlsymphony_orm.datatypes.fields import IntegerField, RealField, TextField
 from sqlsymphony_orm.models.session_models import SessionModel
 from sqlsymphony_orm.models.session_models import SQLiteSession
 
 
-echonext = EchoNext(__name__, application_type=ApplicationType.HTML)
+settings = Settings(
+	BASE_DIR=os.path.dirname(os.path.abspath(__file__)), TEMPLATES_DIR="templates"
+)
+echonext = EchoNext(__name__, settings, application_type=ApplicationType.HTML)
 session = SQLiteSession("echonext.db")
 
 

examples/templates/index.html

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+	<meta charset="UTF-8">
+	<meta name="viewport" content="width=device-width, initial-scale=1.0">
+	<title>Document</title>
+</head>
+<body>
+	<h1>{{ user_name }}</h1>
+	<h3>Friends</h3>
+	{% for friend in friends %}
+		<p>{{ friend }}</p>
+	{% endblock %}
+</body>
+</html>

examples/webapp.py

@@ -0,0 +1,34 @@
+import os
+from pyechonext.app import ApplicationType, EchoNext
+from pyechonext.views import View
+from pyechonext.urls import URL, IndexView
+from pyechonext.config import Settings
+from pyechonext.template_engine.builtin import render_template
+
+
+class UsersView(View):
+	def get(self, request, response, **kwargs):
+		return render_template(
+			request, "index.html", user_name="User", friends=["Bob", "Anna", "John"]
+		)
+
+	def post(self, request, response, **kwargs):
+		return {"users": "post"}
+
+
+url_patterns = [URL(url="/", view=IndexView), URL(url="/users", view=UsersView)]
+settings = Settings(
+	BASE_DIR=os.path.dirname(os.path.abspath(__file__)), TEMPLATES_DIR="templates"
+)
+echonext = EchoNext(
+	__name__, settings, urls=url_patterns, application_type=ApplicationType.HTML
+)
+
+
+@echonext.route_page("/book")
+class BooksResource(View):
+	def get(self, request, response, **kwargs):
+		return f"GET Params: {request.GET}"
+
+	def post(self, request, response, **kwargs):
+		return f"POST Params: {request.POST}"

pyechonext/app.py

@@ -15,6 +15,7 @@
 	WebError,
 )
 from pyechonext.utils import _prepare_url
+from pyechonext.config import Settings
 
 
 class ApplicationType(Enum):
@@ -24,18 +25,20 @@ class ApplicationType(Enum):
 
 	JSON = "application/json"
 	HTML = "text/html"
+	PLAINTEXT = "text/plain"
 
 
 class EchoNext:
 	"""
 	This class describes an EchoNext WSGI Application.
 	"""
 
-	__slots__ = ("app_name", "application_type", "urls", "routes")
+	__slots__ = ("app_name", "settings", "application_type", "urls", "routes")
 
 	def __init__(
 		self,
 		app_name: str,
+		settings: Settings,
 		urls: Optional[List[URL]] = [],
 		application_type: Optional[ApplicationType] = ApplicationType.JSON,
 	):
@@ -46,6 +49,7 @@ def __init__(
 		:type		app_name:  str
 		"""
 		self.app_name = app_name
+		self.settings = settings
 		self.application_type = application_type
 		self.routes = {}
 		self.urls = urls
@@ -107,7 +111,7 @@ def _get_request(self, environ: dict) -> Request:
 		:returns:	The request.
 		:rtype:		Request
 		"""
-		return Request(environ)
+		return Request(environ, self.settings)
 
 	def _get_response(self) -> Response:
 		"""
@@ -201,7 +205,12 @@ def _handle_request(self, request: Request) -> Response:
 				if handler is None:
 					raise MethodNotAllow(f"Method not allowed: {request.method}")
 
-			response.body = handler(request, response, **kwargs)
+			result = handler(request, response, **kwargs)
+
+			if isinstance(result, Response):
+				response = result
+			else:
+				response.body = result
 		else:
 			raise URLNotFound(f'URL "{request.path}" not found.')