get_object

get_object(
    path,
    object_name=None,
    parser='numpy',
    load_aliases=True,
    dynamic=False,
    loader=None,
)

Fetch a griffe object.

Parameters

path : str: An import path to the object. This should have the form path.to.module:object. For example, quartodoc:get_object or quartodoc:MdRenderer.render.
object_name : 'str | None' = None: (Deprecated). A function name.
parser : str = 'numpy': A docstring parser to use.
load_aliases : = True: For aliases that were imported from other modules, should we load that module?
dynamic : = False: Whether to dynamically import object. Useful if docstring is not hard-coded, but was set on object by running python code.

>>> get_function("quartodoc", "get_function")
<Function('get_function', ...