Comment réparer «Tentative d'importation relative dans un non-package» même avec __init__.py

J'essaie de suivre PEP 328 , avec la structure de répertoires suivante:

pkg/
  __init__.py
  components/
    core.py
    __init__.py
  tests/
    core_test.py
    __init__.py

Dans core_test.pyJ'ai la déclaration d'importation suivante

from ..components.core import GameLoopEvents

Cependant, lorsque je cours, j'obtiens l'erreur suivante:

tests$ python core_test.py 
Traceback (most recent call last):
  File "core_test.py", line 3, in <module>
    from ..components.core import GameLoopEvents
ValueError: Attempted relative import in non-package

En cherchant, j'ai trouvé "le chemin relatif ne fonctionnait même pas avec __init__.py " et " Importer un module à partir d'un chemin relatif " mais ils n'ont pas aidé.

Y a-t-il quelque chose qui me manque ici?

Oui. Vous ne l'utilisez pas en tant que package.

python -m pkg.tests.core_test

Pour développer la réponse d' Ignacio Vazquez-Abrams :

Le mécanisme d'importation Python fonctionne par rapport à celui __name__du fichier actuel. Lorsque vous exécutez un fichier directement, il n'a pas son nom habituel, mais a "__main__"plutôt son nom. Les importations relatives ne fonctionnent donc pas.

Vous pouvez, comme l'a suggéré Igancio, l'exécuter en utilisant l' -moption. Si vous avez une partie de votre package qui doit être exécutée en tant que script, vous pouvez également utiliser l' __package__attribut pour indiquer à ce fichier le nom qu'il est censé avoir dans la hiérarchie des packages.

Voir http://www.python.org/dev/peps/pep-0366/ pour plus de détails.

Vous pouvez utiliser import components.coredirectement si vous ajoutez le répertoire actuel à sys.path:

if __name__ == '__main__' and __package__ is None:
    from os import sys, path
    sys.path.append(path.dirname(path.dirname(path.abspath(__file__))))

Cela dépend de la façon dont vous souhaitez lancer votre script.

Si vous souhaitez lancer votre UnitTest à partir de la ligne de commande de manière classique, c'est:

python tests/core_test.py

Ensuite, comme dans ce cas, les «composants» et les «tests» sont des dossiers de frères et sœurs, vous pouvez importer le module relatif en utilisant l' insertion ou la méthode d' ajout du module sys.path . Quelque chose comme:

import sys
from os import path
sys.path.append( path.dirname( path.dirname( path.abspath(__file__) ) ) )
from components.core import GameLoopEvents

Sinon, vous pouvez lancer votre script avec l'argument '-m' (notez que dans ce cas, nous parlons d'un paquet, et donc vous ne devez pas donner l' extension '.py' ), c'est-à-dire:

python -m pkg.tests.core_test

Dans un tel cas, vous pouvez simplement utiliser l'importation relative comme vous le faisiez:

from ..components.core import GameLoopEvents

Vous pouvez enfin mélanger les deux approches, afin que votre script fonctionne quel que soit son nom. Par exemple:

if __name__ == '__main__':
    if __package__ is None:
        import sys
        from os import path
        sys.path.append( path.dirname( path.dirname( path.abspath(__file__) ) ) )
        from components.core import GameLoopEvents
    else:
        from ..components.core import GameLoopEvents

Dans core_test.py, procédez comme suit:

import sys
sys.path.append('../components')
from core import GameLoopEvents

Si votre cas d'utilisation est destiné à l'exécution de tests et qu'il semble que c'est le cas, vous pouvez effectuer les opérations suivantes. Au lieu d'exécuter votre script de test, python core_test.pyutilisez un framework de test tel que pytest. Ensuite, sur la ligne de commande, vous pouvez entrer

$$ py.test

Cela exécutera les tests dans votre répertoire. Cela permet de contourner le problème de l' __name__être __main__qui a été souligné par @BrenBarn. Ensuite, placez un __init__.pyfichier vide dans votre répertoire de test, cela fera du répertoire de test une partie de votre package. Ensuite, vous pourrez faire

from ..components.core import GameLoopEvents

Cependant, si vous exécutez votre script de test en tant que programme principal, les choses échoueront à nouveau. Il suffit donc d'utiliser le lanceur de test. Peut-être que cela fonctionne également avec d'autres coureurs de test tels que nosetestsmais je ne l'ai pas vérifié. J'espère que cela t'aides.

Ma solution rapide consiste à ajouter le répertoire au chemin:

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

Le problème vient de votre méthode de test,

tu as essayé python core_test.py

alors vous obtiendrez cette erreur ValueError: tentative d'importation relative dans un non-package

Raison: vous testez votre emballage à partir d'une source hors emballage.

testez donc votre module à partir de la source du package.

s'il s'agit de la structure de votre projet,

pkg/
  __init__.py
  components/
    core.py
    __init__.py
  tests/
    core_test.py
    __init__.py

cd pkg

python -m tests.core_test # dont use .py

ou de l'extérieur pkg /

python -m pkg.tests.core_test

unique .si vous souhaitez importer à partir du dossier dans le même répertoire. pour chaque pas en arrière, ajoutez un de plus.

hi/
  hello.py
how.py

dans how.py

from .hi import hello

incase si vous voulez importer comment de hello.py

from .. import how

Vieux fil. J'ai découvert que l'ajout d'un __all__= ['submodule', ...]au fichier __init__.py , puis l'utilisation de from <CURRENT_MODULE> import *dans la cible fonctionne correctement .

Vous pouvez utiliser from pkg.components.core import GameLoopEvents, par exemple, j'utilise pycharm, l'image ci-dessous est la structure de mon projet, je viens d'importer à partir du package racine, puis cela fonctionne:

Comme l'a dit Paolo , nous avons 2 méthodes d'invocation:

1) python -m tests.core_test
2) python tests/core_test.py

Une différence entre eux est la chaîne sys.path [0]. Puisque l'interprète recherchera sys.path lors de l'importation , nous pouvons faire avec tests/core_test.py:

if __name__ == '__main__':
    import sys
    from pathlib import Path
    sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
    from components import core
    <other stuff>

Et plus après cela, nous pouvons exécuter core_test.py avec d'autres méthodes:

cd tests
python core_test.py
python -m core_test
...

Remarque, py36 testé uniquement.

Cette approche a fonctionné pour moi et est moins encombrée que certaines solutions:

try:
  from ..components.core import GameLoopEvents
except ValueError:
  from components.core import GameLoopEvents

Le répertoire parent est dans mon PYTHONPATH, et il y a des __init__.pyfichiers dans le répertoire parent et ce répertoire.

Ce qui précède a toujours fonctionné en python 2, mais python 3 a parfois frappé une ImportError ou ModuleNotFoundError (ce dernier est nouveau en python 3.6 et une sous-classe d'ImportError), donc le réglage suivant fonctionne pour moi dans les deux python 2 et 3:

try:
  from ..components.core import GameLoopEvents
except ( ValueError, ImportError):
  from components.core import GameLoopEvents

Essaye ça

import components
from components import *

Si quelqu'un cherche une solution de contournement, je suis tombé sur un. Voici un peu de contexte. Je voulais tester l'une des méthodes que j'ai dans un fichier. Quand je l'exécute de l'intérieur

if __name__ == "__main__":

il se plaignait toujours des importations relatives. J'ai essayé d'appliquer les solutions ci-dessus, mais j'ai échoué, car il y avait de nombreux fichiers imbriqués, chacun avec plusieurs importations.

Voici ce que j'ai fait. Je viens de créer un lanceur, un programme externe qui importerait les méthodes nécessaires et les appellerait. Bien que ce ne soit pas une excellente solution, cela fonctionne.

Voici une façon qui va énerver tout le monde mais qui fonctionne plutôt bien. Dans les tests exécutés:

ln -s ../components components

Il vous suffit ensuite d'importer des composants comme vous le feriez normalement.

C'est très déroutant, et si vous utilisez IDE comme pycharm, c'est un peu plus déroutant. Ce qui a fonctionné pour moi: 1. Définissez les paramètres du projet pycharm (si vous exécutez python à partir d'un VE ou d'un répertoire python) 2. Il n'y a pas de mal à la façon dont vous avez défini. parfois, il fonctionne avec la classe d'importation de folder1.file1

si cela ne fonctionne pas, utilisez import folder1.file1 3. Votre variable d'environnement doit être correctement mentionnée dans le système ou fournissez-la dans votre argument de ligne de commande.

Parce que votre code contient if __name__ == "__main__", qui n'est pas importé en tant que package, vous feriez mieux de l'utiliser sys.path.append()pour résoudre le problème.