Skip to content

omnipy.util.griffe_extension

CLASS DESCRIPTION
UseDynamicSignatureForSpecificFunctions
ATTRIBUTE DESCRIPTION
logger

logger module-attribute 

logger = griffe.get_logger('griffe_dyn_signature_specific_functions')

UseDynamicSignatureForSpecificFunctions

Bases: griffe.Extension

METHOD DESCRIPTION
__init__
on_function_instance
ATTRIBUTE DESCRIPTION
functions

Source code in src/omnipy/util/griffe_extension.py 
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class UseDynamicSignatureForSpecificFunctions(griffe.Extension):
    def __init__(self, functions: list[str]) -> None:
        self.functions = functions

    def on_function_instance(self, *, func: griffe.Function, **kwargs) -> None:
        from _griffe.agents.inspector import _convert_object_to_annotation, _convert_parameter

        if func.path not in self.functions:
            return

        try:
            runtime_func = griffe.dynamic_import(func.path)
        except ImportError as error:
            logger.warning(f'Could not import {func.path}: {error}')
            return

        signature = inspect.signature(runtime_func)

        parameters = griffe.Parameters(
            *[
                _convert_parameter(parameter, parent=func.parent)
                for parameter in signature.parameters.values()
            ],)

        return_annotation = signature.return_annotation
        returns = (None if return_annotation is inspect.Signature.empty else
                   _convert_object_to_annotation(return_annotation, parent=func.parent))

        func.parameters = parameters
        func.returns = returns

functions instance-attribute 

functions = functions

__init__ 

__init__(functions: list[str]) -> None
Source code in src/omnipy/util/griffe_extension.py 
 9
10
def __init__(self, functions: list[str]) -> None:
    self.functions = functions

on_function_instance 

on_function_instance(*, func: griffe.Function, **kwargs) -> None
Source code in src/omnipy/util/griffe_extension.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
def on_function_instance(self, *, func: griffe.Function, **kwargs) -> None:
    from _griffe.agents.inspector import _convert_object_to_annotation, _convert_parameter

    if func.path not in self.functions:
        return

    try:
        runtime_func = griffe.dynamic_import(func.path)
    except ImportError as error:
        logger.warning(f'Could not import {func.path}: {error}')
        return

    signature = inspect.signature(runtime_func)

    parameters = griffe.Parameters(
        *[
            _convert_parameter(parameter, parent=func.parent)
            for parameter in signature.parameters.values()
        ],)

    return_annotation = signature.return_annotation
    returns = (None if return_annotation is inspect.Signature.empty else
               _convert_object_to_annotation(return_annotation, parent=func.parent))

    func.parameters = parameters
    func.returns = returns