JuliaPy / JuliaPy/PyCall.jl

shift + tab python function signature

Abierto
#454 5 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Julia
Estrellas
1.5k
Forks
186
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

This was something I was missing when working with my python code, specifically interactively in the Jupyter notebook.

I don't know how to implement this in a safe way so I'll propose it here as an enhancement. Basically, on shift + tab we should grab the python function signature like IPython does in the Jupyter Notebook.

@pyimport IPython.core.oinspect as oinspect
function pyobjsignature(o::PyObject)
    s = oinspect.signature(o)[:__str__]()
    if haskey(o, "__name__")
        s = string(o["__name__"][:__str__](), s)
    else
        s = string("function_call -> ", s)
    end
    if haskey(o, "__doc__")
        d = o[:__doc__]
    end
    if typeof(d) <: AbstractString
        return Base.Docs.Text(join([s, convert(AbstractString, d)], "\n"))
    else
        return Base.Docs.Text(join([s, "No Python Docstring"], "\n"))
    end
end
Base.Docs.getdoc(o::PyObject) = pyobjsignature(o)

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

El issue menciona PyCall.jl, IPython.core.oinspect y el Jupyter Notebook, pero ningún archivo del repositorio ni ninguna prueba. Empieza localizando la documentación de PyObject y el manejo de firmas, y después compáralos con el comportamiento propuesto de pyobjsignature; se considera terminado cuando Shift+Tab muestra de forma segura una firma de Python y un docstring en el flujo de trabajo interactivo.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
julia, jupyter-notebook, python
Área
developer-experience, tooling
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
30/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.