Merge pull request #144 from python-ellar/test_coverage_fix

Test coverage fix

Author: eadwinCode

ellar/__init__.py

@@ -1,3 +1,3 @@
 """Ellar - Python ASGI web framework for building fast, efficient, and scalable RESTful APIs and server-side applications."""
 
-__version__ = "0.5.6"
+__version__ = "0.5.7"

ellar/cache/backends/local_cache.py

@@ -5,7 +5,7 @@
 from collections import OrderedDict
 
 from anyio import Lock
-from ellar.common.helper.event_loop import get_or_create_eventloop
+from ellar.common.utils.event_loop import get_or_create_eventloop
 
 from ..interface import IBaseCacheBackendAsync
 from ..make_key_decorator import make_key_decorator, make_key_decorator_and_validate

ellar/cache/backends/redis/backend.py

@@ -2,7 +2,7 @@
 import typing as t
 from abc import ABC
 
-from ellar.common.helper.event_loop import get_or_create_eventloop
+from ellar.common.utils.event_loop import get_or_create_eventloop
 
 try:
     from redis.asyncio import Redis

ellar/cache/make_key_decorator.py

@@ -1,7 +1,7 @@
 import functools
 import typing as t
 
-from ellar.common.helper import is_async_callable
+from ellar.common.utils import is_async_callable
 
 if t.TYPE_CHECKING:  # pragma: no cover
     from .model import BaseCacheBackend

ellar/common/decorators/html.py

@@ -10,11 +10,11 @@
     TEMPLATE_GLOBAL_KEY,
 )
 from ellar.common.exceptions import ImproperConfiguration
-from ellar.common.helper import class_base_function_regex, get_name
 from ellar.common.responses.models import HTMLResponseModel
 from ellar.common.shortcuts import fail_silently
 from ellar.common.templating import TemplateFunctionData
 from ellar.common.types import TemplateFilterCallable, TemplateGlobalCallable
+from ellar.common.utils import class_base_function_regex, get_name
 
 from .base import set_metadata as set_meta
 

ellar/common/exceptions/callable_exceptions.py

@@ -1,7 +1,7 @@
 import typing as t
 
-from ellar.common.helper import is_async_callable
 from ellar.common.interfaces import IExceptionHandler, IHostContext
+from ellar.common.utils import is_async_callable
 from starlette.concurrency import run_in_threadpool
 from starlette.responses import Response
 

ellar/common/interfaces/controller_factory.py

@@ -1,7 +1,7 @@
 import inspect
 import typing as t
 
-from ellar.common.helper.modelfield import create_model_field
+from ellar.common.utils.modelfield import create_model_field
 from pydantic.fields import FieldInfo, ModelField, Required
 from pydantic.schema import get_annotation_from_field_info
 

ellar/common/params/args/factory.py

@@ -1,9 +1,9 @@
 import typing as t
 
 from ellar.common.constants import MULTI_RESOLVER_KEY
-from ellar.common.helper.modelfield import create_model_field
 from ellar.common.interfaces import IExecutionContext
 from ellar.common.logger import logger
+from ellar.common.utils.modelfield import create_model_field
 from pydantic import BaseModel, create_model
 from pydantic.fields import ModelField
 from starlette.convertors import Convertor

ellar/common/params/args/request_model.py

@@ -1,6 +1,3 @@
-import copy
-import re
-import sys
 import typing as t
 from enum import Enum
 
@@ -22,13 +19,6 @@
     WsBodyParameterResolver,
 )
 
-if sys.version_info >= (3, 6):
-
-    def copier(x: t.Any, memo: t.Dict) -> t.Any:
-        return x
-
-    copy._deepcopy_dispatch[type(re.compile(""))] = copier  # type: ignore
-
 
 class ParamTypes(Enum):
     query = "query"

ellar/common/params/params.py

@@ -3,10 +3,10 @@
 
 from ellar.common.constants import SERIALIZER_FILTER_KEY
 from ellar.common.exceptions import RequestValidationError
-from ellar.common.helper.modelfield import create_model_field
 from ellar.common.interfaces import IExecutionContext, IResponseModel
 from ellar.common.logger import request_logger
 from ellar.common.serializer import SerializerFilter, serialize_object
+from ellar.common.utils.modelfield import create_model_field
 from ellar.reflect import reflect
 from pydantic import BaseModel
 from pydantic.fields import ModelField

ellar/common/responses/models/base.py

@@ -1,10 +1,10 @@
 import typing as t
 
 from ellar.common.constants import SERIALIZER_FILTER_KEY
-from ellar.common.helper.modelfield import create_model_field
 from ellar.common.interfaces import IExecutionContext
 from ellar.common.logger import request_logger
 from ellar.common.serializer import SerializerFilter, serialize_object
+from ellar.common.utils.modelfield import create_model_field
 from ellar.reflect import reflect
 
 from ..response_types import JSONResponse, Response

ellar/common/responses/models/json.py

@@ -2,10 +2,10 @@
 import uuid
 
 from ellar.common.constants import CONTROLLER_CLASS_KEY, GUARDS_KEY, VERSIONING_KEY
-from ellar.common.helper import get_unique_control_type
 from ellar.common.logger import request_logger
 from ellar.common.models import GuardCanActivate
 from ellar.common.types import TReceive, TScope, TSend
+from ellar.common.utils import get_unique_control_type
 from ellar.reflect import reflect
 from starlette.routing import BaseRoute, Match, Route, Router
 from starlette.routing import Mount as StarletteMount

ellar/common/routing/mount.py

@@ -8,11 +8,11 @@
     RESPONSE_OVERRIDE_KEY,
 )
 from ellar.common.exceptions import ImproperConfiguration, RequestValidationError
-from ellar.common.helper import generate_operation_unique_id, get_name
 from ellar.common.interfaces import IExecutionContext
 from ellar.common.logger import request_logger
 from ellar.common.params import ExtraEndpointArg, RequestEndpointArgsModel
 from ellar.common.responses.models import RouteResponseModel
+from ellar.common.utils import generate_operation_unique_id, get_name
 from ellar.reflect import reflect
 from starlette.concurrency import run_in_threadpool
 from starlette.responses import Response

ellar/common/routing/route.py

@@ -2,8 +2,8 @@
 import uuid
 from collections import OrderedDict
 
-from ellar.common.helper import generate_controller_operation_unique_id
 from ellar.common.logger import logger
+from ellar.common.utils import generate_controller_operation_unique_id
 from starlette.routing import BaseRoute, Host, Mount
 
 

ellar/common/routing/route_collections.py

@@ -9,10 +9,10 @@
     ImproperConfiguration,
     WebSocketRequestValidationError,
 )
-from ellar.common.helper import get_name
 from ellar.common.interfaces import IExecutionContext
 from ellar.common.logger import request_logger
 from ellar.common.params import ExtraEndpointArg, WebsocketEndpointArgsModel
+from ellar.common.utils import get_name
 from ellar.reflect import reflect
 from starlette.routing import WebSocketRoute as StarletteWebSocketRoute
 from starlette.routing import compile_path

ellar/common/routing/websocket/route.py

@@ -0,0 +1,25 @@
+import math
+import secrets
+
+RANDOM_STRING_CHARS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
+
+
+def must_update_salt(salt: str, expected_entropy: int) -> bool:
+    # Each character in the salt provides log_2(len(alphabet)) bits of entropy.
+    return len(salt) * math.log2(len(RANDOM_STRING_CHARS)) < expected_entropy
+
+
+def get_random_string(length: int, allowed_chars: str = RANDOM_STRING_CHARS) -> str:
+    """
+    Return a securely generated random string.
+
+    The bit length of the returned value can be calculated with the formula:
+        log_2(len(allowed_chars)^length)
+
+    For example, with default `allowed_chars` (26+26+10), this gives:
+      * length: 12, bit length =~ 71 bits
+      * length: 22, bit length =~ 131 bits
+    """
+    return "".join(
+        secrets.choice(allowed_chars) for _ in range(length)
+    )  # pragma no cover

ellar/common/helper/__init__.py renamed to ellar/common/utils/__init__.py

@@ -2,8 +2,8 @@
 
 from ellar.common.compatible.dict import AttributeDictAccessMixin
 from ellar.common.constants import ELLAR_CONFIG_MODULE
-from ellar.common.helper.importer import import_from_string
 from ellar.common.types import VT
+from ellar.common.utils.importer import import_from_string
 from starlette.config import environ
 
 from .app_settings_models import ConfigValidationSchema

ellar/common/utils/crypto.py

@@ -1,8 +1,8 @@
 import typing as t
 
-from ellar.common.helper import build_init_kwargs
 from ellar.common.interfaces import IEllarMiddleware
 from ellar.common.types import ASGIApp
+from ellar.common.utils import build_init_kwargs
 from ellar.di import EllarInjector, injectable
 from starlette.middleware import Middleware
 

ellar/common/helper/enums.py renamed to ellar/common/utils/enums.py

@@ -10,10 +10,10 @@
     TEMPLATE_FILTER_KEY,
     TEMPLATE_GLOBAL_KEY,
 )
-from ellar.common.helper import build_init_kwargs
 from ellar.common.models import ControllerBase
 from ellar.common.routing import ModuleMount
 from ellar.common.templating import ModuleTemplating
+from ellar.common.utils import build_init_kwargs
 from ellar.di import (
     MODULE_REF_TYPES,
     Container,

ellar/common/helper/event_loop.py renamed to ellar/common/utils/event_loop.py

@@ -6,14 +6,14 @@
     CONTROLLER_OPERATION_HANDLER_KEY,
     ROUTE_OPERATION_PARAMETERS,
 )
-from ellar.common.helper import get_unique_control_type
 from ellar.common.logger import logger
 from ellar.common.routing import (
     RouteOperation,
     RouteOperationBase,
     WebsocketRouteOperation,
 )
 from ellar.common.routing.schema import RouteParameters, WsRouteParameters
+from ellar.common.utils import get_unique_control_type
 from ellar.reflect import reflect
 
 

ellar/common/helper/importer.py renamed to ellar/common/utils/importer.py

@@ -1,7 +1,9 @@
 import typing as t
 
+from ellar.common.utils.crypto import get_random_string
+
 from .argon2 import Argon2Hasher
-from .base import BaseHasher, EncodingType, get_random_string, must_update_salt
+from .base import BaseHasher, EncodingType
 from .bcrypt import BCryptHasher, BCryptSHA256Hasher
 from .md5 import MD5Hasher
 from .pbkdf import PBKDF2Hasher, PBKDF2SHA1Hasher
@@ -125,7 +127,6 @@ def check_password(
     "BCryptHasher",
     "ScryptHasher",
     "MD5Hasher",
-    "must_update_salt",
     "make_password",
     "check_password",
     "is_password_usable",

ellar/common/helper/modelfield.py renamed to ellar/common/utils/modelfield.py

@@ -1,8 +1,9 @@
 import typing as t
 
+from ellar.common.utils.crypto import must_update_salt
 from passlib.hash import argon2
 
-from .base import BaseHasher, EncodingSalt, EncodingType, must_update_salt
+from .base import BaseHasher, EncodingSalt, EncodingType
 
 
 class Argon2Hasher(BaseHasher):

ellar/common/helper/module_loading.py renamed to ellar/common/utils/module_loading.py

@@ -1,44 +1,21 @@
 import math
-import secrets
 import typing as t
 from abc import ABC, abstractmethod
 
 import passlib.utils.handlers as uh
+from ellar.common.utils.crypto import RANDOM_STRING_CHARS, get_random_string
 
 # This will never be a valid encoded hash
 UNUSABLE_PASSWORD_PREFIX = "!"
 UNUSABLE_PASSWORD_SUFFIX_LENGTH = (
     40  # number of random chars to add after UNUSABLE_PASSWORD_PREFIX
 )
 
-RANDOM_STRING_CHARS = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
-
 __HASHERS_DICT: t.Dict[str, t.Type["BaseHasher"]] = {}
 EncodingType = t.Union[str, bytes]
 EncodingSalt = t.Optional[t.Union[str, bytes]]
 
 
-def must_update_salt(salt: str, expected_entropy: int) -> bool:
-    # Each character in the salt provides log_2(len(alphabet)) bits of entropy.
-    return len(salt) * math.log2(len(RANDOM_STRING_CHARS)) < expected_entropy
-
-
-def get_random_string(length: int, allowed_chars: str = RANDOM_STRING_CHARS) -> str:
-    """
-    Return a securely generated random string.
-
-    The bit length of the returned value can be calculated with the formula:
-        log_2(len(allowed_chars)^length)
-
-    For example, with default `allowed_chars` (26+26+10), this gives:
-      * length: 12, bit length =~ 71 bits
-      * length: 22, bit length =~ 131 bits
-    """
-    return "".join(
-        secrets.choice(allowed_chars) for _ in range(length)
-    )  # pragma no cover
-
-
 class BaseHasher(ABC):
     hasher: t.Union[t.Type[uh.GenericHandler], t.Any]
     algorithm: str

ellar/core/conf/config.py

@@ -1,8 +1,9 @@
 import typing as t
 
+from ellar.common.utils.crypto import must_update_salt
 from passlib.hash import md5_crypt
 
-from .base import BaseHasher, EncodingSalt, EncodingType, must_update_salt
+from .base import BaseHasher, EncodingSalt, EncodingType
 
 
 class MD5Hasher(BaseHasher):

ellar/core/middleware/middleware.py

@@ -1,6 +1,7 @@
+from ellar.common.utils.crypto import must_update_salt
 from passlib.hash import django_pbkdf2_sha1, django_pbkdf2_sha256
 
-from .base import BaseHasher, must_update_salt
+from .base import BaseHasher
 
 
 class PBKDF2Hasher(BaseHasher):

ellar/core/modules/ref.py

@@ -4,9 +4,9 @@
 from ellar.common import IIdentitySchemes
 from ellar.common.compatible import AttributeDict, cached_property
 from ellar.common.constants import GUARDS_KEY, REF_PREFIX
-from ellar.common.helper.modelfield import create_model_field
 from ellar.common.routing import ModuleMount, RouteOperation
 from ellar.common.routing.controller import ControllerRouteOperation
+from ellar.common.utils.modelfield import create_model_field
 from ellar.openapi.constants import OPENAPI_OPERATION_KEY, OPENAPI_TAG
 from pydantic import AnyUrl, BaseModel, EmailStr
 from pydantic.fields import ModelField

ellar/core/routing/helper.py

@@ -5,7 +5,7 @@
 from ellar.common.compatible import AttributeDict
 from ellar.common.constants import CONTROLLER_CLASS_KEY
 from ellar.common.exceptions import ImproperConfiguration
-from ellar.common.helper import get_name
+from ellar.common.utils import get_name
 from ellar.di import RequestScope, injectable
 from ellar.reflect import REFLECT_TYPE, reflect
 from ellar.socket_io.constants import (

ellar/core/security/constants.py

@@ -1,6 +1,6 @@
 import typing as t
 
-from ellar.common.helper import get_name
+from ellar.common.utils import get_name
 from ellar.reflect import reflect
 from ellar.socket_io.constants import MESSAGE_MAPPING_METADATA, MESSAGE_METADATA
 

ellar/core/security/hashers/__init__.py

@@ -15,8 +15,8 @@
     SCOPE_SERVICE_PROVIDER,
 )
 from ellar.common.exceptions import WebSocketRequestValidationError
-from ellar.common.helper import get_name
 from ellar.common.params import WebsocketEndpointArgsModel
+from ellar.common.utils import get_name
 from ellar.core import Config
 from ellar.di import EllarInjector
 from ellar.reflect import reflect

ellar/core/security/hashers/argon2.py

@@ -12,8 +12,8 @@
     template_filter,
     template_global,
 )
-from ellar.common.helper.importer import get_class_import
 from ellar.common.templating import Environment
+from ellar.common.utils.importer import get_class_import
 from ellar.core import Config, ModuleBase
 from ellar.core.connection import Request
 from ellar.core.modules import ModuleTemplateRef