`shlex.md`

269 строк · 29.6 КБ · обычная страница · сырой текст · скачать
1> **Источник:** https://python-all.ru/3.9/library/shlex.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# [`shlex`](https://python-all.ru/3.9/library/shlex.html#module-shlex) – Простой лексический анализ89**Исходный код:** [Lib/shlex.py](https://python-all.ru/src/3.9/Lib/shlex.py)1011---1213Класс [`shlex`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex) упрощает написание лексических анализаторов для синтаксиса, напоминающего синтаксис оболочки Unix. Это часто бывает полезно для создания мини-языков (например, в конфигурационных файлах приложений Python) или для разбора строк в кавычках.1415Модуль [`shlex`](https://python-all.ru/3.9/library/shlex.html#module-shlex) определяет следующие функции:1617#### `shlex.split(s, comments=False, posix=True)`1819Разделяет строку *s*, используя синтаксис, подобный оболочке. Если *comments* равно [`False`](https://python-all.ru/3.9/library/constants.html#False) (по умолчанию), разбор комментариев в заданной строке будет отключён (устанавливает атрибут [`commenters`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.commenters) экземпляра [`shlex`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex) в пустую строку). Эта функция работает в режиме POSIX по умолчанию, но использует не-POSIX режим, если аргумент *posix* равен False.2021> **Примечание**22>23> Поскольку функция [`split()`](https://python-all.ru/3.9/library/shlex.html#shlex.split) создаёт экземпляр [`shlex`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex) , передача `None` в качестве *s* будет читать строку для разбиения из стандартного ввода.2425Устарело с версии 3.9: Передача `None` в качестве *s* будет вызывать исключение в будущих Python версиях.2627#### `shlex.join(split_command)`2829Объединяет токены списка *split\_command* и возвращает строку. Эта функция является обратной к [`split()`](https://python-all.ru/3.9/library/shlex.html#shlex.split).3031```python32>>> from shlex import join33>>> print(join(['echo', '-n', 'Multiple words']))34echo -n 'Multiple words'35```3637Возвращаемое значение экранировано для оболочки, чтобы защититься от уязвимостей внедрения (см. [`quote()`](https://python-all.ru/3.9/library/shlex.html#shlex.quote)).3839Новое в версии 3.8.4041#### `shlex.quote(s)`4243Возвращает экранированную для оболочки версию строки *s*. Возвращаемое значение – это строка, которую можно безопасно использовать как один токен в командной строке оболочки в тех случаях, когда нельзя использовать список.4445Этот подход был бы небезопасен:4647```python48>>> filename = 'somefile; rm -rf ~'49>>> command = 'ls -l {}'.format(filename)50>>> print(command)  # выполнено оболочкой: бабах!51ls -l somefile; rm -rf ~52```5354[`quote()`](https://python-all.ru/3.9/library/shlex.html#shlex.quote) позволяет закрыть брешь в безопасности:5556```python57>>> from shlex import quote58>>> command = 'ls -l {}'.format(quote(filename))59>>> print(command)60ls -l 'somefile; rm -rf ~'61>>> remote_command = 'ssh home {}'.format(quote(command))62>>> print(remote_command)63ssh home 'ls -l '"'"'somefile; rm -rf ~'"'"''64```6566Экранирование совместимо с оболочками UNIX и с [`split()`](https://python-all.ru/3.9/library/shlex.html#shlex.split):6768```python69>>> from shlex import split70>>> remote_command = split(remote_command)71>>> remote_command72['ssh', 'home', "ls -l 'somefile; rm -rf ~'"]73>>> command = split(remote_command[-1])74>>> command75['ls', '-l', 'somefile; rm -rf ~']76```7778Новое в версии 3.3.7980Модуль [`shlex`](https://python-all.ru/3.9/library/shlex.html#module-shlex) определяет следующий класс:8182#### `class shlex.shlex(instream=None, infile=None, posix=False, punctuation_chars=False)`8384Экземпляр [`shlex`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex) или его подкласса представляет собой объект лексического анализатора. Аргумент инициализации, если присутствует, указывает, откуда читать символы. Это должен быть файлоподобный или потокоподобный объект с методами [`read()`](https://python-all.ru/3.9/library/io.html#io.TextIOBase.read) и [`readline()`](https://python-all.ru/3.9/library/io.html#io.TextIOBase.readline), или строка. Если аргумент не указан, ввод будет производиться из `sys.stdin`. Второй необязательный аргумент – строка с именем файла, которая устанавливает начальное значение атрибута [`infile`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.infile). Если аргумент *instream* опущен или равен `sys.stdin`, этот второй аргумент по умолчанию равен «stdin». Аргумент *posix* определяет режим работы: когда *posix* не истинен (по умолчанию), экземпляр [`shlex`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex) будет работать в режиме совместимости. При работе в режиме POSIX [`shlex`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex) будет стараться максимально приблизиться к правилам разбора оболочки POSIX. Аргумент *punctuation\_chars* позволяет ещё больше приблизить поведение к тому, как реальные оболочки выполняют разбор. Он может принимать несколько значений: значение по умолчанию, `False`, сохраняет поведение, наблюдаемое в Python 3.5 и более ранних версиях. Если установлено в `True`, то разбор символов `();<>|&` изменяется: любая последовательность этих символов (считающихся знаками препинания) возвращается как один токен. Если установлена непустая строка символов, эти символы будут использоваться как знаки препинания. Любые символы из атрибута [`wordchars`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.wordchars), которые встречаются в *punctuation\_chars*, будут удалены из [`wordchars`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.wordchars). См. [Улучшенная совместимость с оболочками](https://python-all.ru/3.9/library/shlex.html#improved-shell-compatibility) для получения дополнительной информации. *punctuation\_chars* можно задать только при создании экземпляра [`shlex`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex), и его нельзя изменить позже.8586Изменено в версии 3.6: Был добавлен параметр *punctuation\_chars*.8788> **См. также**89>90> **Модуль [`configparser`](https://python-all.ru/3.9/library/configparser.html#module-configparser)**91>92> Синтаксический анализатор конфигурационных файлов, аналогичных файлам `.ini` в Windows.9394## Объекты shlex9596Экземпляр [`shlex`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex) имеет следующие методы:9798#### `shlex.get_token()`99100Возвращает токен. Если токены были помещены в стек с помощью [`push_token()`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.push_token), извлекает токен из стека. В противном случае читает один токен из входного потока. Если при чтении сразу встречается конец файла, возвращается [`eof`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.eof) (пустая строка (`''`) в не-POSIX режиме и `None` в режиме POSIX).101102#### `shlex.push_token(str)`103104Помещает аргумент в стек токенов.105106#### `shlex.read_token()`107108Читает сырой токен. Игнорирует стек возврата и не интерпретирует запросы источника. (Обычно это не является полезной точкой входа и документируется здесь только для полноты.)109110#### `shlex.sourcehook(filename)`111112Когда [`shlex`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex) обнаруживает запрос источника (см. [`source`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.source) ниже), этому методу передаётся следующий токен в качестве аргумента, и ожидается, что он вернёт кортеж, состоящий из имени файла и открытого файлоподобного объекта.113114Обычно этот метод сначала удаляет кавычки из аргумента. Если результат – абсолютный путь, или нет активного предыдущего запроса источника, или предыдущий источник был потоком данных (например, `sys.stdin`), результат остаётся без изменений. В противном случае, если результат – относительный путь, к нему добавляется часть пути каталога файла, находящегося непосредственно перед ним в стеке включения источников (такое поведение аналогично тому, как препроцессор C обрабатывает `#include "file.h"`).115116Результат этих действий трактуется как имя файла и возвращается в качестве первого компонента кортежа, а к нему применяется [`open()`](https://python-all.ru/3.9/library/functions.html#open) для получения второго компонента. (Примечание: это обратный порядок аргументов при инициализации экземпляра!)117118Этот хук предоставляется, чтобы вы могли использовать его для реализации путей поиска по каталогам, добавления расширений файлов и других трюков с пространствами имён. Соответствующего хука «закрытия» нет, но экземпляр shlex вызовет метод [`close()`](https://python-all.ru/3.9/library/io.html#io.IOBase.close) входного потока источника, когда тот вернёт EOF.119120Для более явного управления стеком источников используйте методы [`push_source()`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.push_source) и [`pop_source()`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.pop_source).121122#### `shlex.push_source(newstream, newfile=None)`123124Помещает поток входного источника в стек ввода. Если указан аргумент filename, он будет доступен позже для использования в сообщениях об ошибках. Это тот же метод, который внутренне используется методом [`sourcehook()`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.sourcehook).125126#### `shlex.pop_source()`127128Извлекает последний помещённый входной источник из стека ввода. Это тот же метод, который используется внутри, когда лексер достигает EOF для помещённого в стек входного потока.129130#### `shlex.error_leader(infile=None, lineno=None)`131132Этот метод формирует префикс сообщения об ошибке в формате метки ошибок компилятора C в Unix; формат – `'"%s", line %d: '`, где `%s` заменяется на имя текущего исходного файла, а `%d` – на номер текущей строки ввода (необязательные аргументы позволяют переопределить эти значения).133134Это удобство предоставляется для того, чтобы побудить пользователей [`shlex`](https://python-all.ru/3.9/library/shlex.html#module-shlex) генерировать сообщения об ошибках в стандартном, анализируемом формате, который понимают Emacs и другие инструменты Unix.135136Экземпляры подклассов [`shlex`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex) имеют несколько открытых переменных экземпляра, которые либо управляют лексическим анализом, либо могут использоваться для отладки:137138#### `shlex.commenters`139140Строка символов, которые распознаются как начало комментария. Все символы от начала комментария до конца строки игнорируются. По умолчанию включает только `'#'`.141142#### `shlex.wordchars`143144Строка символов, которые будут накапливаться в многосимвольные токены. По умолчанию включает все буквенно-цифровые символы ASCII и символ подчёркивания. В режиме POSIX также включаются акцентированные символы из набора Latin-1. Если [`punctuation_chars`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.punctuation_chars) не пусто, символы `~-./*?=`, которые могут встречаться в именах файлов и параметрах командной строки, также будут добавлены в этот атрибут; любые символы, присутствующие в `punctuation_chars`, будут удалены из `wordchars`, если они там есть. Если [`whitespace_split`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.whitespace_split) установлено в `True`, это не будет иметь эффекта.145146#### `shlex.whitespace`147148Символы, которые считаются пробельными и пропускаются. Пробельные символы разделяют токены. По умолчанию включает пробел, табуляцию, перевод строки и возврат каретки.149150#### `shlex.escape`151152Символы, которые будут считаться экранирующими. Это используется только в режиме POSIX и по умолчанию включает только `'\'`.153154#### `shlex.quotes`155156Символы, которые будут считаться строковыми кавычками. Токен накапливается до тех пор, пока не встретится та же самая кавычка (то есть разные типы кавычек защищают друг друга, как в оболочке). По умолчанию включает ASCII одинарные и двойные кавычки.157158#### `shlex.escapedquotes`159160Символы в [`quotes`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.quotes), которые будут интерпретировать экранирующие символы, определённые в [`escape`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.escape). Это используется только в режиме POSIX и по умолчанию включает только `'"'`.161162#### `shlex.whitespace_split`163164Если `True`, токены будут разделяться только по пробельным символам. Это полезно, например, для разбора командных строк с помощью [`shlex`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex), получая токены способом, похожим на аргументы оболочки. При использовании в сочетании с [`punctuation_chars`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.punctuation_chars) токены будут разделяться как по пробельным символам, так и по указанным символам.165166Изменено в версии 3.8: Атрибут [`punctuation_chars`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.punctuation_chars) был сделан совместимым с атрибутом [`whitespace_split`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.whitespace_split).167168#### `shlex.infile`169170Имя текущего входного файла, установленное при создании экземпляра класса или помещённое в стек последующими запросами источников. Может быть полезно просмотреть его при формировании сообщений об ошибках.171172#### `shlex.instream`173174Входной поток, из которого данный экземпляр [`shlex`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex) читает символы.175176#### `shlex.source`177178По умолчанию этот атрибут равен `None`. Если присвоить ему строку, эта строка будет распознаваться как запрос на включение на уровне лексем, аналогично ключевому слову `source` в различных оболочках. То есть следующий непосредственно за ним токен будет открыт как имя файла, и ввод будет браться из этого потока до EOF, после чего будет вызван метод [`close()`](https://python-all.ru/3.9/library/io.html#io.IOBase.close) этого потока, и источником ввода снова станет исходный поток. Запросы источников могут быть вложены на любую глубину.179180#### `shlex.debug`181182Если этот атрибут является числовым и равен `1` или больше, экземпляр [`shlex`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex) будет выводить подробную информацию о своих действиях. Если потребуется этим воспользоваться, можно изучить исходный код модуля, чтобы узнать подробности.183184#### `shlex.lineno`185186Номер строки в исходном файле (количество встреченных символов новой строки плюс один).187188#### `shlex.token`189190Буфер токенов. Его может быть полезно проверить при перехвате исключений.191192#### `shlex.eof`193194Токен, используемый для определения конца файла. В не-POSIX-режиме он устанавливается в пустую строку (`''`), а в POSIX-режиме – в `None`.195196#### `shlex.punctuation_chars`197198Свойство только для чтения. Символы, которые считаются знаками пунктуации. Последовательности знаков пунктуации будут возвращаться как один токен. Однако обратите внимание, что семантическая проверка не выполняется: например, '\>\>\>' может быть возвращено как токен, даже если оболочки не распознают его как таковой.199200Новое в версии 3.6.201202## Правила разбора203204При работе в не-POSIX режиме [`shlex`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex) будет следовать следующим правилам.205206- Символы кавычек не распознаются внутри слов (`Do"Not"Separate` разбирается как одно слово `Do"Not"Separate`);207- Символы экранирования не распознаются;208- Заключение символов в кавычки сохраняет буквальное значение всех символов внутри кавычек;209- Закрывающие кавычки разделяют слова (`"Do"Separate` разбирается как `"Do"` и `Separate`);210- Если значение [`whitespace_split`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.whitespace_split) равно `False`, любой символ, не объявленный как символ слова, пробел или кавычка, будет возвращён как односимвольный токен. Если оно равно `True`, [`shlex`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex) будет разделять слова только по пробельным символам;211- EOF обозначается пустой строкой (`''`);212- Невозможно разобрать пустые строки, даже если они в кавычках.213214При работе в POSIX режиме [`shlex`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex) будет следовать следующим правилам разбора.215216- Кавычки удаляются и не разделяют слова (`"Do"Not"Separate"` разбирается как одно слово `DoNotSeparate`);217- Неэкранированные (не в кавычках) escape-символы (например, `'\'`) сохраняют буквальное значение следующего за ними символа;218- Заключение символов в кавычки, не входящие в [`escapedquotes`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.escapedquotes) (например, `"'"`), сохраняет буквальное значение всех символов внутри кавычек;219- Заключение символов в кавычки, которые являются частью [`escapedquotes`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.escapedquotes) (например, `'"'`), сохраняет буквальное значение всех символов внутри кавычек, за исключением символов, упомянутых в [`escape`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.escape). Escape-символы сохраняют своё особое значение только в том случае, если за ними следует используемая кавычка или сам escape-символ. В противном случае escape-символ считается обычным символом.220- EOF обозначается значением [`None`](https://python-all.ru/3.9/library/constants.html#None);221- Пустые строки в кавычках (`''`) допускаются.222223## Улучшенная совместимость с оболочками224225Новое в версии 3.6.226227Класс [`shlex`](https://python-all.ru/3.9/library/shlex.html#module-shlex) обеспечивает совместимость с разбором, выполняемым распространёнными оболочками Unix, такими как `bash`, `dash` и `sh`. Чтобы воспользоваться этой совместимостью, укажите аргумент `punctuation_chars` в конструкторе. По умолчанию он равен `False`, что сохраняет поведение до версии 3.6. Однако если установить его в `True`, то разбор символов `();<>|&` изменяется: любая последовательность этих символов возвращается как один токен. Хотя это не является полноценным разбором оболочек (что выходит за рамки стандартной библиотеки, учитывая множество существующих оболочек), это позволяет обрабатывать командные строки проще, чем иначе. Для иллюстрации можно увидеть разницу в следующем фрагменте:228229```pycon230 >>> import shlex231 >>> text = "a && b; c && d || e; f >'abc'; (def \"ghi\")"232 >>> s = shlex.shlex(text, posix=True)233 >>> s.whitespace_split = True234 >>> list(s)235 ['a', '&&', 'b;', 'c', '&&', 'd', '||', 'e;', 'f', '>abc;', '(def', 'ghi)']236 >>> s = shlex.shlex(text, posix=True, punctuation_chars=True)237 >>> s.whitespace_split = True238 >>> list(s)239 ['a', '&&', 'b', ';', 'c', '&&', 'd', '||', 'e', ';', 'f', '>', 'abc', ';',240 '(', 'def', 'ghi', ')']241```242243Разумеется, будут возвращаться токены, которые не являются допустимыми для оболочек, и вам потребуется реализовать собственные проверки ошибок для возвращаемых токенов.244245Вместо передачи `True` в качестве значения параметра punctuation\_chars можно передать строку с определёнными символами, которая будет использоваться для определения того, какие символы считаются знаками пунктуации. Например:246247```python248>>> import shlex249>>> s = shlex.shlex("a && b || c", punctuation_chars="|")250>>> list(s)251['a', '&', '&', 'b', '||', 'c']252```253254> **Примечание**255>256> Когда указано `punctuation_chars`, атрибут [`wordchars`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.wordchars) дополняется символами `~-./*?=`. Это связано с тем, что эти символы могут встречаться в именах файлов (включая шаблоны) и аргументах командной строки (например, `--color=auto`). Следовательно:257>258> ```python259> >>> import shlex260> >>> s = shlex.shlex('~/a && b-c --color=auto || d *.py?',261> ...                 punctuation_chars=True)262> >>> list(s)263> ['~/a', '&&', 'b-c', '--color=auto', '||', 'd', '*.py?']264> ```265>266> Однако, чтобы максимально точно имитировать поведение оболочки, рекомендуется всегда использовать `posix` и [`whitespace_split`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.whitespace_split) при использовании [`punctuation_chars`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.punctuation_chars), что полностью исключает [`wordchars`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex.wordchars).267268Для лучшего результата `punctuation_chars` следует задавать вместе с `posix=True`. (Обратите внимание, что `posix=False` используется по умолчанию для [`shlex`](https://python-all.ru/3.9/library/shlex.html#shlex.shlex).)269