winipedia-utils 0.2.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

winipedia_utils/modules/class_.py

@@ -1,119 +1,119 @@
-"""Class utilities for introspection and manipulation.
-
-This module provides utility functions for working with Python classes,
-including extracting methods from classes and finding classes within modules.
-These utilities are particularly useful for reflection, testing,
-and dynamic code generation.
-"""
-
-import inspect
-from collections.abc import Callable
-from importlib import import_module
-from types import ModuleType
-from typing import Any
-
-from winipedia_utils.modules.function import is_func
-
-
-def get_all_methods_from_cls(
-    class_: type, *, exclude_parent_methods: bool = False
-) -> list[Callable[..., Any]]:
-    """Get all methods from a class.
-
-    Retrieves all methods (functions or methods) from a class. Can optionally
-    exclude methods inherited from parent classes.
-
-    Args:
-        class_: The class to extract methods from
-        exclude_parent_methods: If True, only include methods defined in this class,
-        excluding those inherited from parent classes
-    Returns:
-        A list of callable methods from the class
-
-    """
-    from winipedia_utils.modules.module import get_def_line, get_module_of_obj
-
-    methods = [
-        (method, name) for name, method in inspect.getmembers(class_) if is_func(method)
-    ]
-
-    if exclude_parent_methods:
-        methods = [
-            (method, name)
-            for method, name in methods
-            if get_module_of_obj(method).__name__ == class_.__module__
-            and name in class_.__dict__
-        ]
-
-    only_methods = [method for method, _name in methods]
-    # sort by definition order
-    return sorted(only_methods, key=get_def_line)
-
-
-def get_all_cls_from_module(module: ModuleType | str) -> list[type]:
-    """Get all classes defined in a module.
-
-    Retrieves all class objects that are defined directly in the specified module,
-    excluding imported classes.
-
-    Args:
-        module: The module to extract classes from
-
-    Returns:
-        A list of class types defined in the module
-
-    """
-    from winipedia_utils.modules.module import get_def_line, get_module_of_obj
-
-    if isinstance(module, str):
-        module = import_module(module)
-
-    # necessary for bindings packages like AESGCM from cryptography._rust backend
-    default = ModuleType("default")
-    classes = [
-        obj
-        for _, obj in inspect.getmembers(module, inspect.isclass)
-        if get_module_of_obj(obj, default).__name__ == module.__name__
-    ]
-    # sort by definition order
-    return sorted(classes, key=get_def_line)
-
-
-def get_all_subclasses(cls: type) -> list[type]:
-    """Get all subclasses of a class.
-
-    Retrieves all classes that are subclasses of the specified class.
-    Also returns subclasses of subclasses (recursive).
-
-    Args:
-        cls: The class to find subclasses of
-
-    Returns:
-        A list of subclasses of the given class
-
-    """
-    subclasses_set = set(cls.__subclasses__())
-    for subclass in cls.__subclasses__():
-        subclasses_set.update(get_all_subclasses(subclass))
-    return list(subclasses_set)
-
-
-def get_all_nonabstract_subclasses(cls: type) -> list[type]:
-    """Get all non-abstract subclasses of a class.
-
-    Retrieves all classes that are subclasses of the specified class,
-    excluding abstract classes. Also returns subclasses of subclasses
-    (recursive).
-
-    Args:
-        cls: The class to find subclasses of
-
-    Returns:
-        A list of non-abstract subclasses of the given class
-
-    """
-    return [
-        subclass
-        for subclass in get_all_subclasses(cls)
-        if not inspect.isabstract(subclass)
-    ]
+"""Class utilities for introspection and manipulation.
+
+This module provides utility functions for working with Python classes,
+including extracting methods from classes and finding classes within modules.
+These utilities are particularly useful for reflection, testing,
+and dynamic code generation.
+"""
+
+import inspect
+from collections.abc import Callable
+from importlib import import_module
+from types import ModuleType
+from typing import Any
+
+from winipedia_utils.modules.function import is_func
+
+
+def get_all_methods_from_cls(
+    class_: type, *, exclude_parent_methods: bool = False
+) -> list[Callable[..., Any]]:
+    """Get all methods from a class.
+
+    Retrieves all methods (functions or methods) from a class. Can optionally
+    exclude methods inherited from parent classes.
+
+    Args:
+        class_: The class to extract methods from
+        exclude_parent_methods: If True, only include methods defined in this class,
+        excluding those inherited from parent classes
+    Returns:
+        A list of callable methods from the class
+
+    """
+    from winipedia_utils.modules.module import get_def_line, get_module_of_obj
+
+    methods = [
+        (method, name) for name, method in inspect.getmembers(class_) if is_func(method)
+    ]
+
+    if exclude_parent_methods:
+        methods = [
+            (method, name)
+            for method, name in methods
+            if get_module_of_obj(method).__name__ == class_.__module__
+            and name in class_.__dict__
+        ]
+
+    only_methods = [method for method, _name in methods]
+    # sort by definition order
+    return sorted(only_methods, key=get_def_line)
+
+
+def get_all_cls_from_module(module: ModuleType | str) -> list[type]:
+    """Get all classes defined in a module.
+
+    Retrieves all class objects that are defined directly in the specified module,
+    excluding imported classes.
+
+    Args:
+        module: The module to extract classes from
+
+    Returns:
+        A list of class types defined in the module
+
+    """
+    from winipedia_utils.modules.module import get_def_line, get_module_of_obj
+
+    if isinstance(module, str):
+        module = import_module(module)
+
+    # necessary for bindings packages like AESGCM from cryptography._rust backend
+    default = ModuleType("default")
+    classes = [
+        obj
+        for _, obj in inspect.getmembers(module, inspect.isclass)
+        if get_module_of_obj(obj, default).__name__ == module.__name__
+    ]
+    # sort by definition order
+    return sorted(classes, key=get_def_line)
+
+
+def get_all_subclasses(cls: type) -> list[type]:
+    """Get all subclasses of a class.
+
+    Retrieves all classes that are subclasses of the specified class.
+    Also returns subclasses of subclasses (recursive).
+
+    Args:
+        cls: The class to find subclasses of
+
+    Returns:
+        A list of subclasses of the given class
+
+    """
+    subclasses_set = set(cls.__subclasses__())
+    for subclass in cls.__subclasses__():
+        subclasses_set.update(get_all_subclasses(subclass))
+    return list(subclasses_set)
+
+
+def get_all_nonabstract_subclasses(cls: type) -> list[type]:
+    """Get all non-abstract subclasses of a class.
+
+    Retrieves all classes that are subclasses of the specified class,
+    excluding abstract classes. Also returns subclasses of subclasses
+    (recursive).
+
+    Args:
+        cls: The class to find subclasses of
+
+    Returns:
+        A list of non-abstract subclasses of the given class
+
+    """
+    return [
+        subclass
+        for subclass in get_all_subclasses(cls)
+        if not inspect.isabstract(subclass)
+    ]

winipedia_utils/modules/function.py

@@ -1,101 +1,101 @@
-"""Function utilities for introspection and manipulation.
-
-This module provides utility functions for working with Python functions,
-including extracting functions from modules and manipulating function objects.
-These utilities are particularly useful for reflection, testing, and
-dynamic code generation.
-"""
-
-import inspect
-from collections.abc import Callable
-from importlib import import_module
-from types import ModuleType
-from typing import Any
-
-
-def is_func_or_method(obj: Any) -> bool:
-    """Return True if *obj* is a function or method.
-
-    This function checks if the given object is a function or method,
-    including those defined in a class body.
-
-    Args:
-        obj: The object to check
-
-    Returns:
-        bool: True if the object is a function or method, False otherwise
-
-    """
-    return inspect.isfunction(obj) or inspect.ismethod(obj)
-
-
-def is_func(obj: Any) -> bool:
-    """Return True if *obj* is a 'method-like' attribute as it appears in a class body.
-
-    Accepts:
-
-
-        • plain functions (instance methods)
-        • staticmethod / classmethod descriptors
-        • property descriptors (getter counts as method)
-        • decorated functions that keep a __wrapped__ chain
-
-    Returns:
-        bool: True if the object is a method-like attribute, False otherwise
-
-    """
-    # plain function
-
-    if is_func_or_method(obj):
-        return True
-
-    if isinstance(obj, (staticmethod, classmethod, property)):
-        return True
-
-    unwrapped = inspect.unwrap(obj)
-
-    return is_func_or_method(unwrapped)
-
-
-def get_all_functions_from_module(module: ModuleType | str) -> list[Callable[..., Any]]:
-    """Get all functions defined in a module.
-
-    Retrieves all function objects that are defined directly in the specified module,
-    excluding imported functions.
-    The functions are sorted by their line number in the module.
-
-    Args:
-        module: The module to extract functions from
-
-    Returns:
-        A list of callable functions defined in the module
-
-    """
-    from winipedia_utils.modules.module import get_def_line, get_module_of_obj
-
-    if isinstance(module, str):
-        module = import_module(module)
-    funcs = [
-        func
-        for _name, func in inspect.getmembers(module, is_func)
-        if get_module_of_obj(func).__name__ == module.__name__
-    ]
-    # sort by definition order
-    return sorted(funcs, key=get_def_line)
-
-
-def unwrap_method(method: Any) -> Callable[..., Any] | Any:
-    """Unwrap a method to its underlying function.
-
-    Args:
-        method: The method to unwrap
-
-    Returns:
-        The underlying function of the method
-
-    """
-    if isinstance(method, (staticmethod, classmethod)):
-        method = method.__func__
-    if isinstance(method, property):
-        method = method.fget
-    return inspect.unwrap(method)
+"""Function utilities for introspection and manipulation.
+
+This module provides utility functions for working with Python functions,
+including extracting functions from modules and manipulating function objects.
+These utilities are particularly useful for reflection, testing, and
+dynamic code generation.
+"""
+
+import inspect
+from collections.abc import Callable
+from importlib import import_module
+from types import ModuleType
+from typing import Any
+
+
+def is_func_or_method(obj: Any) -> bool:
+    """Return True if *obj* is a function or method.
+
+    This function checks if the given object is a function or method,
+    including those defined in a class body.
+
+    Args:
+        obj: The object to check
+
+    Returns:
+        bool: True if the object is a function or method, False otherwise
+
+    """
+    return inspect.isfunction(obj) or inspect.ismethod(obj)
+
+
+def is_func(obj: Any) -> bool:
+    """Return True if *obj* is a 'method-like' attribute as it appears in a class body.
+
+    Accepts:
+
+
+        • plain functions (instance methods)
+        • staticmethod / classmethod descriptors
+        • property descriptors (getter counts as method)
+        • decorated functions that keep a __wrapped__ chain
+
+    Returns:
+        bool: True if the object is a method-like attribute, False otherwise
+
+    """
+    # plain function
+
+    if is_func_or_method(obj):
+        return True
+
+    if isinstance(obj, (staticmethod, classmethod, property)):
+        return True
+
+    unwrapped = inspect.unwrap(obj)
+
+    return is_func_or_method(unwrapped)
+
+
+def get_all_functions_from_module(module: ModuleType | str) -> list[Callable[..., Any]]:
+    """Get all functions defined in a module.
+
+    Retrieves all function objects that are defined directly in the specified module,
+    excluding imported functions.
+    The functions are sorted by their line number in the module.
+
+    Args:
+        module: The module to extract functions from
+
+    Returns:
+        A list of callable functions defined in the module
+
+    """
+    from winipedia_utils.modules.module import get_def_line, get_module_of_obj
+
+    if isinstance(module, str):
+        module = import_module(module)
+    funcs = [
+        func
+        for _name, func in inspect.getmembers(module, is_func)
+        if get_module_of_obj(func).__name__ == module.__name__
+    ]
+    # sort by definition order
+    return sorted(funcs, key=get_def_line)
+
+
+def unwrap_method(method: Any) -> Callable[..., Any] | Any:
+    """Unwrap a method to its underlying function.
+
+    Args:
+        method: The method to unwrap
+
+    Returns:
+        The underlying function of the method
+
+    """
+    if isinstance(method, (staticmethod, classmethod)):
+        method = method.__func__
+    if isinstance(method, property):
+        method = method.fget
+    return inspect.unwrap(method)