PEP8 – l'importation n'est pas au top de fichier sys.chemin

Problème

PEP8 a une règle à propos de mettre les importations en haut d'un fichier:

Les importations sont toujours placé au début du fichier, juste après n'importe quel module, les commentaires et les docstrings, et avant de module globals et constantes.

Toutefois, dans certains cas, j'aimerais faire quelque chose comme:

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

import my_module

Dans ce cas, le pep8 utilitaire de ligne de commande de drapeaux mon code:

E402 module niveau de l'importation n'est pas au top de fichier

Quelle est la meilleure façon d'atteindre PEP8 conformité avec sys.path modifications?

Pourquoi

J'ai ce code parce que je suis en suivant les la structure du projet donné dans Le Routard de Python.

Qui guide suggère que j'ai un my_module dossier, distincte d'une tests dossier, les deux sont dans le même répertoire. Si je veux accéder à my_module de tests, je pense que j'ai besoin d'ajouter .. à la sys.path

Pourquoi ne pas vous écrire un setup.py et installer my_module pour les essais?
Parce que c'est un peu moins pratique. Je suppose que j'ai pu mais je préfère ne pas.
Pour qui? Si jamais vous voulez l'utiliser réellement ce projet partout où il est, et de loin, la façon la plus simple de l'obtenir vers le haut et en cours d'exécution.
pour moi. Ce n'est plus un projet personnel pour mon utilisation. Je vais certainement utiliser que si pas d'autres réponses à venir.
Si vous n'êtes pas le partage, pourquoi s'inquiéter à propos de la suite de la PEP-8 de si près?
À partir de PEP8: "Toutefois, de savoir quand être incohérent, parfois style guide de recommandations ne sont pas applicables. En cas de doute, utilisez votre meilleur jugement.". Il ya des moments où vous devez casser PEP8 de la conformité, et c'est OK.
C'est une bonne habitude à prendre pour l'avenir, les choses que je vais partager. (Je vois votre point bien que, dans ce cas je peux utiliser setup.py). Je vais garder cela à l'esprit.

InformationsquelleAutor Luke Taylor | 2016-04-24

40

Souvent, j'ai plusieurs fichiers avec des tests dans un sous-répertoire foo/tests de mon projet, alors que les modules que je suis en essais sont en foo/src. Pour exécuter les tests de foo/tests sans erreurs d'import-je créer un fichier foo/tests/pathmagic.py qui ressemble à ceci;
```
"""Path hack to make tests work."""

import os
import sys

bp = os.path.dirname(os.path.realpath('.')).split(os.sep)
modpath = os.sep.join(bp + ['src'])
sys.path.insert(0, modpath)
```
Dans chaque fichier de test, j'utilise ensuite
```
import pathmagic  # noqa
```
comme la première importation. Le "noqa" commentaire empêche pycodestyle/pep8 de se plaindre d'un solde non utilisé de l'importation.
- C'est cool, mais c'est toujours avoir "importées mais non utilisés [F401]" problème.
- Je suppose que la création d'une fonction factice dans cette pathmagic module et de l'appeler à partir du module de test permettrait de résoudre ce problème mais je souhaite qu'il y avait quelque chose de plus propre...
- Gardez à l'esprit que pycodestyle/pep8 avertissements sont consultatif plutôt que d'erreurs de syntaxe ou d'exceptions. Vous pouvez choisir de les ignorer. J'ai mis à jour ma réponse par l'ajout d'un "noqa" commentaire après l'importation.
InformationsquelleAutor Roland Smith
57

Si il y a juste quelques importations, vous pouvez simplement ignorer PEP8 sur ces import lignes:
```
import sys
sys.path.insert("..", 0)
import my_module  # noqa: E402
```
- Cela m'a aidé à obtenir mon build par CI, merci!
- Je préfère être plus explicite, en précisant l'violé la règle comme # noqa: E402 par exemple. (source)
- en effet! Édité réponse pour ajouter la règle.
InformationsquelleAutor astorga
9

Il y a une autre solution.
```
import sys
... all your other imports...

sys.path.insert("..", 0)
try:
    import my_module
except:
    raise
```
- Je crois fermement que cela ne fonctionnera pas. La raison d'être, il peut y avoir certains modules importés en vertu de l' "... toutes vos importations ...", ce qui pourrait exiger PYTHONPATH être défini en premier.
- l'idée est de mettre toutes les importations qui nécessite PYTHONPATH à l'intérieur de try corps et tout le reste (qui ne dépend pas d'elle) ci-dessus.
InformationsquelleAutor Peuchele
3

J'ai juste eu du mal avec une question similaire, et je crois que j'ai trouvé un peu plus agréable à la solution que l'on a accepté la réponse.

Créer un pathmagic module qui fait tout le sys.chemin de la manipulation, mais de faire le changement au sein d'un gestionnaire de contexte:
```
"""Path hack to make tests work."""

import os
import sys

class context:
    def __enter__(self):
        bp = os.path.dirname(os.path.realpath('.')).split(os.sep)
        modpath = os.sep.join(bp + ['src'])
        sys.path.insert(0, modpath)

    def __exit__(self, *args):
        pass
```
Ensuite, dans vos fichiers de test (ou partout où vous avez besoin de cela), vous n':
```
import pathmagic

with pathmagic.context():
    import my_module
    # ...
```
De cette façon, vous n'obtenez pas de plaintes de flake8/pycodestyle, vous n'avez pas besoin de commentaire particulier, et la structure semble avoir du sens.

Pour plus de propreté, d'envisager effectivement revenir le chemin d'accès dans la __exit__ bloc, mais cela peut causer des problèmes avec lazy importations (si vous installez le module de code en dehors du contexte), alors peut-être n'en vaut pas la peine.

MODIFIER: Juste vu un beaucoup plus simple astuce, un réponse à une autre question: ajouter assert pathmagic sous votre importations pour éviter la noqa commentaire.
- Tout cela a vraiment accompli est de se débarrasser de l'autre pour les commentaires particuliers au détriment de l'nécessitant l'utilisation d'un gestionnaire de contexte—un peu nébuleux compromis à mon avis. Comme pour le nettoyage dans le __exit__ bloc, pour vraiment le faire correctement aurait besoin de retirer l'ajout du chemin d'accès (si ça existe toujours) parce que la restauration de l'ensemble de la valeur précédente de ce qu'il était lorsque le contexte était entré serait également annuler toutes les autres modifications qui pourraient avoir été apportées par d'autres (code exécuté dans le même contexte) pour quelque raison.
- en effet, c'est une question de goût. J'ai peut-être un peu biaisé par rapport à des commentaires spécifiques, parce que mon code actuel de la base contient un peu trop de commentaires pour la myriade de les outils d'analyse statique et les éditeurs que les différentes équipes de l'aide. Également d'accord sur votre deuxième point.
- Problématique si pathmagic.context() peut être appelé un nombre arbitraire de fois (par exemple, si l'exécution de tous les tests). Le retour est problématique, trop: à l'importation, à un moment ultérieur (par exemple, faite à la demande) peut échouer.
InformationsquelleAutor itsadok

Avez-vous déjà essayer ce qui suit:

import sys
from importlib import import_module

sys.path.insert("..", 0)

# import module
my_mod = import_module('my_module')

# get method or function from my_mod
my_method = getattr(my_mod , 'my_method')

InformationsquelleAutor Daniel Lee

2

Pour se conformer à la pep8, vous devez inclure votre projet chemin vers le python path afin d'effectuer relatif /absolu des importations.

Pour ce faire, vous pouvez jeter un oeil à cette réponse: En permanence à ajouter un répertoire de PYTHONPATH
- Je ne veux pas faire ce répertoire accessible dans le monde entier à tous mes scripts Python, car cela peut provoquer des conflits.
- Vous pouvez utiliser le docs.python.org/3/library/pkgutil.html forfait pour utiliser des espaces de noms. Si vous pensez que votre solution est la meilleure, vous n'êtes pas dans l'obligation de suivre la pep8. Pep8 est seulement des conseils et des meilleures pratiques, ce qui ne signifie pas que vous devez suivre toutes les règles, à chaque fois, partout.
- PEP 8 dit insensé de cohérence est le lutin de petits esprits.
InformationsquelleAutor Pierre Barre

Vous devez vous connecter pour publier un commentaire.