Frère paquet importations

Fatigué sur sys.chemin des hacks?

Il y a beaucoup de sys.path.append -hacks disponibles, mais j'ai trouvé une autre façon de résoudre le problème en main: Le setuptools. Je ne suis pas sûr si il y a des cas limites, qui ne fonctionnent pas bien avec cela. Ce qui suit est testé avec Python 3.6.5, (Anaconda, conda 4.5.1), Windows 10 de la machine.

---

Installation

Le point de départ est la structure du fichier que vous avez fournis, enveloppé dans un dossier appelé myproject.

.
└── myproject
    ├── api
    │   ├── api_key.py
    │   ├── api.py
    │   └── __init__.py
    ├── examples
    │   ├── example_one.py
    │   ├── example_two.py
    │   └── __init__.py
    ├── LICENCE.md
    ├── README.md
    └── tests
        ├── __init__.py
        └── test_one.py

Je vais appeler la . le dossier racine, et dans mon cas par exemple, il est situé à C:\tmp\test_imports\.

api.py

Comme un cas de test, nous allons utiliser la suite ./api/api.py

def function_from_api():
    return 'I am the return value from api.api!'

test_one.py

from api.api import function_from_api

def test_function():
    print(function_from_api())

if __name__ == '__main__':
    test_function()

Essayez d'exécuter test_one:

PS C:\tmp\test_imports> python .\myproject\tests\test_one.py
Traceback (most recent call last):
  File ".\myproject\tests\test_one.py", line 1, in <module>
    from api.api import function_from_api
ModuleNotFoundError: No module named 'api'

Également essayer relative des importations coutume de travail:

À l'aide de from ..api.api import function_from_api entraînerait

PS C:\tmp\test_imports> python .\myproject\tests\test_one.py
Traceback (most recent call last):
  File ".\tests\test_one.py", line 1, in <module>
    from ..api.api import function_from_api
ValueError: attempted relative import beyond top-level package

---

Étapes

1) Faire une setup.py le fichier à la racine du répertoire de niveau

Le contenu de la setup.py serait*

from setuptools import setup, find_packages

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

2) l'Utilisation d'un environnement virtuel

Si vous êtes familier avec les environnements virtuels, activer une, et passez à l'étape suivante. L'utilisation d'environnements virtuels ne sont pas absolument nécessaires, mais ils vraiment vous aider dans le long terme (si vous avez plus de 1 projet en cours..). La plupart des étapes de base sont (exécuter dans le dossier racine)

• Créer virtuel env
  • python -m venv venv
• Activer virtuel env
  • source ./venv/bin/activate (Linux, macOS) ou ./venv/Scripts/activate (Win)

Pour en savoir plus à ce sujet, juste Google "à" python virtuel env tutoriel" ou similaire. Vous n'avez probablement jamais besoin de toutes les autres commandes de la création, de l'activation et de la désactivation.

Une fois que vous avez fait et activé un environnement virtuel, votre console devrait donner le nom de l'environnement virtuel dans la parenthèse

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

et votre arborescence de dossiers devrait ressembler à ceci**

.
├── myproject
│   ├── api
│   │   ├── api_key.py
│   │   ├── api.py
│   │   └── __init__.py
│   ├── examples
│   │   ├── example_one.py
│   │   ├── example_two.py
│   │   └── __init__.py
│   ├── LICENCE.md
│   ├── README.md
│   └── tests
│       ├── __init__.py
│       └── test_one.py
├── setup.py
└── venv
    ├── Include
    ├── Lib
    ├── pyvenv.cfg
    └── Scripts [87 entries exceeds filelimit, not opening dir]

3) pip install votre projet modifiable état

L'installation de votre haut niveau, myproject à l'aide de pip. L'astuce est d'utiliser le -e drapeau lors de l'installation. De cette manière, il est installé modifiable dans un état, et toutes les modifications apportées à l' .py fichiers seront automatiquement inclus dans le paquet installé.

Dans le répertoire de racine, exécutez

pip install -e . (notez le point, il est synonyme de "répertoire courant")

Vous pouvez aussi voir qu'il s'est installé à l'aide de 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

4) Ajouter myproject. dans votre importations

Noter que vous devrez ajouter myproject. seulement dans les importations qui ne serait pas travailler autrement. Les importations qui ont travaillé sans setup.py & pip install fonctionnera fonctionnent encore correctement. Voir un exemple ci-dessous.

---

Tester la solution

Maintenant, nous allons tester la solution à l'aide de api.py défini ci-dessus, et test_one.py défini ci-dessous.

test_one.py

from myproject.api.api import function_from_api

def test_function():
    print(function_from_api())

if __name__ == '__main__':
    test_function()

exécution du test

(venv) PS C:\tmp\test_imports> python .\myproject\tests\test_one.py
I am the return value from api.api!

---

* Voir le setuptools docs pour plus de commentaires setup.py des exemples.

** En réalité, vous pourriez mettre votre environnement virtuel n'importe où sur votre disque dur.

Vous n'avez pas besoin et ne devrait pas hack sys.path sauf s'il est nécessaire et dans ce cas, il ne l'est pas. Utilisation:

import api.api_key # in tests, examples

Exécuter à partir du répertoire du projet: python -m tests.test_one.

Vous devriez probablement se déplacer à tests (si ils sont de l'api de unittests) à l'intérieur de api et exécuter python -m api.test pour exécuter tous les tests (en supposant qu'il est __main__.py) ou python -m api.test.test_one pour exécuter test_one à la place.

Vous pouvez également supprimer __init__.py de examples (il n'est pas un paquet Python) et d'exécuter les exemples dans un virtualenv où api est installé, par exemple, pip install -e . dans un virtualenv et de l'installer en place api paquet si vous avez bonne setup.py.

Pour les frères et sœurs paquet importations, vous pouvez utiliser le insérer ou la ajouter méthode de la [sys.chemin d'accès][2] module:

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

Ce fonctionne si vous êtes le lancement de vos scripts comme suit:

python examples/example_one.py
python tests/test_one.py

D'autre part, vous pouvez aussi utiliser le relatif à l'importation:

if __name__ == '__main__' and if __package__ is not None:
    import ..api.api

Dans ce cas, vous devez lancer votre script avec la '-m' argument (notez que, dans ce cas, vous ne devez pas donner l' '.py' extension):

python -m packageName.examples.example_one
python -m packageName.tests.test_one

Bien sûr, vous pouvez mélanger les deux approches, de sorte que votre script fonctionne, peu importe comment il s'appelle:

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

J'ai fait un projet d'exemple pour montrer comment j'ai traité ce, qui est en effet un autre sys.chemin de hack comme indiqué ci-dessus. Python Frère Exemple D'Importation, qui s'appuie sur:

if __name__ == '__main__':
import os
import sys
sys.path.append(os.getcwd())

Cela semble être assez efficace, aussi longtemps que votre répertoire de travail reste à la racine du projet Python. Si quelqu'un se déploie ce dans un environnement de production réel ce serait formidable d'entendre si ça fonctionne aussi bien.

Juste au cas où quelqu'un en utilisant Pydev sur Eclipse fin ici: vous pouvez ajouter le frère de la mère de chemin d'accès (et donc de l'appel du module parent) comme une bibliothèque externe dossier à l'aide de Projet->Propriétés et réglage Bibliothèques Externes sous le menu de gauche Pydev-PYTHONPATH. Ensuite, vous pouvez importer à partir de votre frère ou votre sœur, e. g. from sibling import some_class.