Python print sys path

Check and add the module search path with sys.path in Python

In Python, the module search path is a list of directories that are searched when importing modules and packages using import . This search path is stored in sys.path .

This article describes how to check the current module search paths and add new ones.

See the following article for basic usage of import .

Check the module search path with sys.path

The current module search path is stored in sys.path .

sys.path is a list of strings specifying the module search path. You can view these paths using print() .

In this example, pprint is used to make it easier to read.

import sys import pprint pprint.pprint(sys.path) 

The output should look similar to this:

pwd # /Users/mbp/Documents/my-project/python-snippets/notebook python3 print_sys_path.py # ['/Users/mbp/Documents/my-project/python-snippets/notebook', # '/Users/mbp/Documents/lib', # '/Users/mbp/Documents/my-project/python-snippets/notebook', # '/usr/local/Cellar/python/3.7.0/Frameworks/Python.framework/Versions/3.7/lib/python37.zip', # '/usr/local/Cellar/python/3.7.0/Frameworks/Python.framework/Versions/3.7/lib/python3.7', # '/usr/local/Cellar/python/3.7.0/Frameworks/Python.framework/Versions/3.7/lib/python3.7/lib-dynload', # '/usr/local/lib/python3.7/site-packages'] 

Keep in mind that the result will depend on your environment. In the example environment with Python3 installed by Homebrew on a Mac, the following directories are stored in sys.path .

1. The directory containing the executed script file ( .py )
2. The directory set by the environment variable PYTHONPATH (more on this later)
3. The current working directory
4. Three directories for the standard library
5. The site-packages directory for third-party libraries installed with pip

If you change your current directory in the terminal and execute the script again, 3. current directory will be updated to this new path.

cd .. pwd # /Users/mbp/Documents/my-project/python-snippets python3 notebook/print_sys_path.py # ['/Users/mbp/Documents/my-project/python-snippets/notebook', # '/Users/mbp/Documents/lib', # '/Users/mbp/Documents/my-project/python-snippets', # '/usr/local/Cellar/python/3.7.0/Frameworks/Python.framework/Versions/3.7/lib/python37.zip', # '/usr/local/Cellar/python/3.7.0/Frameworks/Python.framework/Versions/3.7/lib/python3.7', # '/usr/local/Cellar/python/3.7.0/Frameworks/Python.framework/Versions/3.7/lib/python3.7/lib-dynload', # '/usr/local/lib/python3.7/site-packages'] 

Since the module search path changes depending on the current directory, the import may fail depending on where the script file is executed.

Modules are searched in the order listed in sys.path . Thus, modules in the directory of the currently executed script file ( .py ) are searched first. Be aware that if there is a file with the same name as a standard library in the same directory as the executed script file, Python will import that file instead.

Add new module search path with sys.path.append()

Since sys.path is essentially a list, you can easily add new paths. In this example, the append() method is used, but you can also use the insert() method or other list methods.

After adding a path to sys.path , you can import modules from the added path.

For example, if you want to add a directory one level above the script file, you can do it like this:

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

Remember, adding to sys.path will only affect the current session. If you want to permanently add paths, you can use PYTHONPATH or .pth files, as explained below.

Add new module search path with PYTHONPATH

You can use the environment variable PYTHONPATH to permanently add a module search path.

For Unix-like OS, including Mac, add the following line to ~/.bashrc , for example. To specify multiple paths, separate them with a colon : .

export PYTHONPATH="/path/to/add:$PYTHONPATH" 

For Windows, you can add PYTHONPATH to your environment variables in the same way you would add any other variable: right-click on your PC (My Computer) -> System -> System Properties -> Environment Variables. In Windows, separate multiple paths with a semicolon ; .

In the above example, the directory ‘/Users/mbp/Documents/lib’ is added to the PYTHONPATH .

Add new module search path with path configuration file ( .pth )

You can also add module search paths by creating a path configuration file ( .pth ) in the site-packages directory.

The path configuration file ( .pth ) should contain one path per line. These paths can be relative or absolute. You can also include comments with # . The file can be named anything as long as the extension is .pth .

Источник

Разбираем модуль sys

Модуль sys предоставляет системе особые параметры и функции. В данном разделе мы рассмотрим следующее:

• sys.argv
• sys.executable
• sys.exit
• sys.modules
• sys.path
• sys.platform
• sys.stdin/stdout/stderr

sys.argv

Значение sys.argv – это список аргументов командной строки, которые причастны к скрипту Python. Первый аргумент, argv[0], имеет аналогичное скрипту Python наименование. В зависимости от платформы, на которой вы работаете, первый аргумент может содержать полный путь к скрипту или к названию файла. Для дополнительных деталей обратитесь к документации. А тем временем, попробуем поработать с парочкой примеров, чтобы познакомиться с этим инструментом:

Если вы запустите это в интерпретаторе, вы получите список с пустой строкой. Давайте создадим файл под названием sysargv.py, со следующим содержимым:

Теперь запустите код в IDLE. Вы увидите список с одним элементом, который содержит путь к вашему скрипту. Попробуем передать скрипту несколько аргументов. Откройте окно терминала \ консоли и при помощи команды cd измените каталоги на тот, в котором находится скрипт. После этого, запустите что-то наподобие этого:

Обратите внимание на то, что будет выведено на экран:

Первый аргумент – это название файла нашего скрипта. Следующие два аргумента в списке – это те, что мы передали нашему скрипту в командной строке.

sys.executable

Значение sys.executable – это полный путь к интерпретатору Python. Это очень полезно, когда вы используете чей-то компьютер, и вам нужно узнать, где установлен Python. В некоторых системах, данная команда не сработает, и выдаст пустую строку с надписью None. Посмотрим, как пользоваться этой функцией:

sys.exit

Данная функция позволяет разработчику выйти из Python. Функция exit принимает необязательный аргумент, обычно целое число, которое дает статус выхода. Ноль считается как успешное завершение. Обязательно проверьте, имеет ли ваша операционная система какие-либо особые значения для своих статусов выхода, чтобы вы могли следить за ними в своем собственном приложении. Обратите внимание на то, что когда вы вызываете exit, это вызовет исключение SystemExit, которое позволяет функциям очистки работать в конечных пунктах блоков try / except. Давайте взглянем на то, как вызывается данная функция:

Запустив данный код в IDLE, вы увидите возникшую ошибку SystemExit. Давайте создадим несколько скриптов для теста. Для начала вам нужно создать основной скрипт, программу, которая будет вызывать другой скрипт Python. Давайте назовем его “call_exit.py”. Скрипт должен содержать следующее:

Теперь создайте скрипт Python под названием“exit.py” и сохраните его в той же папке. Вставьте в него следующий код:

Теперь давайте запустим его:

Как вы могли заметить, написанный нами скрипт exit вернул ноль, так что он успешно заработал. Получается, мы заодно научились вызывать разные скрипты Python изнутри самого Python!

Есть вопросы по Python?

На нашем форуме вы можете задать любой вопрос и получить ответ от всего нашего сообщества!

Telegram Чат & Канал

Вступите в наш дружный чат по Python и начните общение с единомышленниками! Станьте частью большого сообщества!

Одно из самых больших сообществ по Python в социальной сети ВК. Видео уроки и книги для вас!

sys.path

Значение функции path модуля sys – это список строк, которые указывают путь поиска для модулей. Как правило, данная функция указывает Python, в каких локациях смотреть, когда он пытается импортировать модуль. В соответствии с документацией Python, sys.path инициализируется из переменной окружения PYTHONPATH, плюс зависимое от установки значение, указанное по умолчанию. Давайте взглянем на пример:

Данная функция может быть весьма полезной во время отладки причины, по которой модуль не импортируется. Вы также можете изменить путь. Так как данная функция является путем, мы можем добавлять или удалять путь из неё. Давайте взглянем на то, как добавлять путь:

Удаление пути я оставлю как задание для читателя

sys.platform

Значение sys.platform – идентификатор платформы. Вы можете использовать sys.platform чтобы добавлять модули к sys.path, импортировать разные модули, в зависимости от платформы, или запускать разные части кода. Давайте взглянем:

В данном примере мы видим, что Python работает в Windows. Вот пример того, как мы можем воспользоваться данной информацией:

Данный код показывает способы проверки того, используем ли мы определенную операционную систему. Если мы используем Windows, мы получим определенную информацию из реестра Windows, при помощи модуля Python под названием _winreg. Если мы используем Linux, мы можем выполнить команду ls, чтобы получить информацию о каталоге, в котором мы находимся.

sys.stdin / stdout / stderr

Stdin, stdout и stderr сопоставляются с файловыми объектами, которые соответствуют стандартным входам, выходам и потокам ошибок интерпретатора соответственно. Функция stdin используется для всех входов, используемых интерпретатором, за исключением скриптов, тогда как stdout используется для выходов операторов print и expression. Главная причина, по которой я акцентирую на этом внимание, заключается в том, что в какой-то момент вам нужно будет перенаправить stdout или stderr, или обе функции к файлу, такому как log, либо же какой-либо дисплей в пользовательском графическом интерфейсе, созданным вами. Вы также можете перенаправить stdin, но с такими случаями я практически не сталкивался.

Подведем итоги

Существует много других значений и методов в модуле sys. Обратитесь к документации Python, а именно к секции 27.1, если вам нужно углубиться в данный вопрос. Мы многому научились из данной статьи, поздравляю. Теперь вы знаете, как выйти из программы Python, как получить информацию о платформе, работать с аргументами, переданными командной строке, и многому другому.

Являюсь администратором нескольких порталов по обучению языков программирования Python, Golang и Kotlin. В составе небольшой команды единомышленников, мы занимаемся популяризацией языков программирования на русскоязычную аудиторию. Большая часть статей была адаптирована нами на русский язык и распространяется бесплатно.

E-mail: vasile.buldumac@ati.utm.md

Образование
Universitatea Tehnică a Moldovei (utm.md)

• 2014 — 2018 Технический Университет Молдовы, ИТ-Инженер. Тема дипломной работы «Автоматизация покупки и продажи криптовалюты используя технический анализ»
• 2018 — 2020 Технический Университет Молдовы, Магистр, Магистерская диссертация «Идентификация человека в киберпространстве по фотографии лица»

Источник