def get_signature_component_svelte()

in src/doc_builder/autodoc.py [0:0]

• 48 lines of code
• 11 McCabe index (conditional complexity)

def get_signature_component_svelte(name, anchor, signature, object_doc, source_link=None, is_getset_desc=False):
    print("some things svelte")
    """
    Returns the svelte `Docstring` component string.

    Args:
    - **name** (`str`) -- The name of the function or class to document.
    - **anchor** (`str`) -- The anchor name of the function or class that will be used for hash links.
    - **signature** (`List(Dict(str,str))`) -- The signature of the object.
    - **object_doc** (`str`) -- The docstring of the the object.
    - **source_link** (Union[`str`, `None`], *optional*, defaults to `None`) -- The github source link of the the object.
    - **is_getset_desc** (`bool`, *optional*, defaults to `False`) -- Whether the type of obj is `getset_descriptor`.
    """
    object_doc = _re_returns.sub(lambda m: inside_example_finder_closure(m, "returns"), object_doc)
    object_doc = _re_parameters.sub(lambda m: inside_example_finder_closure(m, "parameters"), object_doc)

    object_doc, parameters = regex_closure(object_doc, _re_parameters)
    object_doc, return_description = regex_closure(object_doc, _re_returns)
    object_doc, returntype = regex_closure(object_doc, _re_returntype)
    object_doc, yield_description = regex_closure(object_doc, _re_yields)
    object_doc, yieldtype = regex_closure(object_doc, _re_yieldtype)
    object_doc, raise_description = regex_closure(object_doc, _re_raises)
    object_doc, raisederrors = regex_closure(object_doc, _re_raisederrors)
    object_doc = remove_example_tags(object_doc)
    object_doc = hashlink_example_codeblock(object_doc, anchor)

    svelte_str = "<docstring>"
    svelte_str += f"<name>{name}</name>"
    svelte_str += f"<anchor>{anchor}</anchor>"
    if source_link:
        svelte_str += f"<source>{source_link}</source>"
    svelte_str += f"<parameters>{json.dumps(signature)}</parameters>"
    if is_getset_desc:
        svelte_str += "<isgetsetdescriptor>"

    if parameters is not None:
        parameters_str = ""
        groups = _re_parameter_group.split(parameters)
        group_default = groups.pop(0)
        parameters_str += f"<paramsdesc>{group_default}</paramsdesc>"
        n_groups = len(groups) // 2
        for idx in range(n_groups):
            id = idx + 1
            title, group = groups[2 * idx], groups[2 * idx + 1]
            parameters_str += f"<paramsdesc{id}title>{title}</paramsdesc{id}title>"
            parameters_str += f"<paramsdesc{id}>{group}</paramsdesc{id}>"

        svelte_str += parameters_str
        svelte_str += f"<paramgroups>{n_groups}</paramgroups>"

    if returntype is not None:
        svelte_str += f"<rettype>{returntype}</rettype>"
    if return_description is not None:
        svelte_str += f"<retdesc>{return_description}</retdesc>"

    if yieldtype is not None:
        svelte_str += f"<yieldtype>{yieldtype}</yieldtype>"
    if yield_description is not None:
        svelte_str += f"<yielddesc>{yield_description}</yielddesc>"

    if raise_description is not None:
        svelte_str += f"<raises>{raise_description}</raises>"
    if raisederrors is not None:
        svelte_str += f"<raisederrors>{raisederrors}</raisederrors>"

    svelte_str += "</docstring>"

    return svelte_str + f"\n{object_doc}\n"