#11287: Interface to runsnake and import_statements
------------------------------------------+---------------------------------
Reporter: nthiery | Owner: tbd
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-4.7.1
Component: performance | Keywords: runsnake, prun,
profiling
Work_issues: | Upstream: N/A
Reviewer: Franco Saliola, Simon King | Author: Nicolas M. Thiéry
Merged: | Dependencies:
------------------------------------------+---------------------------------
Comment(by saliola):
Hello! I just posted a reviewer's patch that addresses some documentation
issues. The docstrings for the Profiler module needed to be fixed so that
they
rendered correctly in the reference manual.
Note that this patch depends on #11251, since you are using the new todo
directive that is implemented in that ticket.
I am willing to give this a positive review, provided my changes are
acceptable.
Let me try to address Simon's comments:
Replying to [comment:5 SimonKing]:
> '''Runsnake'''
>
> Can you give at least a slight hint how to use runsnake?
There is an example on how to use it provided in the
documentation:
{{{
EXAMPLES::
sage: runsnake("list(SymmetricGroup(3))") # optional - requires
runsnake
}}}
The expected behaviour is that a window pops up (see the screenshot).
> Does one need to leave Sage, start a Sage shell, and then open
`OpenGLContext.profile` by `runsnake OpenGLContext.profile`? (That step
did not work for me, it seems I need to get wx)
>
> Can one use it without leaving Sage?
Yes. One needs only run the function in the example above. This function
initializes the profiler and (doing essentially what you wrote above),
and then launches runsnake.
> '''import_statements'''
>
> That tool seems useful.
Agreed. It looks very nice.
> Worse, the `__module__` attribute can be misleading. Unfortunately, it
is particularly misleading if you initialise the category of a parent:
This issue is documented in a "todo" block, but this todo block does not
appear in the command-line view of the documentation. So that's probably
why
you didn't see it (it does appear if you ask for source
{{{import_statements??}}}). This is not a problem with this ticket though,
but
with the todo directive; see #11251.
> I would recommend to use the tools from sage.misc.sageinspect, but only
after applying #9976, which considerably extends the capabilities of
finding source files (here:
sage/rings/polynomial/multi_polynomial_libsingular.pyx), from which one
can deduce the import statement.
Perhaps this might be a good idea and can address the issue that the
`__module__` attribute is not always present. I'll leave it to Nicolas to
comment on this.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/11287#comment:6>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
