fix/feat: fix codestyle, bugs, docstrings, add PrefixTree and improve routing system

Author: alexeev-prog

CHANGELOG.md

@@ -1,3 +1,9 @@
+commit e244bff1db90fb0714a0c23f3ffdee3c0192a376
+Author: Alexeev Bronislav <alexeev.dev@mail.ru>
+Date: Sun Apr 27 00:31:31 2025 +0700
+
+ some changes
+
 commit 84c7a3d2b8b4f997c039e6e515f18bc48e8fb8e5
 Author: Alexeev Bronislav <alexeev.dev@mail.ru>
 Date: Sat Apr 26 23:34:40 2025 +0700

README.md

@@ -31,8 +31,8 @@
  <img src="https://img.shields.io/github/stars/alexeev-prog/pyEchoNext?style=for-the-badge">
  <img src="https://img.shields.io/github/issues/alexeev-prog/pyEchoNext?style=for-the-badge">
  <img src="https://img.shields.io/github/last-commit/alexeev-prog/pyEchoNext?style=for-the-badge">
- <img src="https://img.shields.io/pypi/wheel/uvolution?style=for-the-badge">
- <img src="https://img.shields.io/badge/coverage-73%25-73%25?style=for-the-badge" alt="">
+ <img src="https://img.shields.io/pypi/wheel/pyechonext?style=for-the-badge">
+ <img src="https://img.shields.io/badge/coverage-73%25-73%25?style=for-the-badge" alt="Coverage">
  <img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/pyEchoNext?style=for-the-badge">
  <img alt="PyPI - Version" src="https://img.shields.io/pypi/v/pyEchoNext?style=for-the-badge">
  <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/pyEchoNext?style=for-the-badge">
@@ -172,6 +172,35 @@ calculate(4) # Output: 16
 ## 💻 Usage Examples
 You can view examples at [examples directory](./examples).
 
+### Prefix Tree (Trie)
+Prefix Tree data structure (this structure also used in pyechonext routing system)
+
+```python
+from pyechonext.utils.trie import PrefixTree
+
+if __name__ == '__main__':
+ trie = PrefixTree()
+ trie.insert('apple')
+ trie.insert('app')
+ trie.insert('aposematic')
+ trie.insert('appreciate')
+ trie.insert('book')
+ trie.insert('bad')
+ trie.insert('bear')
+ trie.insert('bat')
+ print(trie.starts_with('app'))
+
+ router_tree = PrefixTree()
+ router_tree.insert('index')
+ router_tree.insert('users')
+ router_tree.insert('transactions')
+ router_tree.insert('wallets')
+ router_tree.insert('wallets/create')
+
+ print(router_tree.starts_with('wa'))
+
+```
+
 ### i18n with hermes-langlib
 Hermes LangLib - a fast and light python library for translating, localizing and internationalizing your applications. The library is aimed at high speed and stability; it can be used in highly loaded projects.
 

pyechonext/app.py

@@ -12,7 +12,7 @@
 from pyechonext.logging import logger
 from pyechonext.middleware import BaseMiddleware
 from pyechonext.mvc.controllers import PageController
-from pyechonext.mvc.routes import Route, Router, RoutesTypes
+from pyechonext.mvc.routes import Route, Router, RoutesTypes, generate_page_route
 from pyechonext.request import Request
 from pyechonext.response import Response
 from pyechonext.static import StaticFile, StaticFilesManager
@@ -49,8 +49,8 @@ def _default_response(response: Response, error: WebError) -> None:
  """Get default response (HTTP 404)
 
  Args:
-  response (Response): Response object
-  error (WebError): web error
+ response (Response): Response object
+ error (WebError): web error
  """
  response.status_code = str(error.code)
  response.body = str(error)
@@ -60,14 +60,14 @@ def _check_handler(request: Request, route: Route) -> Callable:
  """Check handler
 
  Args:
-  request (Request): request object
-  handler (Callable): handler
+ request (Request): request object
+ route (Route): route
 
  Raises:
-  MethodNotAllow: handler request method is None, method not allowed
+ MethodNotAllow: handler request method is None, method not allowed
 
  Returns:
-  Callable: handler object
+ Callable: handler object
  """
  handler = route.handler
 
@@ -188,34 +188,44 @@ def add_route(
  self,
  page_path: str,
  handler: Callable | PageController,
- methods: List[str] = ["GET"],
+ methods: Optional[List[str]] = None,
  summary: Optional[str] = None,
  ):
  """Add page route without decorator
 
  Args:
  page_path (str): page path url
  handler (Callable): handler of route
+ methods (Optional[List[str]]): supported methods of handler. Defaults to None.
  summary (Optional[str], optional): summary documentation. Defaults to None.
  """
+ if methods is None:
+ methods = ["GET"]
  if inspect.isclass(handler):
  self.router.add_url(URL(path=page_path, controller=handler))
  else:
  self.router.add_page_route(page_path, handler, methods, summary)
 
  def route_page(
- self, page_path: str, methods: list = ["GET"], summary: Optional[str] = None
+ self,
+ page_path: str,
+ methods: Optional[List[str]] = None,
+ summary: Optional[str] = None,
  ) -> Callable:
  """Route page decorator
 
  Args:
  page_path (str): page path url
+ methods (Optional[List[str]]): supported methods of handler. Defaults to None.
  summary (Optional[str], optional): summary documentation. Defaults to None.
 
  Returns:
  Callable: wrapper
  """
 
+ if methods is None:
+ methods = ["GET"]
+
  def wrapper(handler: Callable | PageController):
  if inspect.isclass(handler):
  self.router.add_url(
@@ -321,8 +331,8 @@ def _find_handler(
 
  if self.static_files_manager.serve_static_file(url):
  return (
- self.router.generate_page_route(
- url, self._serve_static_file, f"Serving static file: {url}"
+ generate_page_route(
+ url, self._serve_static_file, None, f"Serving static file: {url}"
  ),
  {},
  )

pyechonext/config.py

@@ -25,7 +25,7 @@ def dynamic_import(module: str):
  return importlib.import_module(str(module))
 
 
-@dataclass
+@dataclass(frozen=True)
 class Settings:
  """
  This class describes settings.
@@ -59,6 +59,12 @@ class SettingsLoader:
  This class describes a settings loader.
  """
 
+ __slots__ = (
+ 'config',
+ 'config_type',
+ 'filename'
+ )
+
  def __init__(self, config_type: SettingsConfigType, filename: str = None):
  """Initialize a basic settings info
 
@@ -71,9 +77,7 @@ def __init__(self, config_type: SettingsConfigType, filename: str = None):
  """
  self.config = None
  self.config_type: SettingsConfigType = config_type
- self.filename: str = filename
-
- self.filename: str = Path(self.filename)
+ self.filename: Path = Path(self.filename)
 
  if not self.filename.exists():
  raise FileNotFoundError(f'Config file "{self.filename}" don\'t exists.')