iframe-proxy | Sunbelt Computer Software

History

76 lines (63 loc) · 2.31 KB

Raw

from pathlib import Path

from IPython.core.alias import Alias

from IPython.core.interactiveshell import InteractiveShell

from IPython.core.magic import MagicAlias

from IPython.utils.text import dedent, indent

def _strip_underline(line):

chars = set(line.strip())

if len(chars) == 1 and ("-" in chars or "=" in chars):

return ""

else:

return line

def format_docstring(func):

docstring = (func.__doc__ or "Undocumented").rstrip()

docstring = indent(dedent(docstring))

# Sphinx complains if indented bits have rst headings in, so strip out

# any underlines in the docstring.

lines = [_strip_underline(l) for l in docstring.splitlines()]

return "\n".join(lines)

# Case insensitive sort by name

def sortkey(s): return s[0].lower()

def main():

shell = InteractiveShell.instance()

# Built-in magics are declared lazily; documenting them all means

# importing them all.

shell.magics_manager.load_all_lazy_magics()

magics = shell.magics_manager.magics

output = [

"Line magics",

"===========",

"",

]

for name, func in sorted(magics["line"].items(), key=sortkey):

if isinstance(func, Alias) or isinstance(func, MagicAlias):

# Aliases are magics, but shouldn't be documented here

# Also skip aliases to other magics

continue

output.extend([".. magic:: {}".format(name),

"",

format_docstring(func),

""])

output.extend([

"Cell magics",

"===========",

"",

])

for name, func in sorted(magics["cell"].items(), key=sortkey):

if name == "!":

# Special case - don't encourage people to use %%!

continue

if func == magics["line"].get(name, "QQQP"):

# Don't redocument line magics that double as cell magics

continue

if isinstance(func, MagicAlias):

continue

output.extend([".. cellmagic:: {}".format(name),

"",

format_docstring(func),

""])

src_path = Path(__file__).parent

dest = src_path.joinpath("source", "interactive", "magics-generated.txt")

dest.write_text("\n".join(output), encoding="utf-8")

if __name__ == "__main__":

main()

Sunbelt Computer Software

PL/B Language Development and Support

Navigation Menu

Uh oh!

Uh oh!

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

Uh oh!

FilesExpand file tree

autogen_magics.py

Latest commit

History

autogen_magics.py

File metadata and controls