hypern 0.1.0__cp310-cp310-manylinux_2_34_x86_64.whl

hypern/db/sql/repository.py

@@ -0,0 +1,289 @@
+# -*- coding: utf-8 -*-
+from functools import reduce
+from typing import Any, Generic, Optional, Type, TypeVar, Dict
+from sqlalchemy import Select, select, and_, desc, asc, between
+from sqlalchemy.ext.asyncio import (
+    AsyncSession,
+)
+from sqlalchemy.sql import func
+from sqlalchemy.orm import declarative_base
+
+Base = declarative_base()
+
+
+class Model(Base):  # type: ignore
+    __abstract__ = True
+    __table_args__ = {"extend_existing": True}
+
+    @property
+    def as_dict(self) -> Dict[str, Any]:
+        return {c.name: getattr(self, c.name) for c in self.__table__.columns}
+
+
+ModelType = TypeVar("ModelType", bound=Base)  # type: ignore
+
+
+class PostgresRepository(Generic[ModelType]):
+    """Base class for data repositories."""
+
+    def __init__(self, model: Type[ModelType], db_session: AsyncSession):
+        self.session = db_session  # type: ignore
+        self.model_class: Type[ModelType] = model
+
+    async def create(self, attributes: Optional[dict[str, Any]] = None) -> ModelType:
+        """
+        Creates the model instance.
+
+        :param attributes: The attributes to create the model with.
+        :return: The created model instance.
+        """
+        if attributes is None:
+            attributes = {}
+        model = self.model_class(**attributes)  # type: ignore
+        self.session.add(model)
+        return model
+
+    async def get_all(
+        self,
+        skip: int = 0,
+        limit: int = 100,
+        join_: set[str] | None = None,
+        where: Optional[dict] = None,
+        order_by: tuple[str, str] | None = None,
+    ) -> list[ModelType]:
+        """
+        Returns a list of model instances.
+
+        :param skip: The number of records to skip.
+        :param limit: The number of record to return.
+        :param join_: The joins to make.
+        :param where: The conditions for the WHERE clause.
+        :return: A list of model instances.
+        """
+        query = self._query(join_)
+        query = query.offset(skip).limit(limit)
+
+        if where is not None:
+            conditions = []
+            for k, v in where.items():
+                if isinstance(v, dict) and "$gt" in v and "$lt" in v:
+                    conditions.append(between(getattr(self.model_class, k), v["$gt"], v["$lt"]))
+                else:
+                    conditions.append(getattr(self.model_class, k) == v)
+            query = query.where(and_(*conditions))
+
+        if order_by is not None:
+            column, direction = order_by
+            if direction.lower() == "desc":
+                query = query.order_by(desc(getattr(self.model_class, column)))
+            else:
+                query = query.order_by(asc(getattr(self.model_class, column)))
+
+        if join_ is not None:
+            return await self.all_unique(query)
+        return await self._all(query)
+
+    async def get_by(
+        self,
+        field: str,
+        value: Any,
+        join_: set[str] | None = None,
+        unique: bool = False,
+    ) -> ModelType | list[ModelType] | None:
+        """
+        Returns the model instance matching the field and value.
+
+        :param field: The field to match.
+        :param value: The value to match.
+        :param join_: The joins to make.
+        :return: The model instance.
+        """
+        query = self._query(join_)
+        query = await self._get_by(query, field, value)
+
+        if join_ is not None:
+            return await self.all_unique(query)
+        if unique:
+            return await self._one(query)
+
+        return await self._all(query)
+
+    async def delete(self, model: ModelType) -> None:
+        """
+        Deletes the model.
+
+        :param model: The model to delete.
+        :return: None
+        """
+        await self.session.delete(model)
+
+    async def update(self, model: ModelType, attributes: dict[str, Any]) -> ModelType:
+        """
+        Updates the model.
+
+        :param model: The model to update.
+        :param attributes: The attributes to update the model with.
+        :return: The updated model instance.
+        """
+        for key, value in attributes.items():
+            if hasattr(model, key):
+                setattr(model, key, value)
+
+        self.session.add(model)
+        await self.session.commit()
+
+        return model
+
+    def _query(
+        self,
+        join_: set[str] | None = None,
+        order_: dict | None = None,
+    ) -> Select:
+        """
+        Returns a callable that can be used to query the model.
+
+        :param join_: The joins to make.
+        :param order_: The order of the results. (e.g desc, asc)
+        :return: A callable that can be used to query the model.
+        """
+        query = select(self.model_class)
+        query = self._maybe_join(query, join_)
+        query = self._maybe_ordered(query, order_)
+
+        return query
+
+    async def _all(self, query: Select) -> list[ModelType]:
+        """
+        Returns all results from the query.
+
+        :param query: The query to execute.
+        :return: A list of model instances.
+        """
+        query = await self.session.scalars(query)
+        return query.all()
+
+    async def all_unique(self, query: Select) -> list[ModelType]:
+        result = await self.session.execute(query)
+        return result.unique().scalars().all()
+
+    async def _first(self, query: Select) -> ModelType | None:
+        """
+        Returns the first result from the query.
+
+        :param query: The query to execute.
+        :return: The first model instance.
+        """
+        query = await self.session.scalars(query)
+        return query.first()
+
+    async def _one_or_none(self, query: Select) -> ModelType | None:
+        """Returns the first result from the query or None."""
+        query = await self.session.scalars(query)
+        return query.one_or_none()
+
+    async def _one(self, query: Select) -> ModelType:
+        """
+        Returns the first result from the query or raises NoResultFound.
+
+        :param query: The query to execute.
+        :return: The first model instance.
+        """
+        query = await self.session.scalars(query)
+        return query.one()
+
+    async def _count(self, query: Select) -> int:
+        """
+        Returns the count of the records.
+
+        :param query: The query to execute.
+        """
+        query = query.subquery()
+        query = await self.session.scalars(select(func.count()).select_from(query))
+        return query.one()
+
+    async def _sort_by(
+        self,
+        query: Select,
+        sort_by: str,
+        order: str | None = "asc",
+        model: Type[ModelType] | None = None,
+        case_insensitive: bool = False,
+    ) -> Select:
+        """
+        Returns the query sorted by the given column.
+
+        :param query: The query to sort.
+        :param sort_by: The column to sort by.
+        :param order: The order to sort by.
+        :param model: The model to sort.
+        :param case_insensitive: Whether to sort case insensitively.
+        :return: The sorted query.
+        """
+        model = model or self.model_class
+
+        order_column = None
+
+        if case_insensitive:
+            order_column = func.lower(getattr(model, sort_by))
+        else:
+            order_column = getattr(model, sort_by)
+
+        if order == "desc":
+            return query.order_by(order_column.desc())
+
+        return query.order_by(order_column.asc())
+
+    async def _get_by(self, query: Select, field: str, value: Any) -> Select:
+        """
+        Returns the query filtered by the given column.
+
+        :param query: The query to filter.
+        :param field: The column to filter by.
+        :param value: The value to filter by.
+        :return: The filtered query.
+        """
+        return query.where(getattr(self.model_class, field) == value)
+
+    def _maybe_join(self, query: Select, join_: set[str] | None = None) -> Select:
+        """
+        Returns the query with the given joins.
+
+        :param query: The query to join.
+        :param join_: The joins to make.
+        :return: The query with the given joins.
+        """
+        if not join_:
+            return query
+
+        if not isinstance(join_, set):
+            raise TypeError("join_ must be a set")
+
+        return reduce(self._add_join_to_query, join_, query)  # type: ignore
+
+    def _maybe_ordered(self, query: Select, order_: dict | None = None) -> Select:
+        """
+        Returns the query ordered by the given column.
+
+        :param query: The query to order.
+        :param order_: The order to make.
+        :return: The query ordered by the given column.
+        """
+        if order_:
+            if order_["asc"]:
+                for order in order_["asc"]:
+                    query = query.order_by(getattr(self.model_class, order).asc())
+            else:
+                for order in order_["desc"]:
+                    query = query.order_by(getattr(self.model_class, order).desc())
+
+        return query
+
+    def _add_join_to_query(self, query: Select, join_: str) -> Select:
+        """
+        Returns the query with the given join.
+
+        :param query: The query to join.
+        :param join_: The join to make.
+        :return: The query with the given join.
+        """
+        return getattr(self, "_join_" + join_)(query)

hypern/enum.py

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+from enum import Enum
+
+
+class ErrorCode(Enum):
+    UNKNOWN_ERROR = "UNKNOWN_ERROR"
+    BAD_REQUEST = "BAD_REQUEST"
+    FORBIDDEN = "FORBIDDEN"
+    SERVER_ERROR = "SERVER_ERROR"
+    NOT_FOUND = "NOT_FOUND"
+    METHOD_NOT_ALLOW = "METHOD_NOT_ALLOW"
+    UNAUTHORIZED = "UNAUTHORIZED"
+    VALIDATION_ERROR = "VALIDATION_ERROR"

hypern/exceptions.py

@@ -0,0 +1,93 @@
+# -*- coding: utf-8 -*-
+from typing import Any
+from hypern.enum import ErrorCode
+
+
+class BaseException(Exception):
+    def __init__(self, msg: str = "", *args: Any) -> None:
+        super().__init__(*args)
+        self.msg = msg
+        self.status = 400
+        self.error_code = ErrorCode.UNKNOWN_ERROR
+
+
+class BadRequest(BaseException):
+    def __init__(
+        self,
+        msg: str = "Bad request",
+        error_code: str = ErrorCode.BAD_REQUEST,
+        *args: Any,
+    ) -> None:
+        super().__init__(msg, *args)
+        self.error_code = error_code
+
+
+class ValidationError(BaseException):
+    def __init__(
+        self,
+        msg: str = "Validation error",
+        error_code: str = ErrorCode.VALIDATION_ERROR,
+        *args: Any,
+    ) -> None:
+        super().__init__(msg, *args)
+        self.error_code = error_code
+
+
+class Forbidden(BaseException):
+    def __init__(
+        self,
+        msg: str = "Forbidden",
+        error_code: str = ErrorCode.FORBIDDEN,
+        *args: Any,
+    ) -> None:
+        super().__init__(msg, *args)
+        self.status = 403
+        self.error_code = error_code
+
+
+class NotFound(BaseException):
+    def __init__(
+        self,
+        msg: str = "NotFound",
+        error_code: str = ErrorCode.NOT_FOUND,
+        *args: Any,
+    ) -> None:
+        super().__init__(msg, *args)
+        self.status = 404
+        self.error_code = error_code
+
+
+class MethodNotAllow(BaseException):
+    def __init__(
+        self,
+        msg: str = "Method not allow",
+        error_code: str = ErrorCode.METHOD_NOT_ALLOW,
+        *args: Any,
+    ) -> None:
+        super().__init__(msg, *args)
+        self.status = 405
+        self.error_code = error_code
+
+
+class InternalServer(BaseException):
+    def __init__(
+        self,
+        msg: str = "Internal server error",
+        error_code: str = ErrorCode.SERVER_ERROR,
+        *args: Any,
+    ) -> None:
+        super().__init__(msg, *args)
+        self.status = 500
+        self.error_code = error_code
+
+
+class Unauthorized(BaseException):
+    def __init__(
+        self,
+        msg: str = "Unauthorized",
+        error_code: str = ErrorCode.UNAUTHORIZED,
+        *args: Any,
+    ) -> None:
+        super().__init__(msg, *args)
+        self.status = 401
+        self.error_code = error_code

hypern/hypern.pyi

@@ -0,0 +1,172 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Callable, Any, List, Tuple, Dict
+
+@dataclass
+class BaseBackend:
+    get: Callable[[str], Any]
+    set: Callable[[Any, str, int], None]
+    delete_startswith: Callable[[str], None]
+
+@dataclass
+class RedisBackend(BaseBackend):
+    url: str
+
+    get: Callable[[str], Any]
+    set: Callable[[Any, str, int], None]
+    delete_startswith: Callable[[str], None]
+
+@dataclass
+class BaseSchemaGenerator:
+    remove_converter: Callable[[str], str]
+    parse_docstring: Callable[[Callable[..., Any]], str]
+
+@dataclass
+class SwaggerUI:
+    title: str
+    openapi_url: str
+
+    render_template: Callable[..., Any]
+    get_html_content: Callable[..., str]
+
+@dataclass
+class BackgroundTask:
+    """
+    A task to be executed in the background
+    id: str: The task ID
+    function: Callable[..., Any]: The function to be executed
+    args: List | Tuple: The arguments to be passed to the function
+    kwargs: Dict[str, Any]: The keyword arguments to be passed to the function
+    timeout_secs: int: The maximum time in seconds the task is allowed to run
+    cancelled: bool: Whether the task is cancelled
+
+    **Note**: function is currently running with sync mode, so it should be a sync function
+    """
+
+    id: str
+    function: Callable[..., Any]
+    args: List | Tuple
+    kwargs: Dict[str, Any]
+    timeout_secs: int
+    cancelled: bool
+
+    def get_id(self) -> str:
+        """
+        Get the task ID
+        """
+        pass
+
+    def cancel(self) -> None:
+        """
+        Cancel the task
+        """
+        pass
+
+    def is_cancelled(self) -> bool:
+        """
+        Check if the task is cancelled
+        """
+        pass
+
+    def execute(self) -> Any:
+        """
+        Execute the task
+        """
+        pass
+
+@dataclass
+class BackgroundTasks:
+    """
+    A collection of tasks to be executed in the background
+
+    **Note**: Only set tasks. pool, sender, receiver are set by the framework
+    """
+
+    def add_task(self, task: BackgroundTask) -> str:
+        """
+        Add a task to the collection
+        """
+        pass
+
+    def cancel_task(self, task_id: str) -> bool:
+        """
+        Cancel a task in the collection
+        """
+        pass
+
+    def execute_all(self) -> None:
+        """
+        Execute all tasks in the collection
+        """
+        pass
+
+    def execute_task(self, task_id: str) -> None:
+        """
+        Execute a task in the collection
+        """
+        pass
+
+class Scheduler:
+    def add_job(
+        self,
+        job_type: str,
+        schedule_param: str,
+        task: Callable[..., Any],
+        timezone: str,
+        dependencies: List[str],
+        retry_policy: Tuple[int, int, bool] | None = None,
+    ) -> str:
+        """
+        Add a job to the scheduler
+        params:
+        job_type: str: The type of the job (e.g. "cron", "interval")
+
+        schedule_param: str: The schedule parameter of the job. interval in seconds for interval jobs, cron expression for cron jobs
+
+        Exmaple:
+        //           sec  min   hour   day of month   month   day of week   year
+        expression = "0   30   9,12,15     1,15       May-Aug  Mon,Wed,Fri  2018/2";
+
+        task: Callable[..., Any]: The task to be executed
+
+        timezone: str: The timezone of the job
+
+        dependencies: List[str]: The IDs of the jobs this job depends on
+
+        retry_policy: Tuple[int, int, bool] | None: The retry policy of the job. (max_retries, retry_delay_secs, exponential_backoff)
+
+        return:
+        str: The ID of the job
+        """
+        pass
+
+    def remove_job(self, job_id: str) -> None:
+        """
+        Remove a job from the scheduler
+        """
+        pass
+
+    def start(self) -> None:
+        """
+        Start the scheduler
+        """
+        pass
+
+    def stop(self) -> None:
+        """
+        Stop the scheduler
+        """
+        pass
+
+    def get_job_status(self, job_id: str) -> Tuple[float, float, List[str], int]:
+        """
+        Get the status of a job
+        """
+        pass
+
+    def get_next_run(self, job_id: str) -> float:
+        """
+        Get the next run time of a job
+        """
+        pass

hypern/logging/__init__.py

@@ -0,0 +1,3 @@
+from .logger import logger, reset_logger
+
+__all__ = ["logger", "reset_logger"]

hypern/logging/logger.py

@@ -0,0 +1,91 @@
+# -*- coding: utf-8 -*-
+import logging
+from typing import Optional, Literal
+from copy import copy
+import click
+import sys
+
+TRACE_LOG_LEVEL = 5
+
+
+class ColourizedFormatter(logging.Formatter):
+    level_name_colors = {
+        TRACE_LOG_LEVEL: lambda level_name: click.style(str(level_name), fg="blue"),
+        logging.DEBUG: lambda level_name: click.style(str(level_name), fg="cyan"),
+        logging.INFO: lambda level_name: click.style(str(level_name), fg="green"),
+        logging.WARNING: lambda level_name: click.style(str(level_name), fg="yellow"),
+        logging.ERROR: lambda level_name: click.style(str(level_name), fg="red"),
+        logging.CRITICAL: lambda level_name: click.style(str(level_name), fg="bright_red"),
+    }
+
+    def __init__(
+        self,
+        fmt: Optional[str] = None,
+        datefmt: Optional[str] = None,
+        style: Literal["%", "{", "$"] = "%",
+        use_colors: Optional[bool] = None,
+    ):
+        if use_colors in (True, False):
+            self.use_colors = use_colors
+        else:
+            self.use_colors = sys.stdout.isatty()
+        super().__init__(fmt=fmt, datefmt=datefmt, style=style)
+
+    def color_level_name(self, level_name: str, level_no: int) -> str:
+        def default(level_name: str) -> str:
+            return str(level_name)
+
+        func = self.level_name_colors.get(level_no, default)
+        return func(level_name)
+
+    def should_use_colors(self) -> bool:
+        return True
+
+    def formatMessage(self, record: logging.LogRecord) -> str:
+        recordcopy = copy(record)
+        levelname = recordcopy.levelname
+        process = recordcopy.process
+        separator = " " * (8 - len(recordcopy.levelname))
+        if self.use_colors:
+            levelname = self.color_level_name(levelname, recordcopy.levelno)
+            if "color_message" in recordcopy.__dict__:
+                recordcopy.msg = recordcopy.__dict__["color_message"]
+                recordcopy.__dict__["message"] = recordcopy.getMessage()
+        recordcopy.__dict__["levelprefix"] = levelname + ":" + separator
+        recordcopy.__dict__["process"] = click.style(str(process), fg="blue")
+        return super().formatMessage(recordcopy)
+
+
+class DefaultFormatter(ColourizedFormatter):
+    def should_use_colors(self) -> bool:
+        return sys.stderr.isatty()
+
+
+def create_logger(name) -> logging.Logger:
+    logger = logging.getLogger(name)
+    logger.setLevel(logging.DEBUG)
+    formatter = DefaultFormatter(
+        fmt="%(levelprefix)s %(asctime)s [%(process)s] [%(filename)s:%(lineno)d] %(message)s",
+        use_colors=True,
+        datefmt="%d-%m-%Y %H:%M:%S",
+    )
+    handler = logging.StreamHandler()
+    handler.setFormatter(formatter)
+    logger.addHandler(handler)
+    return logger
+
+
+def get_loggers_by_prefix(prefix):
+    return [name for name in logging.root.manager.loggerDict.keys() if name.startswith(prefix)]
+
+
+def reset_logger() -> None:
+    robyn_loggers = get_loggers_by_prefix("robyn")
+    actix_loggers = ["actix_server.builder", "actix_server.worker", "actix_server.server", "actix_server.accept"]
+
+    for name in [*robyn_loggers, *actix_loggers]:
+        logger = create_logger(name)
+        logger.propagate = False
+
+
+logger = create_logger("hypern")

hypern/middleware/__init__.py

@@ -0,0 +1,5 @@
+from .base import Middleware
+from .cors import CORSMiddleware
+from .limit import RateLimitMiddleware, StorageBackend, RedisBackend, InMemoryBackend
+
+__all__ = ["Middleware", "CORSMiddleware", "RateLimitMiddleware", "StorageBackend", "RedisBackend", "InMemoryBackend"]

hypern/middleware/base.py

@@ -0,0 +1,16 @@
+from abc import ABC, abstractmethod
+from robyn import Response, Request
+
+
+class Middleware(ABC):
+    def __init__(self) -> None:
+        super().__init__()
+        self.app = None
+
+    @abstractmethod
+    def before_request(self, request: Request):
+        pass
+
+    @abstractmethod
+    def after_request(self, response: Response):
+        pass