How to Use sys.argv in Python?
Python provides us with different ways to handle inputs while programming. One such way is to use command line arguments for inputs while executing a Python file. The command line arguments in a Python program are stored in the sys.argv list. In this article, we will discuss the sys.argv list in Python and its uses with an example.
What is sys.argv in Python?
The sys.argv variable represents the argument vectors of for a program. The sys.argv list is a list that contains command line arguments in a Python program. Here, sys represents the system and argv stands for argument vector. Whenever we run a Python program from a command line interface, we can pass different arguments to the program. The program stores all the arguments and the file name of the Python file in the sys.argv list.
- The first element of the sys argv list contains the name of the Python file.
- The second element onwards contains the command line arguments.
You can also find the total number of command line arguments to a program. For this, you can find the length of the sys.argv list using the len() function. The len() function takes the list as its input and returns the length of the sys argv list. The total number of arguments in a Python program is one less than the length of the sys.argv list.
If you are going to work with command line arguments with a Python program, you probably want to use the sys argv list in your program.
Sys.Argv List Example in Python
To use sys argv, you will first have to import the sys module. Then, you can obtain the name of the Python file and the value of the command line arguments using the sys argv list.
- The sys.argv list contains the name of the Python file at index 0.
- It contains the first command line argument at index 1.
- The second command line argument is present at index 2 and so on.
You can observe this in the following example.
import sys print("Hi, I am PFB") print("The sys.argv list is:",sys.argv) sys_argv_length=len(sys.argv) number_of_arguments=sys_argv_length-1 print("Total command line arguments are:",number_of_arguments)
In the above example, you can observe that we have created a program sysargv.py and executed it using the command prompt. You can observe that the sys.argv list contains only one element i.e. the name of the program file.
Now, let us change the program and add four command line arguments to the Python file while executing it.
import sys print("Hi, I am PFB") print("The sys.argv list is:",sys.argv) sys_argv_length=len(sys.argv) number_of_arguments=sys_argv_length-1 print("Total command line arguments are:",number_of_arguments) file_name=sys.argv[0] first_argument=sys.argv[1] second_argument=sys.argv[2] third_argument=sys.argv[3] fourth_argument=sys.argv[4] print("The filename is:",file_name) print("The first command line argument is:",first_argument) print("The second command line argument is:",second_argument) print("The third command line argument is:",third_argument) print("The fourth command line argument is:",fourth_argument)
In the above example, you can observe that we have created a program sysargv.py. While executing it through the command prompt, we passed 4 values as input arguments to the file.
You can observe that the name of the Python file is still at the first position in the list. The next 4 elements of the sys.argv list are the input arguments that we passed.
To learn more about sys.argv list, you can read this article on command line arguments in python.
Conclusion
In this article, we have discussed the sys argv list and its use in Python. To learn more about Python programming, you can read this article on open file using with open in python. You might also like this article on string manipulation in Python.
I hope you enjoyed reading this article. Stay tuned for more informative articles!
Разбираем модуль 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 Технический Университет Молдовы, Магистр, Магистерская диссертация «Идентификация человека в киберпространстве по фотографии лица»