Python: meilleur moyen d'ajouter à sys.path par rapport au script en cours d'exécution

J'ai un répertoire plein de scripts (disons project/bin). J'ai également une bibliothèque située dans project/libet je souhaite que les scripts la chargent automatiquement. C'est ce que j'utilise normalement en haut de chaque script:

#!/usr/bin/python
from os.path import dirname, realpath, sep, pardir
import sys
sys.path.append(dirname(realpath(__file__)) + sep + pardir + sep + "lib")

# ... now the real code
import mylib

C'est un peu encombrant, moche et doit être collé au début de chaque fichier. Y a-t-il une meilleure manière de faire cela?

Ce que j'espère vraiment, c'est quelque chose d'aussi simple que ceci:

#!/usr/bin/python
import sys.path
from os.path import pardir, sep
sys.path.append_relative(pardir + sep + "lib")

import mylib

Ou encore mieux, quelque chose qui ne casserait pas lorsque mon éditeur (ou quelqu'un d'autre qui a un accès de validation) décide de réorganiser les importations dans le cadre de son processus de nettoyage:

#!/usr/bin/python --relpath_append ../lib
import mylib

Cela ne porterait pas directement sur des plates-formes non-posix, mais cela garderait les choses propres.

Si vous ne souhaitez pas modifier chaque fichier

• Installez votre bibliothèque comme une bibliothèque Python normale
  ou
• Réglez PYTHONPATHvotrelib

ou si vous souhaitez ajouter une seule ligne à chaque fichier, ajoutez une instruction d'importation en haut, par exemple

import import_my_lib

garder import_my_lib.pydans le bac et import_my_libpeut correctement définir le chemin python sur ce que libvous voulez

C'est ce que j'utilise:

import os, sys
sys.path.append(os.path.join(os.path.dirname(__file__), "lib"))

J'utilise:

import sys,os
sys.path.append(os.getcwd())

Créez un module wrapper project/bin/lib, qui contient ceci:

import sys, os

sys.path.insert(0, os.path.join(
    os.path.dirname(os.path.dirname(os.path.realpath(__file__))), 'lib'))

import mylib

del sys.path[0], sys, os

Ensuite, vous pouvez remplacer tout ce qui se trouve en haut de vos scripts par:

#!/usr/bin/python
from lib import mylib

Si vous ne souhaitez en aucun cas modifier le contenu du script, ajoutez le répertoire de travail actuel .à $ PYTHONPATH (voir l'exemple ci-dessous)

PYTHONPATH=.:$PYTHONPATH alembic revision --autogenerate -m "First revision"

Et appelez ça un jour!

Utilisation de python 3.4+ Interdiction de
_{l'utilisation de cx_freeze ou utilisation en IDLE. 😃}

import sys
from pathlib import Path

sys.path.append(Path(__file__).parent / "lib")

Vous pouvez exécuter le script à python -mpartir du répertoire racine approprié. Et passez le "chemin des modules" comme argument.

Exemple: $ python -m module.sub_module.main # Notice there is no '.py' at the end.

Un autre exemple:

$ tree  # Given this file structure
.
├── bar
│   ├── __init__.py
│   └── mod.py
└── foo
    ├── __init__.py
    └── main.py

$ cat foo/main.py
from bar.mod import print1
print1()

$ cat bar/mod.py
def print1():
    print('In bar/mod.py')

$ python foo/main.py  # This gives an error
Traceback (most recent call last):
  File "foo/main.py", line 1, in <module>
    from bar.mod import print1
ImportError: No module named bar.mod

$ python -m foo.main  # But this succeeds
In bar/mod.py

Il y a un problème avec chaque réponse fournie qui peut être résumé comme "ajoutez simplement cette incantation magique au début de votre script. Voyez ce que vous pouvez faire avec juste une ligne ou deux de code." Ils ne fonctionneront pas dans toutes les situations possibles!

Par exemple, une telle incantation magique utilise le fichier . Malheureusement, si vous empaquetez votre script avec cx_Freeze ou si vous utilisez IDLE, cela entraînera une exception.

Une autre incantation magique de ce type utilise os.getcwd (). Cela ne fonctionnera que si vous exécutez votre script à partir de l'invite de commande et que le répertoire contenant votre script est le répertoire de travail actuel (c'est-à-dire que vous avez utilisé la commande cd pour accéder au répertoire avant d'exécuter le script). Eh dieux! J'espère que je n'ai pas à expliquer pourquoi cela ne fonctionnera pas si votre script Python est quelque part dans le PATH et que vous l'avez exécuté en tapant simplement le nom de votre fichier de script.

Heureusement, il existe une incantation magique qui fonctionnera dans tous les cas que j'ai testés. Malheureusement, l'incantation magique est plus qu'une simple ligne ou deux de code.

import inspect
import os
import sys

# Add script directory to sys.path.
# This is complicated due to the fact that __file__ is not always defined.

def GetScriptDirectory():
    if hasattr(GetScriptDirectory, "dir"):
        return GetScriptDirectory.dir
    module_path = ""
    try:
        # The easy way. Just use __file__.
        # Unfortunately, __file__ is not available when cx_freeze is used or in IDLE.
        module_path = __file__
    except NameError:
        if len(sys.argv) > 0 and len(sys.argv[0]) > 0 and os.path.isabs(sys.argv[0]):
            module_path = sys.argv[0]
        else:
            module_path = os.path.abspath(inspect.getfile(GetScriptDirectory))
            if not os.path.exists(module_path):
                # If cx_freeze is used the value of the module_path variable at this point is in the following format.
                # {PathToExeFile}\{NameOfPythonSourceFile}. This makes it necessary to strip off the file name to get the correct
                # path.
                module_path = os.path.dirname(module_path)
    GetScriptDirectory.dir = os.path.dirname(module_path)
    return GetScriptDirectory.dir

sys.path.append(os.path.join(GetScriptDirectory(), "lib"))
print(GetScriptDirectory())
print(sys.path)

Comme vous pouvez le voir, ce n'est pas une tâche facile!

Celui-ci fonctionne le mieux pour moi. Utilisation:

os.path.abspath('')

Sur mac, il devrait imprimer quelque chose comme:

'/Users/<your username>/<path_to_where_you_at>'

Pour obtenir le chemin abs vers le wd actuel, celui-ci est meilleur car maintenant vous pouvez monter si vous le souhaitez, comme ceci:

os.path.abspath('../')

Et maintenant:

 '/Users/<your username>/'

Donc, si vous voulez importer à utilspartir d'ici, '/Users/<your username>/'
il ne vous reste plus qu'à:

import sys
sys.path.append(os.path.abspath('../'))

Je vois un shebang dans votre exemple. Si vous exécutez vos scripts bin en tant que ./bin/foo.py, plutôt que python ./bin/foo.py, il y a une option d'utiliser le shebang pour changer la $PYTHONPATHvariable.

Cependant, vous ne pouvez pas modifier les variables d'environnement directement dans shebangs, vous aurez donc besoin d'un petit script d'aide. Mettez ceci python.shdans votre bindossier:

#!/usr/bin/env bash
export PYTHONPATH=$PWD/lib
exec "/usr/bin/python" "$@"

Et puis changez le shebang de votre ./bin/foo.pyêtre#!bin/python.sh

Lorsque nous essayons d'exécuter un fichier python avec le chemin du terminal.

import sys
#For file name
file_name=sys.argv[0]
#For first argument
dir= sys.argv[1]
print("File Name: {}, argument dir: {}".format(file_name, dir)

Enregistrez le fichier (test.py).

Système de fonctionnement.

Ouvrez le terminal et accédez au répertoire où se trouve le fichier de sauvegarde. puis écrire

python test.py "/home/saiful/Desktop/bird.jpg"

Appuyez sur Entrée

Production:

File Name: test, Argument dir: /home/saiful/Desktop/bird.jpg

J'utilise:

from site import addsitedir

Ensuite, peut utiliser n'importe quel répertoire relatif! addsitedir('..\lib') ; les deux points impliquent de déplacer (vers le haut) un répertoire en premier.

N'oubliez pas que tout dépend de votre répertoire de travail actuel. Si C: \ Joe \ Jen \ Becky, alors ajouteitedir ('.. \ lib') importe dans votre chemin C: \ Joe \ Jen \ lib

C:\
  |__Joe
      |_ Jen
      |     |_ Becky
      |_ lib