Як правильно визначити поточний каталог скриптів?

Я хотів би побачити, який найкращий спосіб визначити поточний каталог скриптів у python?

Я виявив, що через безліч способів виклику коду python важко знайти хороше рішення.

Ось деякі проблеми:

• __file__не визначено, якщо сценарій виконується за допомогою exec,execfile
• __module__ визначається лише в модулях

Користувачі:

• ./myfile.py
• python myfile.py
• ./somedir/myfile.py
• python somedir/myfile.py
• execfile('myfile.py') (з іншого сценарію, який може бути розташований в іншому каталозі і може мати інший поточний каталог.

Я знаю, що ідеального рішення немає, але я шукаю найкращий підхід, який вирішує більшість випадків.

Найбільш використовуваний підхід, os.path.dirname(os.path.abspath(__file__))але це дійсно не працює, якщо ви виконуєте сценарій з іншого exec().

Увага

Будь-яке рішення, яке використовує поточний каталог, вийде з ладу, це може відрізнятися залежно від способу виклику сценарію або його можна змінити всередині запущеного сценарію.

os.path.dirname(os.path.abspath(__file__))

справді найкраще, що ти збираєшся отримати.

Незвично виконувати сценарій з exec/ execfile; як правило, ви повинні використовувати інфраструктуру модуля для завантаження скриптів. Якщо вам потрібно скористатися цими методами, я пропоную встановити __file__в globalsпереході до сценарію, щоб він міг прочитати це ім'я файлу.

Немає іншого способу отримати ім'я файлу в execed коді: як зазначаєте, CWD може знаходитися в зовсім іншому місці.

Якщо ви дійсно хочете висвітлити випадок, через який викликається скрипт execfile(...), ви можете використовувати inspectмодуль для виведення імені файлу (включаючи шлях). Наскільки мені відомо, це буде працювати у всіх перелічених вами випадках:

filename = inspect.getframeinfo(inspect.currentframe()).filename
path = os.path.dirname(os.path.abspath(filename))

#!/usr/bin/env python
import inspect
import os
import sys

def get_script_dir(follow_symlinks=True):
    if getattr(sys, 'frozen', False): # py2exe, PyInstaller, cx_Freeze
        path = os.path.abspath(sys.executable)
    else:
        path = inspect.getabsfile(get_script_dir)
    if follow_symlinks:
        path = os.path.realpath(path)
    return os.path.dirname(path)

print(get_script_dir())

Він працює на CPython, Jython, Pypy. Він працює, якщо сценарій виконується за допомогою execfile()( sys.argv[0]і __file__рішення, засновані на базі, тут не зможуть). Він працює, якщо скрипт знаходиться у виконуваному zip-файлі (/ яйце) . Він працює, якщо сценарій "імпортується" ( PYTHONPATH=/path/to/library.zip python -mscript_to_run) з zip-файлу; він повертає архівний шлях у цьому випадку. Він працює, якщо сценарій компілюється в окремий виконуваний файл ( sys.frozen). Він працює для посилань ( realpathвиключає символічні посилання). Він працює в інтерактивному перекладачі; він повертає поточний робочий каталог у цьому випадку.

У Python 3.4+ ви можете скористатися більш простим pathlibмодулем:

from inspect import currentframe, getframeinfo
from pathlib import Path

filename = getframeinfo(currentframe()).filename
parent = Path(filename).resolve().parent

Цей os.path...підхід був «зробленою справою» в Python 2.

У Python 3 ви можете знайти каталог скриптів наступним чином:

from pathlib import Path
cwd = Path(__file__).parents[0]

Просто використовуйте os.path.dirname(os.path.abspath(__file__))та дуже уважно вивчайте, чи є реальна потреба у випадку, коли execвін використовується. Це може бути ознакою проблемного дизайну, якщо ви не зможете використовувати свій скрипт як модуль.

Майте на увазі Zen of Python # 8 , і якщо ви вважаєте, що є хороший аргумент для використання, коли він повинен працювати exec, то, будь ласка, повідомте нам детальніше про основу проблеми.

Би

import os
cwd = os.getcwd()

роби що хочеш? Я не впевнений, що саме ви маєте на увазі під "поточним каталогом скриптів". Який очікуваний результат буде для випадків використання, які ви дали?

По-перше, тут відсутня пара випадків використання, якщо ми говоримо про способи введення анонімного коду ..

code.compile_command()
code.interact()
imp.load_compiled()
imp.load_dynamic()
imp.load_module()
__builtin__.compile()
loading C compiled shared objects? example: _socket?)

Але справжнє питання полягає у тому, яка ваша мета - чи намагаєтесь ви застосувати якесь забезпечення? Або вас просто цікавить, що завантажується.

Якщо ви зацікавлені в безпеці , ім'я файлу, яке імпортується через exec / execfile, є несуттєвим - слід використовувати rexec , який пропонує наступне:

Цей модуль містить клас RExec, який підтримує r_eval (), r_execfile (), r_exec () та r_import (), які є обмеженими версіями стандартних функцій Python eval (), execfile () та операторами exec та імпорту. Код, виконаний у цьому обмеженому середовищі, матиме доступ лише до модулів та функцій, які вважаються безпечними; Ви можете підклас RExec додавати або видаляти можливості за бажанням.

Однак, якщо це більше академічне заняття .. ось кілька підступних підходів, які ви, можливо, зможете копати трохи глибше ..

Приклади сценаріїв:

./deep.py

print ' >> level 1'
execfile('deeper.py')
print ' << level 1'

./deeper.py

print '\t >> level 2'
exec("import sys; sys.path.append('/tmp'); import deepest")
print '\t << level 2'

/tmp/deepest.py

print '\t\t >> level 3'
print '\t\t\t I can see the earths core.'
print '\t\t << level 3'

./codespy.py

import sys, os

def overseer(frame, event, arg):
    print "loaded(%s)" % os.path.abspath(frame.f_code.co_filename)

sys.settrace(overseer)
execfile("deep.py")
sys.exit(0)

Вихідні дані

loaded(/Users/synthesizerpatel/deep.py)
>> level 1
loaded(/Users/synthesizerpatel/deeper.py)
    >> level 2
loaded(/Users/synthesizerpatel/<string>)
loaded(/tmp/deepest.py)
        >> level 3
            I can see the earths core.
        << level 3
    << level 2
<< level 1

Звичайно, це ресурсомісткий спосіб зробити це, ви б відстежили весь свій код .. Не дуже ефективно. Але я думаю, що це новий підхід, оскільки він продовжує працювати, навіть коли заглиблюєшся в гніздо. Ви не можете змінити "eval". Хоча ви можете замінити execfile ().

Зауважте, цей підхід охоплює лише exec / execfile, а не "імпорт". Для підключення навантаження на модуль вищого рівня, можливо, ви зможете використовувати sys.path_hooks (Ввічливість з PyMOTW).

Це все, що у мене з голови.

Ось часткове рішення, все ще краще, ніж усі опубліковані досі.

import sys, os, os.path, inspect

#os.chdir("..")

if '__file__' not in locals():
    __file__ = inspect.getframeinfo(inspect.currentframe())[0]

print os.path.dirname(os.path.abspath(__file__))

Тепер це працює для всіх дзвінків, але якщо хтось використовує chdir()для зміни поточного каталогу, це також не вдасться.

Примітки:

• sys.argv[0]не працює, повернеться, -cякщо виконати сценарій за допомогоюpython -c "execfile('path-tester.py')"
• Я опублікував повний тест на https://gist.github.com/1385555, і ви можете покращити його.

Це повинно працювати в більшості випадків:

import os,sys
dirname=os.path.dirname(os.path.realpath(sys.argv[0]))

Сподіваємось, це допомагає: - Якщо ви запускаєте скрипт / модуль з будь-якого місця, ви зможете отримати доступ до __file__змінної, яка є змінною модуля, що представляє розташування сценарію.

З іншого боку, якщо ви використовуєте інтерпретатор, ви не маєте доступу до цієї змінної, де ви отримаєте ім’я NameErrorта os.getcwd()надасте вам неправильну директорію, якщо ви запускаєте файл з іншого місця.

Це рішення має дати вам те, що ви шукаєте у всіх випадках:

from inspect import getsourcefile
from os.path import abspath
abspath(getsourcefile(lambda:0))

Я не ретельно перевірив це, але це вирішило мою проблему.