Wskazówki dotyczące debugowania Pythona [zamknięte]

Jakie są twoje najlepsze wskazówki dotyczące debugowania Pythona?

Proszę nie wymieniać konkretnego debuggera bez mówienia, co on właściwie potrafi.

Związane z

• Jakie są dobre sposoby, aby mój kod w Pythonie był uruchamiany po raz pierwszy? - Omówiono minimalizowanie błędów

PDB

Możesz użyć modułu pdb, wstawić w pdb.set_trace()dowolnym miejscu i będzie on działał jako punkt przerwania.

>>> import pdb
>>> a="a string"
>>> pdb.set_trace()
--Return--
> <stdin>(1)<module>()->None
(Pdb) p a
'a string'
(Pdb)

Aby kontynuować wykonywanie, użyj c(lub contlub continue).

Możliwe jest wykonanie dowolnych wyrażeń Pythona za pomocą pdb. Na przykład, jeśli znajdziesz błąd, możesz poprawić kod, a następnie wpisać wyrażenie typu, aby uzyskać ten sam efekt w uruchomionym kodzie

ipdb to wersja pdb dla IPythona . Pozwala na użycie pdb ze wszystkimi funkcjami IPythona, w tym uzupełnianiem tabulatorów.

Możliwe jest również ustawienie pdb tak, aby automatycznie uruchamiał się w przypadku nieprzechwyconego wyjątku.

Pydb został napisany jako ulepszona wersja Pdb. Korzyści?

http://pypi.python.org/pypi/pudb , pełnoekranowy, oparty na konsoli debugger Pythona.

Jego celem jest zapewnienie wszystkich niuansów nowoczesnych debugerów opartych na GUI w bardziej lekkim i przyjaznym dla klawiatury pakiecie. PuDB umożliwia debugowanie kodu w miejscu, w którym go piszesz i testujesz - w terminalu. Jeśli pracowałeś z doskonałymi (ale obecnie starożytnymi) narzędziami Turbo Pascal lub C opartymi na DOS, interfejs użytkownika PuDB może wyglądać znajomo.

Przyjemne do debugowania samodzielnych skryptów, po prostu uruchom

python -m pudb.run my-script.py

Jeśli używasz pdb, możesz zdefiniować aliasy dla skrótów. Używam tych:

# Ned's .pdbrc

# Print a dictionary, sorted. %1 is the dict, %2 is the prefix for the names.
alias p_ for k in sorted(%1.keys()): print "%s%-15s= %-80.80s" % ("%2",k,repr(%1[k]))

# Print the instance variables of a thing.
alias pi p_ %1.__dict__ %1.

# Print the instance variables of self.
alias ps pi self

# Print the locals.
alias pl p_ locals() local:

# Next and list, and step and list.
alias nl n;;l
alias sl s;;l

# Short cuts for walking up and down the stack
alias uu u;;u
alias uuu u;;u;;u
alias uuuu u;;u;;u;;u
alias uuuuu u;;u;;u;;u;;u
alias dd d;;d
alias ddd d;;d;;d
alias dddd d;;d;;d;;d
alias ddddd d;;d;;d;;d;;d

Logowanie

Python ma już doskonały wbudowany moduł logowania . Możesz tutaj użyć szablonu rejestrowania .

Moduł rejestrowania umożliwia określenie poziomu ważności; podczas debugowania możesz rejestrować wszystko, podczas gdy podczas normalnej pracy możesz rejestrować tylko krytyczne rzeczy. Możesz włączać i wyłączać różne rzeczy.

Większość ludzi po prostu używa podstawowych instrukcji print do debugowania, a następnie usuwa instrukcje print. Lepiej je zostawić, ale wyłącz je; wtedy, gdy pojawi się kolejny błąd, możesz po prostu ponownie włączyć wszystko i przejrzeć dzienniki.

Może to być najlepszy możliwy sposób debugowania programów, które muszą działać szybko, takich jak programy sieciowe, które muszą odpowiedzieć, zanim drugi koniec połączenia sieciowego wygaśnie i znika. Możesz nie mieć dużo czasu na jednoetapowe uruchamianie debuggera; ale możesz po prostu pozwolić uruchomić kod i zarejestrować wszystko, a następnie przejrzeć dzienniki i dowiedzieć się, co się naprawdę dzieje.

EDYCJA: Oryginalny adres URL szablonów to: http://aymanh.com/python-debugging-techniques

Brakuje tej strony, więc zastąpiłem ją odniesieniem do migawki zapisanej na archive.org: http://web.archive.org/web/20120819135307/http://aymanh.com/python-debugging-techniques

Na wypadek, gdyby znowu zniknął, oto szablony, o których wspomniałem. To jest kod pobrany z bloga; Nie napisałem tego.

import logging
import optparse

LOGGING_LEVELS = {'critical': logging.CRITICAL,
                  'error': logging.ERROR,
                  'warning': logging.WARNING,
                  'info': logging.INFO,
                  'debug': logging.DEBUG}

def main():
  parser = optparse.OptionParser()
  parser.add_option('-l', '--logging-level', help='Logging level')
  parser.add_option('-f', '--logging-file', help='Logging file name')
  (options, args) = parser.parse_args()
  logging_level = LOGGING_LEVELS.get(options.logging_level, logging.NOTSET)
  logging.basicConfig(level=logging_level, filename=options.logging_file,
                      format='%(asctime)s %(levelname)s: %(message)s',
                      datefmt='%Y-%m-%d %H:%M:%S')

  # Your program goes here.
  # You can access command-line arguments using the args variable.

if __name__ == '__main__':
  main()

A oto jego wyjaśnienie, jak korzystać z powyższego. Ponownie, nie mam za to uznania:

Domyślnie moduł rejestrowania wyświetla komunikaty krytyczne, komunikaty o błędach i ostrzeżenia. Aby to zmienić, aby wszystkie poziomy były drukowane, użyj:

$ ./your-program.py --logging=debug

Aby wysłać komunikaty dziennika do pliku o nazwie debug.log, użyj:

$ ./your-program.py --logging-level=debug --logging-file=debug.log

Możliwe jest wydrukowanie, jakie wiersze Pythona są wykonywane (dzięki Geo!). Ma dowolną liczbę aplikacji, na przykład możesz go zmodyfikować, aby sprawdzić, kiedy wywoływane są określone funkcje lub dodać coś takiego jak ##, aby śledził tylko określone linie.

code.interact przenosi Cię do interaktywnej konsoli

import code; code.interact(local=locals())

Jeśli chcesz mieć łatwy dostęp do historii swojej konsoli, spójrz na: „ Czy mogę mieć mechanizm historii taki jak w powłoce? ” (Będę musiał spojrzeć w dół).

Tłumaczowi można włączyć autouzupełnianie .

ipdb jest jak pdb, z niesamowitością ipythona.

print sprawozdania

• Niektórzy ludzie zalecają debug_printfunkcję zamiast drukowania w celu łatwego wyłączenia
• pprintModuł nieocenione złożonych struktur

oczywisty sposób debugowania skryptu

python -m pdb script.py

• przydatne, gdy ten skrypt zgłasza wyjątek
• przydatne, gdy polecenie virtualenv i pdb nie działa w wersji Venvs Python.

jeśli nie wiesz dokładnie, gdzie jest ten skrypt

python -m pdb ``which <python-script-name>``

PyDev

PyDev ma całkiem niezły interaktywny debugger. Zawiera wyrażenia obserwacyjne, najedź do oceny, listy wątków i stosów oraz (prawie) wszystkie zwykłe udogodnienia, których oczekujesz od nowoczesnego debugera wizualnego. Możesz nawet podłączyć się do działającego procesu i przeprowadzić zdalne debugowanie.

Jednak podobnie jak inne debugery wizualne, uważam, że jest on przydatny głównie w przypadku prostych problemów lub bardzo skomplikowanych problemów po wypróbowaniu wszystkiego innego. Nadal wykonuję większość ciężkich prac z wyrębem.

Jeśli znasz program Visual Studio, szukasz narzędzi języka Python dla programu Visual Studio .

Winpdb jest bardzo fajny i wbrew swojej nazwie jest całkowicie wieloplatformowy.

Ma bardzo fajny debugger oparty na podpowiedziach i GUI oraz obsługuje zdalne debugowanie.

W Vimie mam te trzy wiązania:

map <F9> Oimport rpdb2; rpdb2.start_embedded_debugger("asdf") #BREAK<esc>
map <F8> Ofrom nose.tools import set_trace; set_trace() #BREAK<esc>
map <F7> Oimport traceback, sys; traceback.print_exception(*sys.exc_info()) #TRACEBACK<esc>

rpdb2to Remote Python Debugger, którego można używać z WinPDB, solidnym graficznym debugerem. Ponieważ wiem, że zapytasz, może zrobić wszystko, czego oczekuję od debugera graficznego :)

Używam pdbfrom, nose.toolsaby móc debugować testy jednostkowe, a także normalny kod.

Na koniec F7mapowanie wydrukuje traceback (podobny do tego, jaki otrzymujesz, gdy wyjątek przesuwa się na szczyt stosu). Zauważyłem, że jest naprawdę przydatny więcej niż kilka razy.

Definiowanie przydatnych metod repr () dla twoich klas (abyś mógł zobaczyć, czym jest obiekt) i użycie repr () lub "% r"% (...) lub "... {0! R} ..". Format (...) w wiadomościach / dziennikach debugowania jest kluczem IMHO do wydajnego debugowania.

Ponadto debuggery wymienione w innych odpowiedziach będą korzystać z metod repr ().

Pobieranie śladu stosu z działającej aplikacji w języku Python

Istnieje kilka sztuczek tutaj . Obejmują one

• Włamanie się do interpretera / wydrukowanie śladu stosu przez wysłanie sygnału
• Pobieranie śladu stosu z nieprzygotowanego procesu w Pythonie
• Uruchamianie interpretera z flagami, aby był przydatny do debugowania

Jeśli nie lubisz spędzać czasu w debuggerach (i nie doceniasz słabej użyteczności pdbinterfejsu wiersza poleceń), możesz zrzucić ślad wykonania i przeanalizować go później. Na przykład:

python -m trace -t setup.py install > execution.log

Spowoduje to zrzucenie wszystkich linii źródłowych setup.py install wykonania do execution.log.

Aby ułatwić dostosowywanie wyników śledzenia i pisanie własnych znaczników, umieściłem kilka fragmentów kodu w module xtrace (domena publiczna).

Jeśli to możliwe, debuguję używając M-x pdbw emacsie do debugowania na poziomie źródła.

Istnieje pełny kurs online o nazwie „ Debugowanie oprogramowania ” autorstwa Andreasa Zellera w serwisie Udacity, zawierający wskazówki dotyczące debugowania:

Podsumowanie kursu

Na tych zajęciach dowiesz się, jak systematycznie debugować programy, jak zautomatyzować proces debugowania i zbudować kilka automatycznych narzędzi do debugowania w Pythonie.

Dlaczego warto wziąć ten kurs?

Pod koniec tego kursu będziesz miał solidną wiedzę na temat systematycznego debugowania, będziesz wiedział, jak zautomatyzować debugowanie i zbudujesz kilka funkcjonalnych narzędzi do debugowania w Pythonie.

Wymagania wstępne i wymagania

Wymagana jest podstawowa znajomość programowania i języka Python na poziomie Udacity CS101 lub wyższym. Pomocna jest podstawowa znajomość programowania obiektowego.

Wysoce rekomendowane.

jeśli chcesz mieć ładny graficzny sposób drukowania stosu wywołań w czytelny sposób, sprawdź to narzędzie: https://github.com/joerick/pyinstrument

Uruchom z wiersza poleceń:

python -m pyinstrument myscript.py [args...]

Uruchom jako moduł:

from pyinstrument import Profiler

profiler = Profiler()
profiler.start()

# code you want to profile

profiler.stop()
print(profiler.output_text(unicode=True, color=True))

Uruchom z django:

Po prostu dodaj pyinstrument.middleware.ProfilerMiddlewaredo MIDDLEWARE_CLASSES, a następnie dodaj ?profilena końcu adresu URL żądania, aby aktywować profiler.