PyCharm für produktive Python-Entwicklung (Leitfaden)

In diesem Artikel wird PyCharm Community Edition 2019.1 verwendet, da es kostenlos und auf allen wichtigen Plattformen verfügbar ist. Nur der Abschnitt über die professionellen Funktionen verwendet PyCharm Professional Edition 2019.1.

Die empfohlene Methode zur Installation von PyCharm ist die JetBrains Toolbox App. Mithilfe dieser Funktion können Sie verschiedene JetBrains-Produkte oder mehrere Versionen desselben Produkts installieren, aktualisieren, zurücksetzen und bei Bedarf problemlos alle Tools entfernen. Sie können auch jedes Projekt in der richtigen IDE und Version schnell öffnen.

Informationen zum Installieren der Toolbox-App finden Sie unter documentation von JetBrains. Abhängig von Ihrem Betriebssystem erhalten Sie automatisch die richtigen Anweisungen. Falls Ihr Betriebssystem nicht richtig erkannt wurde, finden Sie es immer in der Dropdown-Liste oben rechts:

https://files.realpython.com/media/pycharm-jetbrains-os-list.231740335aaa.png [Bild: https://files.realpython.com/media/pycharm-jetbrains-os-list.231740335aaa.png [ Liste der Betriebssysteme auf der JetBrains-Website, Breite = 1010, Höhe = 679]]

Starten Sie nach der Installation die App und akzeptieren Sie die Benutzervereinbarung. Auf der Registerkarte "Tools" wird eine Liste der verfügbaren Produkte angezeigt. Suchen Sie dort die PyCharm-Community und klicken Sie auf Install:

https://files.realpython.com/media/pycharm-toolbox-installed-pycharm.cdcf1b52bc02.png [Bild: https://files.realpython.com/media/pycharm-toolbox-installed-pycharm.cdcf1b52bc02.png [ PyCharm mit der Toolbox-App installiert, Breite = 337, Höhe = 537]]

Voilà! Sie haben PyCharm auf Ihrem Computer verfügbar. Wenn Sie die Toolbox-App nicht verwenden möchten, können Sie auch eine stand-alone-Installation von PyCharm durchführen.

Starten Sie PyCharm und Sie sehen das Popup mit den Importeinstellungen:

https://files.realpython.com/media/pycharm-import-settings-popup.4e360260c697.png [Bild: https://files.realpython.com/media/pycharm-import-settings-popup.4e360260c697.png [ Popup für PyCharm-Importeinstellungen, Breite = 416, Höhe = 156]]

PyCharm erkennt automatisch, dass es sich um eine Neuinstallation handelt, und wählt "Einstellungen nicht importieren" für Sie. Klicken Sie auf OK, und PyCharm fordert Sie auf, ein Keymap-Schema auszuwählen. Übernehmen Sie die Standardeinstellung und klicken Sie unten rechts auf Next: UI Themes:

PyCharm fordert Sie dann auf, ein dunkles Thema namens Darcula oder ein helles Thema auszuwählen. Wählen Sie eine beliebige Option aus und klicken Sie auf Next: Launcher Script:

https://files.realpython.com/media/pycharm-set-ui-theme.c48aac8e3fe0.png [Bild: https://files.realpython.com/media/pycharm-set-ui-theme.c48aac8e3fe0.png [ PyCharm Set UI Theme Page, Breite = 803, Höhe = 666]]

Ich werde in diesem Tutorial das dunkle Thema Darcula verwenden. Sie können andere Themen als Link finden und installieren: # using-plugins-and-external-tools-in-pycharm [Plugins], oder Sie können auch importiere sie.

Übernehmen Sie auf der nächsten Seite die Standardeinstellungen und klicken Sie auf Next: Featured plugins. Dort zeigt Ihnen PyCharm eine Liste der Plugins, die Sie möglicherweise installieren möchten, da die meisten Benutzer sie gerne verwenden. Klicken Sie auf Start using PyCharm, und jetzt können Sie Code schreiben!

In PyCharm erledigen Sie alles im Kontext eines Projekts . Das erste, was Sie tun müssen, ist eine zu erstellen.

Nach der Installation und dem Öffnen von PyCharm befinden Sie sich auf dem Begrüßungsbildschirm. Klicken Sie auf "Neues Projekt erstellen". Das Popup "Neues Projekt" wird angezeigt:

Geben Sie den Projektspeicherort an und erweitern Sie die Dropdown-Liste Project Interpreter. Hier haben Sie die Möglichkeit, einen neuen Projektinterpreter zu erstellen oder einen vorhandenen wiederzuverwenden. Wählen Sie Neue Umgebung mit. Direkt daneben haben Sie eine Dropdown-Liste, in der Sie Virtualenv, Pipenv oder Conda auswählen können. Diese Tools helfen dabei, die für verschiedene Projekte erforderlichen Abhängigkeiten getrennt zu halten, indem Sie isolierte Python-Umgebungen für sie erstellen.

Sie können frei wählen, was Sie möchten, aber Virtualenv wird für dieses Tutorial verwendet. Wenn Sie möchten, können Sie den Umgebungsspeicherort angeben und den Basisinterpreter aus der Liste auswählen. Hierbei handelt es sich um eine Liste der auf Ihrem System installierten Python-Interpreter (wie Python2.7 und Python3.6). Normalerweise sind die Standardeinstellungen in Ordnung. Dann müssen Sie Kästchen auswählen, um globale Site-Pakete an Ihre neue Umgebung zu erben und sie allen anderen Projekten zur Verfügung zu stellen. Lassen Sie sie nicht ausgewählt.

Klicken Sie unten rechts auf Create und Sie sehen das neu erstellte Projekt:

Sie sehen auch ein kleines Tip of the Day-Popup, in dem PyCharm Ihnen bei jedem Start einen Trick zum Lernen gibt. Fahren Sie fort und schließen Sie dieses Popup.

Es ist jetzt Zeit, ein neues Python-Programm zu starten. Geben Sie [.keys] # Cmd + N # ein, wenn Sie einen Mac verwenden, oder [.keys] # Alt + Ins #, wenn Sie Windows oder Linux verwenden. Wählen Sie dann Python File. Sie können auch File → New aus dem Menü auswählen. Benennen Sie die neue Datei "+ rate_game.py +" und klicken Sie auf "OK". Sie sehen ein PyCharm-Fenster ähnlich dem folgenden:

Lassen Sie uns für unseren Testcode schnell ein einfaches Ratespiel codieren, in dem das Programm eine Zahl auswählt, die der Benutzer erraten muss. Bei jeder Vermutung erkennt das Programm, ob die Vermutung des Benutzers kleiner oder größer als die Geheimnummer war. Das Spiel endet, wenn der Benutzer die Nummer errät. Hier ist der Code für das Spiel:

Geben Sie diesen Code direkt ein, anstatt ihn zu kopieren und einzufügen. Sie sehen ungefähr Folgendes:

Wie Sie sehen können, bietet PyCharm Intelligent Coding Assistance mit Code-Vervollständigung, Code-Inspektionen, Hervorhebung von Fehlern im laufenden Betrieb und schnellen Korrekturvorschlägen. Beachten Sie insbesondere, dass PyCharm bei Eingabe von "+ main " und anschließendem Drücken der Tabulatortaste die gesamte " main +" - Klausel automatisch für Sie ausgefüllt hat.

Beachten Sie auch, dass PyCharm die Klausel "+ if " für Sie korrigiert, wenn Sie vergessen, vor der Bedingung " if " einzugeben, " .if " anzuhängen und dann [.keys] # Tab # zu drücken. Gleiches gilt für ` True.while +`. Das ist PyCharms Postfix-Vervollständigungen, die Ihnen dabei helfen, Rückwärtssprünge zu reduzieren.

Nachdem Sie das Spiel codiert haben, können Sie es ausführen.

Sie haben drei Möglichkeiten, dieses Programm auszuführen:

Verwenden Sie eine der oben genannten Optionen, um das Programm auszuführen. Der Bereich "Ausführungswerkzeug" wird unten im Fenster angezeigt. Ihre Code-Ausgabe zeigt Folgendes:

Spielen Sie das Spiel ein wenig, um zu sehen, ob Sie die erratene Zahl finden können. Profi-Tipp: Beginnen Sie mit 50.

Hast du die Nummer gefunden? Wenn ja, haben Sie möglicherweise etwas Seltsames gesehen, nachdem Sie die Nummer gefunden haben. Anstatt die Glückwunschmeldung auszudrucken und zu beenden, scheint das Programm von vorne zu beginnen. Das ist genau dort ein Fehler. Um herauszufinden, warum das Programm neu gestartet wird, debuggen Sie das Programm jetzt.

Platzieren Sie zunächst einen Haltepunkt, indem Sie auf das Leerzeichen links neben Zeile 8 klicken:

Dies ist der Punkt, an dem das Programm angehalten wird, und Sie können von nun an untersuchen, was schief gelaufen ist. Wählen Sie als Nächstes eine der folgenden drei Möglichkeiten, um mit dem Debuggen zu beginnen:

Anschließend wird unten ein Debug-Fenster geöffnet:

Führen Sie die folgenden Schritte aus, um das Programm zu debuggen:

Herzliche Glückwünsche! Sie haben den Fehler behoben.

Keine Anwendung ist ohne Unit-Tests zuverlässig. Mit PyCharm können Sie sie sehr schnell und bequem schreiben und ausführen. Standardmäßig wird https://docs.python.org/3/library/unittest.html [+ unittest +] als Testläufer verwendet, PyCharm unterstützt jedoch auch andere Testframeworks wie http://www.pytest. org/de/latest/[+ pytest +], + Nase +, https://docs.python.org/3/library/doctest. html [+ doctest +], https://www.jetbrains.com/help/pycharm/tox-support.html [+ tox +] und https://twistedmatrix.com/trac/wiki/TwistedTrial [` + Versuch + `]. Sie können beispielsweise "+ pytest +" für Ihr Projekt folgendermaßen aktivieren:

In diesem Beispiel verwenden wir den Standardtestläufer "+ unittest +".

Erstellen Sie im selben Projekt eine Datei mit dem Namen "+ calculator.py " und fügen Sie die folgende Klasse " Calculator +" ein:

Mit PyCharm können Sie ganz einfach Tests für Ihren vorhandenen Code erstellen. Führen Sie bei geöffneter Datei + calculator.py + eine der folgenden Aktionen aus:

Wählen Sie "Neuen Test erstellen …​" und Sie sehen das folgende Fenster:

Belassen Sie die Standardeinstellungen von Target-Verzeichnis, Test-Dateiname und Test-Klassenname. Wählen Sie beide Methoden aus und klicken Sie auf OK. Voila! PyCharm hat automatisch eine Datei mit dem Namen "+ test_calculator.py +" erstellt und die folgenden Stub-Tests für Sie erstellt:

Führen Sie die Tests mit einer der folgenden Methoden aus:

Das Testfenster wird unten geöffnet, wenn alle Tests fehlschlagen:

Beachten Sie, dass Sie die Hierarchie der Testergebnisse links und die Ausgabe des Terminals rechts haben.

Implementieren Sie nun + test_add +, indem Sie den Code wie folgt ändern:

Führen Sie die Tests erneut aus, und Sie werden sehen, dass ein Test bestanden und der andere fehlgeschlagen ist. Entdecken Sie die Optionen, um bestandene Tests anzuzeigen, ignorierte Tests anzuzeigen, Tests alphabetisch zu sortieren und Tests nach Dauer zu sortieren:

Beachten Sie, dass die im obigen GIF gezeigte Methode "+ sleep (0.1) +" absichtlich verwendet wird, um einen der Tests zu verlangsamen, damit die Sortierung nach Dauer funktioniert.

Diese Einzeldateiprojekte eignen sich hervorragend für Beispiele, aber Sie arbeiten häufig über einen längeren Zeitraum an viel größeren Projekten. In diesem Abschnitt sehen Sie, wie PyCharm mit einem größeren Projekt funktioniert.

Um die projektbezogenen Funktionen von PyCharm zu erkunden, verwenden Sie das Alcazar-Webframework, das für Lernzwecke erstellt wurde. Um weiter zu folgen, klonen Sie das Repo lokal:

Wenn Sie ein Projekt lokal haben, öffnen Sie es in PyCharm mit einer der folgenden Methoden:

Suchen Sie nach einem dieser Schritte den Ordner mit dem Projekt auf Ihrem Computer und öffnen Sie ihn.

Wenn dieses Projekt eine virtual environment enthält, verwendet PyCharm diese virtuelle Umgebung automatisch und macht sie zum Projektinterpreter.

Wenn Sie ein anderes + virtualenv + konfigurieren müssen, öffnen Sie Preferences auf dem Mac, indem Sie [.keys] #Cmd +, # oder Settings unter Windows oder Linux drücken, indem Sie [.keys] # Ctrl + Alt + S # drücken, und suchen Sie das Project : Abschnitt ProjectName. Öffnen Sie die Dropdown-Liste und wählen Sie Project Interpreter:

Wählen Sie "+ virtualenv +" aus der Dropdown-Liste. Wenn es nicht vorhanden ist, klicken Sie auf die Schaltfläche "Einstellungen" rechts neben der Dropdown-Liste und wählen Sie "Hinzufügen …​". Der Rest der Schritte sollte derselbe sein wie bei der Verknüpfung: # Schreiben von Code in Pycharm [Erstellen eines neuen Projekts].

In einem großen Projekt, in dem es für eine einzelne Person schwierig ist, sich daran zu erinnern, wo sich alles befindet, ist es sehr wichtig, schnell navigieren und finden zu können, wonach Sie suchen. PyCharm hat Sie auch hier behandelt. Verwenden Sie das Projekt, das Sie im obigen Abschnitt geöffnet haben, um diese Verknüpfungen zu üben:

Die folgenden Verknüpfungen für die Navigation können viel Zeit sparen:

Weitere Informationen finden Sie in der offizielle Dokumentation.

Versionskontrollsysteme wie Git und Mercurial sind einige der wichtigsten Tools in der modernen Softwareentwicklungswelt. Daher ist es für eine IDE wichtig, sie zu unterstützen. PyCharm macht das sehr gut, indem es sich in viele beliebte VC-Systeme wie Git (und Github), Mercurial, https://www.perforce.com/solutions/version-control [integriert Perforce] und Subversion.

In PyCharm finden Sie fast alles, was Sie für die Entwicklung benötigen. Wenn Sie dies nicht können, gibt es höchstwahrscheinlich ein plugin, das PyCharm die Funktionen hinzufügt, die Sie benötigen. Zum Beispiel können sie:

Beispielsweise fügt IdeaVim PyCharm die Vim-Emulation hinzu. Wenn Sie Vim mögen, kann dies eine ziemlich gute Kombination sein.

Material Theme UI ändert das Erscheinungsbild von PyCharm in ein Material Design-Erscheinungsbild:

Vue.js bietet Unterstützung für Vue.js -Projekte. Markdown bietet die Möglichkeit, Markdown-Dateien in der IDE zu bearbeiten und den gerenderten HTML-Code in einer Live-Vorschau anzuzeigen. Sie können alle verfügbaren Plugins finden und installieren, indem Sie auf der Registerkarte Marketplace zu Preferences → Plugins unter Mac oder Settings → Plugins unter Windows oder Linux gehen:

Wenn Sie nicht finden, was Sie brauchen, können Sie sogar http://www.jetbrains.org/intellij/sdk/docs/basics.html [Ihr eigenes Plugin entwickeln].

Wenn Sie nicht das richtige Plugin finden und kein eigenes entwickeln möchten, weil PyPI bereits ein Paket enthält, können Sie es PyCharm als externes Tool hinzufügen. Nehmen Sie als Beispiel + Flake8 +, den Code-Analysator.

Installieren Sie zuerst + flake8 + in Ihrer virtuellen Umgebung mit + pip install flake8 + in der Terminal-App Ihrer Wahl. Sie können auch die in PyCharm integrierte verwenden:

Gehen Sie dann zu Preferences → Tools unter Mac oder Settings → Tools unter Windows/Linux und wählen Sie dann External Tools. Klicken Sie dann unten auf die kleine Schaltfläche _ + _ (1). Fügen Sie im neuen Popup-Fenster die Details wie unten gezeigt ein und klicken Sie für beide Fenster auf OK:

Hier bezieht sich Program (2) auf die ausführbare Flake8-Datei, die sich im Ordner /bin Ihrer virtuellen Umgebung befindet. Arguments (3) bezieht sich darauf, welche Datei Sie mit Hilfe von Flake8 analysieren möchten. Arbeitsverzeichnis ist das Verzeichnis Ihres Projekts.

Sie könnten die absoluten Pfade für alles hier fest codieren, aber das würde bedeuten, dass Sie dieses externe Tool nicht in anderen Projekten verwenden könnten. Sie können es nur innerhalb eines Projekts für eine Datei verwenden.

Sie müssen also etwas namens Macros verwenden. Makros sind im Grunde genommen Variablen im Format "+ $ name $ ", die sich je nach Kontext ändern. Zum Beispiel ist " $ FileName $ " " first.py ", wenn Sie " first.py " bearbeiten, und " second.py ", wenn Sie " second.py +" bearbeiten. Sie können ihre Liste anzeigen und eine von ihnen einfügen, indem Sie auf die Schaltflächen _Makro einfügen… _ klicken. Da Sie hier Makros verwendet haben, ändern sich die Werte je nach dem Projekt, an dem Sie gerade arbeiten, und Flake8 erledigt seine Aufgabe weiterhin ordnungsgemäß.

Um es zu verwenden, erstellen Sie eine Datei + example.py + und fügen Sie den folgenden Code ein:

Es verstößt absichtlich gegen einige der Flake8-Regeln. Klicken Sie mit der rechten Maustaste auf den Hintergrund dieser Datei. Wählen Sie External Tools und dann Flake8. Voilà! Die Ausgabe der Flake8-Analyse wird unten angezeigt:

Um es noch besser zu machen, können Sie eine Verknüpfung dafür hinzufügen. Gehen Sie zu Preferences auf dem Mac oder zu Settings unter Windows oder Linux. Gehen Sie dann zu Keymap → Externe Tools → Externe Tools. Doppelklicken Sie auf Flake8 und wählen Sie Add Keyboard Shortcut. Sie sehen dieses Fenster:

Im obigen Bild lautet die Verknüpfung für dieses Werkzeug [.keys] # Strg + Alt + A #. Fügen Sie Ihre bevorzugte Verknüpfung in das Textfeld ein und klicken Sie für beide Fenster auf OK. Jetzt können Sie diese Verknüpfung verwenden, um die Datei zu analysieren, an der Sie gerade mit Flake8 arbeiten.

PyCharm Professional ist eine kostenpflichtige Version von PyCharm mit mehr sofort einsatzbereiten Funktionen und Integrationen. In diesem Abschnitt erhalten Sie hauptsächlich eine Übersicht über die Hauptfunktionen und Links zur offiziellen Dokumentation, in der die einzelnen Funktionen ausführlich erläutert werden. Denken Sie daran, dass in der Community-Edition keine der folgenden Funktionen verfügbar ist.