Importieren von Modulen aus dem übergeordneten Ordner

Question 1

Ich verwende Python 2.5.

Das ist mein Ordnerbaum:

ptdraft/
  nib.py
  simulations/
    life/
      life.py

(Ich habe auch __init__.py in jedem Ordner, hier aus Gründen der Lesbarkeit weggelassen)

Wie importiere ich die nib Modul aus dem life Modul? Ich hoffe, dass es möglich ist, ohne Basteln mit sys.path auszukommen.

Hinweis: Das Hauptmodul, das ausgeführt wird, befindet sich in der ptdraft Mappe.

Question 2

Sie könnten relative Importe verwenden (python >= 2.5):

from ... import nib

(Was ist neu in Python 2.5) PEP 328: Absolute und relative Importe

BEARBEITEN: einen weiteren Punkt hinzugefügt ‘.’ um zwei Pakete nach oben zu gehen

Question 3

Relative Importe (wie in from .. import mymodule) funktionieren nur in einem Paket. So importieren Sie „mymodule“, das sich im übergeordneten Verzeichnis Ihres aktuellen Moduls befindet:

import os
import sys
import inspect

currentdir = os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))
parentdir = os.path.dirname(currentdir)
sys.path.insert(0, parentdir) 

import mymodule

bearbeiten: das __file__ Attribut ist nicht immer gegeben. Anstatt zu verwenden os.path.abspath(__file__) Ich habe jetzt vorgeschlagen, das inspect-Modul zu verwenden, um den Dateinamen (und den Pfad) der aktuellen Datei abzurufen

Question 4

Eine ähnliche Antwort habe ich auch auf die Frage zum Import aus Geschwisterpaketen gepostet. Sie können es hier sehen.

Lösung ohne `sys.path` hackt

Zusammenfassung

Wickeln Sie den Code in einen Ordner (z packaged_stuff)
Ein … kreieren setup.py Skript, in dem Sie setuptools.setup() verwenden.
Pip installiert das Paket im bearbeitbaren Zustand mit pip install -e <myproject_folder>

Importieren mit from packaged_stuff.modulename import function_name

Konfiguration

Ich gehe von der gleichen Ordnerstruktur wie in der Frage aus

.
└── ptdraft
    ├── __init__.py
    ├── nib.py
    └── simulations
        ├── __init__.py
        └── life
            ├── __init__.py
            └── life.py

Ich nenne die . den Stammordner, und in meinem Fall befindet es sich darin C:\tmp\test_imports.

Schritte

Füge hinzu ein setup.py in den Stammordner — Der Inhalt der setup.py kann einfach sein

    from setuptools import setup, find_packages

    setup(name="myproject", version='1.0', packages=find_packages())

Grundsätzlich “beliebig” setup.py würde funktionieren. Dies ist nur ein minimales Arbeitsbeispiel.

Verwenden Sie eine virtuelle Umgebung

Wenn Sie mit virtuellen Umgebungen vertraut sind, aktivieren Sie eine und fahren Sie mit dem nächsten Schritt fort. Nutzung virtueller Umgebungen nicht unbedingt erforderlich, aber sie werden Ja wirklich Ihnen auf lange Sicht helfen (wenn Sie mehr als 1 Projekt am Laufen haben …). Die grundlegendsten Schritte sind (im Stammordner ausführen)

Virtuelle Umgebung erstellen
- python -m venv venv

Virtuelle Umgebung aktivieren
- . venv/bin/activate (Linux) bzw ./venv/Scripts/activate (Gewinnen)
Virtuelle Umgebung deaktivieren
- deactivate (Linux)

Um mehr darüber zu erfahren, googeln Sie einfach “python virtualenv tutorial” oder ähnliches. Sie benötigen wahrscheinlich nie andere Befehle als das Erstellen, Aktivieren und Deaktivieren.

Nachdem Sie eine virtuelle Umgebung erstellt und aktiviert haben, sollte Ihre Konsole den Namen der virtuellen Umgebung in Klammern anzeigen

PS C:\tmp\test_imports> python -m venv venv
PS C:\tmp\test_imports> .\venv\Scripts\activate
(venv) PS C:\tmp\test_imports>

pip installieren Sie Ihr Projekt im bearbeitbaren Zustand

Installieren Sie Ihr Top-Level-Paket myproject verwenden pip. Der Trick besteht darin, die zu verwenden -e Flag bei der Installation. Auf diese Weise wird es in einem bearbeitbaren Zustand installiert, und alle an den .py-Dateien vorgenommenen Änderungen werden automatisch in das installierte Paket aufgenommen.

Führen Sie im Stammverzeichnis aus

pip install -e . (beachten Sie den Punkt, er steht für “aktuelles Verzeichnis”)

Sie können auch sehen, dass es installiert ist, indem Sie verwenden pip freeze

(venv) PS C:\tmp\test_imports> pip install -e .
Obtaining file:///C:/tmp/test_imports
Installing collected packages: myproject
  Running setup.py develop for myproject
Successfully installed myproject
(venv) PS C:\tmp\test_imports> pip freeze
myproject==1.0

Import durch Voranstellen mainfolder zu jedem Import

In diesem Beispiel ist die mainfolder wäre ptdraft. Dies hat den Vorteil, dass Sie nicht auf Namenskollisionen mit anderen Modulnamen (aus der Python-Standardbibliothek oder Modulen von Drittanbietern) stoßen.

Beispielnutzung

nib.py

def function_from_nib():
    print('I am the return value from function_from_nib!')

Leben.py

from ptdraft.nib import function_from_nib

if __name__ == '__main__':
    function_from_nib()

life.py ausführen

(venv) PS C:\tmp\test_imports> python .\ptdraft\simulations\life\life.py
I am the return value from function_from_nib!

Question 5

Es scheint, dass das Problem nicht damit zusammenhängt, dass sich das Modul in einem übergeordneten Verzeichnis oder ähnlichem befindet.

Sie müssen das Verzeichnis hinzufügen, das enthält ptdraft zu PYTHONPATH

Du hast das gesagt import nib mit Ihnen gearbeitet, das bedeutet wahrscheinlich, dass Sie hinzugefügt haben ptdraft selbst (nicht sein Elternteil) zu PYTHONPATH.

Question 6

Sie können den betriebssystemabhängigen Pfad im “Modulsuchpfad” verwenden, der in aufgeführt ist sys.Pfad . So können Sie ganz einfach ein übergeordnetes Verzeichnis wie folgt hinzufügen

import sys
sys.path.insert(0,'..')

Wenn Sie ein Eltern-Eltern-Verzeichnis hinzufügen möchten,

sys.path.insert(0,'../..')

Dies funktioniert sowohl in Python 2 als auch in 3.

Question 7

Keine Ahnung von Python 2.
In Python 3 kann der übergeordnete Ordner wie folgt hinzugefügt werden:

import sys 
sys.path.append('..')

…und dann kann man daraus Module importieren

Question 8

Wenn das Hinzufügen Ihres Modulordners zum PYTHONPATH nicht funktioniert hat, können Sie die sys.Pfad Liste in Ihrem Programm, in der der Python-Interpreter nach den zu importierenden Modulen sucht, die Python-Dokumentation sagt:

Wenn ein Modul namens Spam importiert wird, sucht der Interpreter zunächst nach einem eingebauten Modul mit diesem Namen. Wenn es nicht gefunden wird, sucht es nach einer Datei mit dem Namen spam.py in einer Verzeichnisliste, die durch die Variable sys.path angegeben wird. sys.path wird von diesen Orten aus initialisiert:

das Verzeichnis, das das Eingabeskript enthält (oder das aktuelle Verzeichnis).

PYTHONPATH (eine Liste von Verzeichnisnamen mit derselben Syntax wie die Shell-Variable PATH).

die installationsabhängige Vorgabe.

Nach der Initialisierung können Python-Programme modifizieren sys.Pfad. Das Verzeichnis, das das ausgeführte Skript enthält, wird am Anfang des Suchpfads platziert, vor dem Standardbibliothekspfad. Dies bedeutet, dass Skripte in diesem Verzeichnis geladen werden anstelle von gleichnamigen Modulen im Bibliotheksverzeichnis. Dies ist ein Fehler, es sei denn, der Ersatz ist beabsichtigt.

Wenn Sie dies wissen, können Sie in Ihrem Programm Folgendes tun:

import sys
# Add the ptdraft folder path to the sys.path list
sys.path.append('/path/to/ptdraft/')

# Now you can import your module
from ptdraft import nib
# Or just
import ptdraft

Lösung ohne sys.path hackt