shlex – Простой лексический анализ¶shlex – Simple lexical analysis

Объекты shlex¶shlex Objects

Экземпляр shlex имеет следующие методы:

shlex.get_token()¶

Возвращает токен. Если токены были помещены в стек с помощью push_token(), извлекает токен из стека. В противном случае читает один токен из входного потока. Если при чтении сразу встречается конец файла, возвращается eof (пустая строка ('') в не-POSIX режиме и None в режиме POSIX).

shlex.push_token(str)¶

Помещает аргумент в стек токенов.

shlex.read_token()¶

Читает сырой токен. Игнорирует стек возврата и не интерпретирует запросы источника. (Обычно это не является полезной точкой входа и документируется здесь только для полноты.)

shlex.sourcehook(filename)¶

Когда shlex обнаруживает запрос источника (см. source ниже), этому методу передаётся следующий токен в качестве аргумента, и ожидается, что он вернёт кортеж, состоящий из имени файла и открытого файлоподобного объекта.

Обычно этот метод сначала удаляет кавычки из аргумента. Если результат – абсолютный путь, или нет активного предыдущего запроса источника, или предыдущий источник был потоком данных (например, sys.stdin), результат остаётся без изменений. В противном случае, если результат – относительный путь, к нему добавляется часть пути каталога файла, находящегося непосредственно перед ним в стеке включения источников (такое поведение аналогично тому, как препроцессор C обрабатывает #include "file.h").

Результат этих действий трактуется как имя файла и возвращается в качестве первого компонента кортежа, а к нему применяется open() для получения второго компонента. (Примечание: это обратный порядок аргументов при инициализации экземпляра!)

Этот хук предоставляется, чтобы вы могли использовать его для реализации путей поиска по каталогам, добавления расширений файлов и других трюков с пространствами имён. Соответствующего хука «закрытия» нет, но экземпляр shlex вызовет метод close() входного потока источника, когда тот вернёт EOF.

Для более явного управления стеком источников используйте методы push_source() и pop_source().

shlex.push_source(newstream, newfile=None)¶

Помещает поток входного источника в стек ввода. Если указан аргумент filename, он будет доступен позже для использования в сообщениях об ошибках. Это тот же метод, который внутренне используется методом sourcehook().

shlex.pop_source()¶

Извлекает последний помещённый входной источник из стека ввода. Это тот же метод, который используется внутри, когда лексер достигает EOF для помещённого в стек входного потока.

shlex.error_leader(infile=None, lineno=None)¶

Этот метод формирует префикс сообщения об ошибке в формате метки ошибок компилятора C в Unix; формат – '"%s", line %d: ', где %s заменяется на имя текущего исходного файла, а %d – на номер текущей строки ввода (необязательные аргументы позволяют переопределить эти значения).

Это удобство предоставляется для того, чтобы побудить пользователей shlex генерировать сообщения об ошибках в стандартном, анализируемом формате, который понимают Emacs и другие инструменты Unix.

Экземпляры подклассов shlex имеют несколько открытых переменных экземпляра, которые либо управляют лексическим анализом, либо могут использоваться для отладки:

shlex.commenters¶

Строка символов, которые распознаются как начало комментария. Все символы от начала комментария до конца строки игнорируются. По умолчанию включает только '#'.

shlex.wordchars¶

Строка символов, которые будут накапливаться в многосимвольные токены. По умолчанию включает все буквенно-цифровые символы ASCII и символ подчёркивания. В режиме POSIX также включаются акцентированные символы из набора Latin-1. Если punctuation_chars не пусто, символы ~-./*?=, которые могут встречаться в именах файлов и параметрах командной строки, также будут добавлены в этот атрибут; любые символы, присутствующие в punctuation_chars, будут удалены из wordchars, если они там есть. Если whitespace_split установлено в True, это не будет иметь эффекта.

shlex.whitespace¶

Символы, которые считаются пробельными и пропускаются. Пробельные символы разделяют токены. По умолчанию включает пробел, табуляцию, перевод строки и возврат каретки.

shlex.escape¶

Символы, которые будут считаться экранирующими. Это используется только в режиме POSIX и по умолчанию включает только '\'.

shlex.quotes¶

Символы, которые будут считаться строковыми кавычками. Токен накапливается до тех пор, пока не встретится та же самая кавычка (то есть разные типы кавычек защищают друг друга, как в оболочке). По умолчанию включает ASCII одинарные и двойные кавычки.

shlex.escapedquotes¶

Символы в quotes, которые будут интерпретировать экранирующие символы, определённые в escape. Это используется только в режиме POSIX и по умолчанию включает только '"'.

shlex.whitespace_split¶

Если True, токены будут разделяться только по пробельным символам. Это полезно, например, для разбора командных строк с помощью shlex, получая токены способом, похожим на аргументы оболочки. При использовании в сочетании с punctuation_chars токены будут разделяться как по пробельным символам, так и по указанным символам.

Изменено в версии 3.8: Атрибут punctuation_chars был сделан совместимым с атрибутом whitespace_split.

shlex.infile¶

Имя текущего входного файла, установленное при создании экземпляра класса или помещённое в стек последующими запросами источников. Может быть полезно просмотреть его при формировании сообщений об ошибках.

shlex.instream¶

Входной поток, из которого данный экземпляр shlex читает символы.

shlex.source¶

По умолчанию этот атрибут равен None. Если присвоить ему строку, эта строка будет распознаваться как запрос на включение на уровне лексем, аналогично ключевому слову source в различных оболочках. То есть следующий непосредственно за ним токен будет открыт как имя файла, и ввод будет браться из этого потока до EOF, после чего будет вызван метод close() этого потока, и источником ввода снова станет исходный поток. Запросы источников могут быть вложены на любую глубину.

shlex.debug¶

Если этот атрибут является числовым и равен 1 или больше, экземпляр shlex будет выводить подробную информацию о своих действиях. Если потребуется этим воспользоваться, можно изучить исходный код модуля, чтобы узнать подробности.

shlex.lineno¶

Номер строки в исходном файле (количество встреченных символов новой строки плюс один).

shlex.token¶

Буфер токенов. Его может быть полезно проверить при перехвате исключений.

shlex.eof¶

Токен, используемый для определения конца файла. В не-POSIX-режиме он устанавливается в пустую строку (''), а в POSIX-режиме – в None.

shlex.punctuation_chars¶

Свойство только для чтения. Символы, которые считаются знаками пунктуации. Последовательности знаков пунктуации будут возвращаться как один токен. Однако обратите внимание, что семантическая проверка не выполняется: например, '>>>' может быть возвращено как токен, даже если оболочки не распознают его как таковой.

Новое в версии 3.6.

Правила разбора¶Parsing Rules

При работе в не-POSIX режиме shlex будет следовать следующим правилам.

• Символы кавычек не распознаются внутри слов (Do"Not"Separate разбирается как одно слово Do"Not"Separate);

• Символы экранирования не распознаются;

• Заключение символов в кавычки сохраняет буквальное значение всех символов внутри кавычек;

• Закрывающие кавычки разделяют слова ("Do"Separate разбирается как "Do" и Separate);

• Если значение whitespace_split равно False, любой символ, не объявленный как символ слова, пробел или кавычка, будет возвращён как односимвольный токен. Если оно равно True, shlex будет разделять слова только по пробельным символам;

• EOF обозначается пустой строкой ('');

• Невозможно разобрать пустые строки, даже если они в кавычках.

При работе в POSIX режиме shlex будет следовать следующим правилам разбора.

• Кавычки удаляются и не разделяют слова ("Do"Not"Separate" разбирается как одно слово DoNotSeparate);

• Неэкранированные (не в кавычках) escape-символы (например, '\') сохраняют буквальное значение следующего за ними символа;

• Заключение символов в кавычки, не входящие в escapedquotes (например, "'"), сохраняет буквальное значение всех символов внутри кавычек;

• Заключение символов в кавычки, которые являются частью escapedquotes (например, '"'), сохраняет буквальное значение всех символов внутри кавычек, за исключением символов, упомянутых в escape. Escape-символы сохраняют своё особое значение только в том случае, если за ними следует используемая кавычка или сам escape-символ. В противном случае escape-символ считается обычным символом.

• EOF обозначается значением None;

• Пустые строки в кавычках ('') допускаются.

Улучшенная совместимость с оболочками¶Improved Compatibility with Shells

Класс shlex обеспечивает совместимость с разбором, выполняемым распространёнными оболочками Unix, такими как bash, dash и sh. Чтобы воспользоваться этой совместимостью, укажите аргумент punctuation_chars в конструкторе. По умолчанию он равен False, что сохраняет поведение до версии 3.6. Однако если установить его в True, то разбор символов ();<>|& изменяется: любая последовательность этих символов возвращается как один токен. Хотя это не является полноценным разбором оболочек (что выходит за рамки стандартной библиотеки, учитывая множество существующих оболочек), это позволяет обрабатывать командные строки проще, чем иначе. Для иллюстрации можно увидеть разницу в следующем фрагменте:

 >>> import shlex
 >>> text = "a && b; c && d || e; f >'abc'; (def \"ghi\")"
 >>> s = shlex.shlex(text, posix=True)
 >>> s.whitespace_split = True
 >>> list(s)
 ['a', '&&', 'b;', 'c', '&&', 'd', '||', 'e;', 'f', '>abc;', '(def', 'ghi)']
 >>> s = shlex.shlex(text, posix=True, punctuation_chars=True)
 >>> s.whitespace_split = True
 >>> list(s)
 ['a', '&&', 'b', ';', 'c', '&&', 'd', '||', 'e', ';', 'f', '>', 'abc', ';',
 '(', 'def', 'ghi', ')']

Разумеется, будут возвращаться токены, которые не являются допустимыми для оболочек, и вам потребуется реализовать собственные проверки ошибок для возвращаемых токенов.

Вместо передачи True в качестве значения параметра punctuation_chars можно передать строку с определёнными символами, которая будет использоваться для определения того, какие символы считаются знаками пунктуации. Например:

>>> import shlex
>>> s = shlex.shlex("a && b || c", punctuation_chars="|")
>>> list(s)
['a', '&', '&', 'b', '||', 'c']

>>> import shlex
>>> s = shlex.shlex('~/a && b-c --color=auto || d *.py?',
...                 punctuation_chars=True)
>>> list(s)
['~/a', '&&', 'b-c', '--color=auto', '||', 'd', '*.py?']

Для лучшего результата punctuation_chars следует задавать вместе с posix=True. (Обратите внимание, что posix=False используется по умолчанию для shlex.)