richapi 0.2.0__tar.gz → 0.2.1__tar.gz

{richapi-0.2.0 → richapi-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: richapi
-Version: 0.2.0
+Version: 0.2.1
 Summary: Find HTTPExceptions and turn them into documented responses!
 Project-URL: repository, https://github.com/ManiMozaffar/richapi
 Project-URL: Homepage, https://github.com/ManiMozaffar/richapi

{richapi-0.2.0 → richapi-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "richapi"
-version = "0.2.0"
+version = "0.2.1"
 description = "Find HTTPExceptions and turn them into documented responses!"
 readme = "README.md"
 requires-python = ">=3.9"

richapi-0.2.1/richapi/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.2.1"

{richapi-0.2.0 → richapi-0.2.1}/richapi/exc_parser/compiler.py

@@ -95,14 +95,10 @@ def _find_all_class_exceptions(
     try:
         tree = tree or ast.parse(inspect.getsource(cls))
     except Exception as error:
-        logger.exception(
-            f"Failed to parse source code for {cls.__name__}.", exc_info=error
-        )
+        logger.exception(f"Failed to parse source code for {cls.__name__}.", exc_info=error)
         return []
 
-    result = _find_explicit_expection_recursively(
-        cls.__init__, to_filter_predicate, tree
-    )
+    result = _find_explicit_expection_recursively(cls.__init__, to_filter_predicate, tree)
     if hasattr(cls, "__call__"):
         # Not sure if __call__ was called or init, so check for both
 
@@ -120,9 +116,7 @@ def _find_all_class_exceptions(
 
 def is_absolutely_callable_object(obj: Callable) -> bool:
     return (
-        inspect.isclass(type(obj))
-        and not inspect.isfunction(obj)
-        and not inspect.ismethod(obj)
+        inspect.isclass(type(obj)) and (not inspect.isfunction(obj)) and (not inspect.ismethod(obj))
     )
 
 
@@ -142,6 +136,12 @@ def _find_explicit_expection_recursively(
         return []
 
     if is_absolutely_callable_object(func_obj):
+        cls_module = inspect.getmodule(type(func_obj))
+        if cls_module and is_stdlib(cls_module.__name__):
+            return []
+        if cls_module and to_filter_predicate(cls_module.__name__) is False:
+            return []
+
         return _find_all_class_exceptions(type(func_obj), to_filter_predicate, tree)
 
     ExceptionFinder.visited.add(func_obj)
@@ -169,9 +169,7 @@ def _find_explicit_expection_recursively(
     try:
         finder.visit(tree)
     except Exception as error:
-        logger.exception(
-            f"Failed to analyze function {get_func_name(func_obj)}.", exc_info=error
-        )
+        logger.exception(f"Failed to analyze function {get_func_name(func_obj)}.", exc_info=error)
 
     return finder.exceptions
 
@@ -249,9 +247,7 @@ def _resolve_function_from_call_node(
     elif isinstance(node, ast.Attribute):
         attr_chain = _resolve_full_attribute_path(node)
         if attr_chain is None:
-            logger.debug(
-                f"Failed to get full attribute name: {ast.dump(node)} in {func.__name__}"
-            )
+            logger.debug(f"Failed to get full attribute name: {ast.dump(node)} in {func.__name__}")
             return None
 
         try:
@@ -271,9 +267,7 @@ def _resolve_function_from_call_node(
                 parent_attr = assignments.get(node_id, None)
 
             if parent_attr is None:
-                if (
-                    parent_part == "self"
-                ):  # don't need to log -> we already know this is class
+                if parent_part == "self":  # don't need to log -> we already know this is class
                     return None
 
                 logger.debug(
@@ -301,9 +295,7 @@ def _extract_node_name(
     Extract the exception name a node recursively.
     """
     if isinstance(node, ast.Call):
-        return _extract_node_name(
-            typing.cast(SupportedAstNodes, node.func), assignments
-        )
+        return _extract_node_name(typing.cast(SupportedAstNodes, node.func), assignments)
     elif isinstance(node, ast.Name):
         var_name = get_node_identifier(node)
         return assignments.get(var_name, var_name)
@@ -311,9 +303,7 @@ def _extract_node_name(
         return _resolve_full_attribute_path(node)
 
     elif isinstance(node, ast.Await):
-        return _extract_node_name(
-            typing.cast(SupportedAstNodes, node.value), assignments
-        )
+        return _extract_node_name(typing.cast(SupportedAstNodes, node.value), assignments)
 
     elif isinstance(
         node,
@@ -361,9 +351,7 @@ def is_stdlib(module_name: str) -> bool:
 class ExceptionFinder(ast.NodeVisitor):
     visited: set[Callable] = set()
 
-    def __init__(
-        self, func: Callable, should_search_module_pred: Callable[[str], bool]
-    ):
+    def __init__(self, func: Callable, should_search_module_pred: Callable[[str], bool]):
         self.exceptions: list[tuple[Optional[type[Exception]], ast.Raise]] = []
         self.assignments: dict[NodeIdentifier, str] = {}
         self.func = func
@@ -493,10 +481,7 @@ class ExceptionFinder(ast.NodeVisitor):
 
             founded_func_ast = _find_in_module(
                 tree,
-                lambda n: (
-                    isinstance(n, ast.AsyncFunctionDef)
-                    or isinstance(n, ast.FunctionDef)
-                )
+                lambda n: (isinstance(n, ast.AsyncFunctionDef) or isinstance(n, ast.FunctionDef))
                 and n.name == func_obj.__name__,
             )
             if founded_func_ast:
@@ -524,9 +509,7 @@ class ExceptionFinder(ast.NodeVisitor):
             try:
                 caller_type = _exctact_type(caller_node_name, self.func_globals)
             except Exception:
-                logger.critical(
-                    f"Failed to resolve attribute chain: {caller_node_name}"
-                )
+                logger.critical(f"Failed to resolve attribute chain: {caller_node_name}")
                 self.generic_visit(node)
                 return
 
@@ -557,8 +540,7 @@ class ExceptionFinder(ast.NodeVisitor):
 
             cls_ast = _find_in_module(
                 tree,
-                lambda n: isinstance(n, ast.ClassDef)
-                and n.name == caller_type.__name__,
+                lambda n: isinstance(n, ast.ClassDef) and n.name == caller_type.__name__,
             )
             if cls_ast:
                 casted_cls_ast = typing.cast(ast.ClassDef, cls_ast)

{richapi-0.2.0 → richapi-0.2.1}/richapi/exc_parser/openapi.py

@@ -44,12 +44,15 @@ def enrich_openapi(
 ) -> Callable:
     if target_module is None:
         target_module = _find_module_name_where_app_defined_in(app)
+
         if target_module is None or target_module == "__main__":
             raise BaseRichAPIException(
                 "Could not determine the module where the FastAPI instance was created.\n"
                 "Please provide the module name as a string or list of strings."
             )
 
+        target_module = target_module.split(".")[0]  # get the top-level module
+
     def _custom_openapi() -> dict:
         if app.openapi_schema:  # pragma: no cover
             return app.openapi_schema

{richapi-0.2.0 → richapi-0.2.1}/richapi/exc_parser/protocol.py

@@ -27,21 +27,25 @@ class BaseHTTPException(HTTPException):
     @classmethod
     def get_json_schema(cls) -> HTTPExceptionSchema:
         value = _generic_json_schema_builder(cls)
-        assert (
-            value is not None
-        )  # should never happen because status code is always set
+        assert value is not None  # should never happen because status code is always set
         return value
 
 
 def try_to_camel_case(string: str) -> str:
-    if " " in string:  # with space
+    final_str = string
+    if " " in final_str:  # with space
         components = string.split(" ")
-        return components[0] + "".join(x.title() for x in components[1:])
-    elif "_" in string:  # snake case
+        final_str = components[0] + "".join(x.title() for x in components[1:])
+
+    if "_" in final_str:  # snake case
         components = string.split("_")
-        return components[0] + "".join(x.title() for x in components[1:])
-    else:
-        return string  # not known
+        final_str = components[0] + "".join(x.title() for x in components[1:])
+
+    if "-" in final_str:  # kebab case
+        components = string.split("-")
+        final_str = components[0] + "".join(x.title() for x in components[1:])
+
+    return final_str
 
 
 def _generic_json_schema_builder(

richapi-0.2.0/richapi/__version__.py

@@ -1 +0,0 @@
-__version__ = "0.2.0"