Export extras with as_json(full=true)

[ISOR3X]

Hi, I am working on documentation for a package and am trying out Griffe to see if I could use it.

I have an extension that adds the complete function signature as an extra so I don't have to completely construct it from the objects. Currently I do this with just func.extra["signature"] = func.lines[0] which would probably break easily, any suggestions on how I could do this better?

Anyway, I noticed that when using as_json, even with the option full set to true, the extras are not exported. Is there a way to add them to the export?

[pawamoy]

Hey @ISOR3X, good questions!

any suggestions on how I could do this better?

Honestly, not really. The first lines might be decorators spanning multiple lines. I guess you could pick the first line that starts with \s+def \w+, but even then, signatures can span multiple lines. You'd have to actually tokenize the code to make sure to get the right thing.

The best thing we could do is provide such functionality directly in Griffe. You can definitely open a feature request for that 😄

Anyway, I noticed that when using as_json, even with the option full set to true, the extras are not exported. Is there a way to add them to the export?

Right, we don't currently add extras to the JSON output. I'm open to supporting this, can you open a second feature request for this 🙂?

[ISOR3X]

Thanks for the reply!

I could definitely take a look at adding extra's the the as_json as a PR, just need to take a look when I have time.

Honestly, not really. The first lines might be decorators spanning multiple lines. I guess you could pick the first line that starts with \s+def \w+, but even then, signatures can span multiple lines. You'd have to actually tokenize the code to make sure to get the right thing.

You also maintain mkdocstrings-python right? How do you construct the function signature there?
This is documentation from mkdocstring-python for reference:

I want to create something similar except in markdown so I can use it in vitepress

[pawamoy]

You also maintain mkdocstrings-python right? How do you construct the function signature there?

Good question again! In mkdocstrings-python we use Jinja templating to rebuild the signature, the source is here:

https://github.com/mkdocstrings/python/blob/main/src/mkdocstrings_handlers/python/templates/material/_base/signature.html.jinja

The feature request you could open would be about adding such signature building functionality to Griffe directly, in Python instead of Jinja.

Oh, we also do something similar for Markdown instead of HTML, in griffe2md:

https://github.com/mkdocstrings/griffe2md/blob/main/src/griffe2md/templates/signature.md.jinja