NumPy – 2 – Help e documentazione di IPython

fworks

Continuo da qui, seguendo Jake, qui.

Help e documentazione di IPython
If you read no other section in this chapter, read this one: I find the tools discussed here to be the most transformative contributions of IPython to my daily workflow.

Sì ci sono, e funzionano, i soliti sistemi, per esempio Stack Overflow e amici e conoscenti (anche via Web), ma dice Jake:

One of the most useful functions of IPython/Jupyter is to shorten the gap between the user and the type of documentation and search that will help them do their work effectively. While web searches still play a role in answering complicated questions, an amazing amount of information can be found through IPython alone. Some examples of the questions IPython can help answer in a few keystrokes:

  • How do I call this function? What arguments and options does it have?
  • What does the source code of this Python object look like?
  • What is in this package I imported? What attributes or methods does this object have?

Here we’ll discuss IPython’s tools to quickly access this information, namely the ? character to explore documentation, the ?? characters to explore source code, and the Tab key for auto-completion.

Documentazione con ?
Credo basti un esempio:

np3

E funziona anche con le funzioni che si definiscono, a patto di usare la docstring:

np4

Accedere al codice con ??

np5

Esplorare i moduli con <TAB>
IPython’s other useful interface is the use of the tab key for auto-completion and exploration of the contents of objects, modules, and name-spaces. È un po’ diverso da come indicato da Jake (e il tab che inserisco alla fine del comando non si vede):

np6

e

np7

si può anche scrivere l’inizio del metodo, verranno visualizzati solo quelli corrispondenti:

np8

Vale anche per i metodi privati/interni:

np9

Vale anche per gli imports

np10

e anche

np11

insomma sempre.

Oltre al TAB completion: wildcard matching
Tab completion is useful if you know the first few characters of the object or attribute you’re looking for, but is little help if you’d like to match characters at the middle or end of the word. For this use-case, IPython provides a means of wildcard matching for names using the * character.

For example, we can use this to list every object in the namespace that ends with Warning:

np12

come si vede vale anche per casi più generali.

Insomma, non so voi ma per me IPython è la mia nuova REPL 😀
Non sono ancora partito con NumPy? No, ma si sa che Ankh-Morpork non è stata costruita in un giorno 😉
:mrgreen:

Advertisements
Post a comment or leave a trackback: Trackback URL.

Trackbacks

Rispondi

Inserisci i tuoi dati qui sotto o clicca su un'icona per effettuare l'accesso:

Logo WordPress.com

Stai commentando usando il tuo account WordPress.com. Chiudi sessione / Modifica )

Foto Twitter

Stai commentando usando il tuo account Twitter. Chiudi sessione / Modifica )

Foto di Facebook

Stai commentando usando il tuo account Facebook. Chiudi sessione / Modifica )

Google+ photo

Stai commentando usando il tuo account Google+. Chiudi sessione / Modifica )

Connessione a %s...

%d blogger hanno fatto clic su Mi Piace per questo: