Wie verbinde ich PyCharm mit einem Python-Interpreter in einem Docker-Container?

UPDATE: PyCharm 2017.1 hat eine Lösung für dieses problem finden Sie in diesem Blogeintrag

Hier ist, wie ich das problem gelöst. Meine Umstände sind, dass ich zugewiesen wurde, um eine intervention auf einen bestimmten Bereich einer web-app, die verwendet docker-verfassen-erstellen Sie eine Gruppe von vier Behältern. Docker-Komponieren ist eine Art meta-Andockfenster, die Verwaltung mehrerer docker-Container von einem Befehl. Ich wollte nicht zu zerfleischen, Ihre bestehenden setup, da sich so viele Dinge davon abhängen. Aber da war ich arbeiten auf einem bestimmten Teil in einem der Bilder, habe ich beschlossen, dass ich verlängern würde einen der Behälter mit ssh und so konnte ich Debuggen von PyCharm. Weiter wollte ich die app normal laufen, wenn Sie gestartet werden und nur durch zwingen, es zu beenden und dann die Verbindung zu es von PyCharm hätte ich eine debug-Version einer Komponente. Hier ist, was ich habe auf meinem mac verwendet boot2docker (auf VirtualBox), um das setup-Andockfenster richtig.

Zuerst habe ich verlängern müssen, die Ziel-container, genannt jqworker. Bin ich dabei zu verwenden "supervisior" zu tun, die schwere Arbeit der Verwaltung in Sachen.

FROM jqworker

# Get supervisor to control multiple processes, sshd to allow connections.
# And supervisor-stdout allows us to send the output to the main docker output.
RUN apt-get update && apt-get install -y supervisor openssh-server python-pip \
  && pip install supervisor-stdout \
  && mkdir -p /var/run/sshd  \
  && mkdir -p /var/log/supervisor \
  && mkdir -p /etc/supervisor/conf.d

COPY ./supervisord.conf /etc/supervisor/conf.d/supervisord.conf

# Fix up SSH, probably should rip this out in real deploy situations.
RUN echo 'root:soup4nuts' | chpasswd
RUN sed -i 's/PermitRootLogin without-password/PermitRootLogin yes/' /etc/ssh/sshd_config

# SSH login fix. Otherwise user is kicked off after login
RUN sed 's@session\s*required\s*pam_loginuid.so@session optional pam_loginuid.so@g' -i /etc/pam.d/sshd
ENV NOTVISIBLE "in users profile"
RUN echo "export VISIBLE=now" >> /etc/profile

# Expose SSH on 22, but this gets mapped to some other address.
EXPOSE 22

# Replace old entrypoint with supervisiord, starts both sshd and worker.py
ENTRYPOINT ["/usr/bin/supervisord"]

Supervisor ermöglicht es mir, führen Sie mehrere Aufgaben von einem Befehl, in diesem Fall den ursprünglichen Befehl und SSHD. Ja, jeder sagt, dass die SSHD im Andockfenster böse und Behälter sollten dies und das und bla bla, aber die Programmierung ist über die Lösung von Problemen, die nicht gemäß beliebige Aussagen, ignorieren Kontext. Wir brauchen SSH-code zu Debuggen und nicht die Bereitstellung dieser zu dem Feld, das ist ein Grund, warum wir erweitern den vorhandenen container anstatt diese in den deployment-Struktur. Bei mir läuft es lokal, so dass ich Debuggen kann der code im Kontext.

Hier ist der supervisord.conf-Datei, Hinweis, dass ich mit dem supervisor-stdout-Paket zur direkten Ausgabe an den Betreuer anstelle der Protokollierung der Daten, da sehe ich lieber alles an einem Ort:

[supervisord]
nodaemon=true

[program:sshd]
command=/usr/sbin/sshd -D

[program:worker]
command=python /opt/applications/myproject/worker.py -A args
directory=/opt/applications/myproject
stdout_events_enabled=true
stderr_events_enabled=true

[eventlistener:stdout]
command = supervisor_stdout
buffer_size = 100
events = PROCESS_LOG
result_handler = supervisor_stdout:event_handler

Habe ich ein build-Verzeichnis, in dem die beiden oben genannten Dateien, und vom terminal, dort Baue ich die Dockerfile mit:

docker build -t fgkrqworker .

Dieser fügt es so, dass ich es aufrufen docker oder docker-compose. Überspringen Sie nicht den Punkt am Ende!

Da die app verwendet docker-compose eine Reihe von Containern, die bestehenden WORKER container werden ersetzt durch eine, die meine Probleme löst. Aber zunächst möchte ich zeigen, dass in einem anderen Teil meines docker-compose.yml ich definieren ein mapping von den Containern auf meiner lokalen Festplatte, dies ist eine eine Reihe von Volumen zugeordnet wird:

volumes: &VOLUMES
  ? /Users/me/source/myproject:/opt/applications/myproject

Dann die eigentliche definition für meine container, der auf die oben VOLUMES:

jqworker: &WORKER
  image: fgkrqworker
  privileged: true
  stdin_open: true
  detach: true
  tty: true
  volumes:
    <<: *VOLUMES
  ports:
    - "7722:22"

Diese Karten den SSH-port auf einen bekannten port in der VM, daran erinnern, dass ich bin mit boot2docker die Fahrten auf der VirtualBox, aber das muss abgebildet werden, zu denen PyCharm es bekommen können. In der VirtualBox öffnen Sie die boot2docker VM und wählen Sie Adapter 1. Manchmal ist die "an:" - combo hebt die Auswahl selbst, also achten Sie auf, dass. In meinem Fall sollte es NAT ausgewählt.

Klicken Sie auf "Port-Weiterleitung" und ordnen Sie den inneren Hafen, der einen port auf localhost, wähle ich den gleichen port verwenden. Es sollte so etwas wie, Name: ssh_mapped; Protokoll: TCP; Host-IP:127.0.0.1; Host Port:7722; Gast-IP:; Gast-Port: 7722. Hinweis: seien Sie vorsichtig, nicht zu ändern, die boot2docker " ssh " - Einstellung, oder Sie werden schließlich nicht in der Lage zu starten Sie die VM richtig.

So, in diesem Punkt haben wir einen container, erstreckt sich mein Ziel-container. Es läuft ssh auf port 22 und ordnet Sie 7722 da andere Behälter verwenden könnte, 22, und ist sichtbar in der VirtualBox-Umgebung. VirtualBox Karten 7722, 7722, um die localhost, und Sie können ssh in den Behälter mit:

ssh root@localhost -p 7722

Die dann prompt für das Passwort "soup4nuts', und Sie sollten in der Lage sein, suchen Sie etwas bestimmtes für Ihre container, um zu überprüfen, dass es richtig ist und dass alles funktioniert OK. Ich würde nicht Durcheinander mit root, wenn ich die Bereitstellung dieses irgendwo, aber meine lokale Maschine, also sei gewarnt. Dies ist nur für die Fehlersuche vor Ort und Sie denken sollten, zweimal oder dreimal über das tun dies auf einer live-site.

Zu diesem Zeitpunkt können Sie wahrscheinlich herausfinden der rest es aus, wenn Sie verwendet haben, PyCharm ist das remote-debugging. Aber hier ist, wie ich es einrichten:

Erste, daran erinnern, dass ich docker-compose.yml Zuordnung der Projekt-Verzeichnis:

? /Users/me/source/myproject:/opt/applications/myproject 

In meinem container /opt/applications/myproject ist eigentlich /Users/me/source/myproject auf meiner lokalen Festplatte. Also, das ist die root von meinem Projekt. Meine PyCharm sieht das Verzeichnis wie die Projekt-root, und ich möchte PyCharm zu schreiben, die .pycharm_helpers hier, so dass es weiterhin zwischen den Sitzungen. Ich bin die Verwaltung von source-code auf der mac-Seite der Dinge, aber PyCharm denkt, es ist ein unixy box anderswo. Ja, es ist ein bisschen Durcheinander, bis JetBrains beinhaltet ein Andockfenster Lösung.

Zuerst gehen Sie auf die Project X/Projekt-Struktur und erstellen ein Content-Root von der lokalen Zuordnung, in meinem Fall heißt /Users/me/source/myproject

Später, kommen Sie zurück und fügen Sie .pycharm_helpers den ausgegrenzten gesetzt, das wollen wir nicht, um am Ende in die source-control oder verwirren PyCharm.

Gehen um die zu Bauen, Ausführung, Registerkarte "Bereitstellung" pick-Bereitstellung und erstellen Sie eine neue Implementierung von SFTP-Typ. Der host ist localhost, der port 7722, der root-Pfad ist /opt/applications/myproject und der Benutzername ist root und Passwort ist soup4nuts und ich habe die option, um das Passwort zu speichern. Ich nannte meinen Bereitstellung 'dockercompose", so dass ich in der Lage sein zu Holen es später.

Auf die Bereitstellung von Mappings habe ich den lokalen Pfad zu /Users/me/source/myproject - und Weitergabe und web-Pfad zu einer einzelnen '/', aber da mein code nicht entsprechen, eine URL und ich glaube nicht, verwenden Sie diese zu Debuggen, es ist ein Platzhalter in die Web-Pfad-Einstellung. Ich weiß nicht, wie Sie könnte Ihnen.

Auf dem Project X/Projekt-Interpreter Registerkarte, erstellen Sie eine neue Remote-Python-Interpreter. Sie können wählen Sie die Deployment-Konfiguration und wählen Sie die "dockercompose' Konfiguration, die wir weiter oben erstellt haben. Die host-URL sollten füllen Sie als 'ssh://root@localhost:7722" und der Python-Interpreter-Pfad wird wahrscheinlich /usr/bin/python. Wir müssen die PyCharm Helfer Pfad als Standard wird nicht überleben, der container wird erneuert. Ich ging auf mein Projekt lokale Verzeichnis und erstellt eine .pycharm_helpers Verzeichnis in der Wurzel, dann den Pfad hier als /opt/applications/myproject/.pycharm_helpers und wenn ich drücken Sie die OK-Taste, es kopiert die Dateien "bis" zu dem Verzeichnis. Ich weiß nicht, ob Sie es schaffen wird, es automatisch ist oder nicht.

Vergessen Sie nicht, dass die .pycharm_helpers Verzeichnis sollte wohl ausgeschlossen werden auf der Projekt-Wurzeln tab.

An dieser Stelle können Sie gehen, um den Bau, Ausführung, Registerkarte Bereitstellung, und unter Konsole/Python-Konsole, wählen Sie die remote-interpreter, die wir weiter oben erstellt haben, und legen Sie das Arbeitsverzeichnis auf /opt/applications/myproject und starten Sie Ihre Python-Konsole im container, wenn Sie mögen.

Nun benötigen Sie eine Runtime-Konfiguration, so dass Sie Remote Debuggen von python-code. Stellen Sie eine neue Python-Konfiguration und legen Sie das Skript, um die eine, die verwendet, um starten Sie den python-code in den container. Mine, aus der supervisor-setup, oben:

/opt/applications/myproject/worker.py -A args

Also habe ich das Skript /opt/applications/myproject/worker.py und die Parameter zu -A args.

Wählen Sie die remote-interpreter, die wir weiter oben erstellt haben, und als Arbeitsverzeichnis benötigt, ist es für mich /opt/applications/myproject und für mich, dass der job nicht.

Nun ich will in meinem container und stoppen Sie die worker.py script, so kann ich starten Sie eine debug-version. Natürlich, wenn Sie möchten, können Sie ignorieren, läuft das Skript default und nur den container für die Fehlersuche.

Konnte ich öffnen Sie eine ssh-Sitzung beenden Sie das Skript, aber Andockfenster bietet einen nützlichen Befehl, der die Arbeit für mich, indem Sie es in die Umwelt.

$> docker exec -i -t supervisorctl stop worker

Als mein Prozess wird als 'Arbeiter'. Beachten Sie, dass Sie neu starten können, durch den Austausch der stop Befehl mit start.

Nun, in PyCharm starten Sie eine debug-Sitzung mit der Konfiguration Auszuführen, die oben erstellt. Es sollte die Verbindung und starten Sie die Dinge auf und geben Sie die Ausgabe der Konsole in das Fenster. Da wir töteten die, die Betreuung ursprünglich begonnen, es ist nicht mehr verbunden.

Diese war Sitz der Hose Betrieb, so kann es werden Fehler und falsche Annahmen, die ich nicht bemerkt haben. Besonders die PyCharm-setup benötigt ein paar Iterationen, so ist die Reihenfolge falsch sein können, versuchen, durch Sie gehen wieder, wenn es fehlschlägt. Das ist eine Menge Zeug und einfach zu überspringen etwas Kritischer.

InformationsquelleAutor der Antwort Fran K.

Um zu vermeiden, dass alle SSH-overhead (der absolut Sinn macht, mit Docker), docker exec jeden Fall scheint der Weg zu gehen.

Leider konnte ich es nicht zu funktionieren so weit. Es wäre toll, wenn jemand könnte in die Leerstellen zu füllen. Hier ist, was ich getan habe (mit PyCharm 4.0.4 und Andockfenster 1.4.1):

1. Erstellen Sie eine Datei namens python_myproject.sh mit den folgenden:

   #!/bin/bash
   docker exec -i myproject_container /path/to/containers/python2.7

   Beachten Sie, dass der name der Datei beginnt mit python sonst PyCharm beschweren.

2. In PyCharm Einstellungen, unter Project Interpreter fügen Sie einen neuen lokalen interpreter. Geben Sie den Pfad zu Ihrem python_myproject.sh Datei.

Dies ist, wo ich stecken geblieben bin. Nach einer Recht langen Ladezeit (die pulsierendes sagt "Einrichtung Bibliothek-Dateien"), ein Fenster mit dem Titel "Invalid Python-SDK" erscheint und sagt:

Nicht die Einrichtung eines python-SDK

at /path/to/python_myproject.sh.

Das SDK scheint ungültig.

In ~/.PyCharm40/system/log/.idea:

2015-02-19 17:33:30,569 [ 166966]   WARN - ution.process.OSProcessHandler - Cannot kill process tree. Trying to destroy process using Java API. Cmdline:
2015-02-19 17:34:30,628 [ 227025]   WARN - ution.process.OSProcessHandler - Cannot kill process tree. Trying to destroy process using Java API. Cmdline:
2015-02-19 17:34:30,653 [ 227050]   INFO - rains.python.sdk.PythonSdkType - 
Timed out

InformationsquelleAutor der Antwort Anto

Wenn alles, was Sie brauchen, ist zum Debuggen von code, die gestartet wird, innerhalb docker-container, den Sie verwenden konnten, pycharm ist python-debug-server Funktion. Für mich ist es weniger mühsam Weg als der Zugriff auf remote-interpreter via SSH. Nachteil dieser Lösung ist, dass für die auto-vervollständigen-und alle diese Art von Sachen, die Sie haben sollten lokale Kopie des Containers Dolmetscher und markieren Sie Sie als Projekt-interpreter (arbeitet für die auto-complete, aber ich bin mir nicht sicher, dass es möglich ist, den debug-code aus third-party-libs in diesem Fall) oder container-interpreter Dateien sichtbar zu pycharm (nicht getestet). Beachten Sie auch, dass Python-debug-server wird feature der Professional edition.

Was Sie tun sollten, für das Debuggen via Python-debug-server:

1) stellen Sie sicher, dass das Verzeichnis mit Ihrem Projekt Hinzugefügt wird in container. Es könnte so Aussehen wie diese Zeile im Dockerfile:

ADD . /path/in/container

2) kopieren pycharm-debug.egg (pycharm-debug-py3k.egg für Python ist3) aus dem Verzeichnis, wo pycharm ist installiert auf Ihrem host-zu-Verzeichnis im container, die in container PYTHONPATH.
Pfad zu pycharm-debug.ei-Entwickler für die Gastgeber sein könnte:

• für Mac: /Applications/PyCharm.app/Contents/pycharm-debug.egg
• für Linux: /opt/pycharm/pycharm-debug.egg

3) erstellen Sie Run/Debug-Konfiguration für das starten von Python-debug-server auf dem host, wie hier beschrieben To configure a remote debug server Abschnitt docs. Port ist eine beliebige host-port Ihrer Wahl, aber die IP ist die Adresse, unter der der host ist erreichbar von container. Es könnte sein,:

• , wenn der container laufen über boot2docker, wahrscheinlich, IP 192.168.99.1 -- host-Adresse Host-only-Netzwerk mit vbox Maschine
• , wenn der host ist Linux, IP kann gefunden werden über ifconfig ist es für mich:

docker0   Link encap:Ethernet  HWaddr 56:84:7a:fe:97:99  
          inet addr:172.17.42.1  Bcast:0.0.0.0  Mask:255.255.0.0

Auch, vergessen Sie nicht, geben Sie Pfad-mappings zwischen Projekt-Pfad im developer ' s host-und Projekt-Pfad im container.

Dieser blog-post könnte auch sein hilfreich für den aktuellen Schritt

4) starten Sie die erstellte Konfiguration (zum Beispiel über Debug - Taste, rechts von Run)

5) erstellen von python-Skripts, die starten Sie Ihr Projekt und fügen Sie folgenden code für debug-Initialisierung als erste Zeilen in diesem Skript. (stellen Sie sicher, dass pycharm-debug.egg im PYTHONPATH, oder dieser code konnte nicht import pydevd):

   import pydevd
   pydevd.settrace('172.17.42.1', suspend=False, port=8765, stdoutToServer=True, stderrToServer=True)

6) Schließlich könnten Sie Haltepunkte festlegen und starten Sie Ihre Anwendung vom host, in container per Skript erstellen. Zum Beispiel:

docker-compose run 'container_name' python 'script_name' 'args'

Auf start, Ihre Start-Skript wird eine Verbindung zu Python-debug-server, der läuft auf dem host und stoppen an Haltepunkten. Debugger-features wie gewohnt erreichbar.

InformationsquelleAutor der Antwort 3ka5_cat

Mit Docker 1.3, verwenden Sie die exec - Befehl zu konstruieren, der Pfad zu den Python-interpreter:

sudo docker exec container_name /usr/bin/python

Sehen https://docs.docker.com/reference/commandline/cli/#exec, http://forum.jetbrains.com/thread/PyCharm-2224

Könnten Sie SSH installieren in den Behälter und dann setzen Sie den port, aber das ist nicht, wie Container werden erwartet verwendet zu werden, denn wäre Sie Blähungen.

InformationsquelleAutor der Antwort dukebody

Können Sie ein bisschen verrückt durch die Installation von pycharm in den container und läuft von dort aus. Sie müssten dies tun, indem Sie "docker run-v /tmp/.X11-unix:/tmp/.X11-unix -e DISPLAY=:0.0 pycharm-image", aber es sollte gut funktionieren. Aber denken Sie daran, dass alle von pycharm und Ihre Quelle wäre in diesem Behälter auch. So save, commit und push) früh und Häufig.

InformationsquelleAutor der Antwort grim