cgi.md

1> **Источник:** https://python-all.ru/3.3/library/cgi.html2>3> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.45---67# 21.2. [`cgi`](https://python-all.ru/3.3/library/cgi.html#module-cgi) – поддержка Common Gateway Interface89**Исходный код:** [Lib/cgi.py](https://python-all.ru/src/3.3/Lib/cgi.py)1011---1213Вспомогательный модуль для скриптов Common Gateway Interface (CGI).1415Этот модуль определяет ряд утилит для использования CGI-скриптами, написанными на Python.1617## 21.2.1. Введение1819CGI-скрипт вызывается HTTP-сервером, обычно для обработки пользовательского ввода, отправленного через элемент HTML `<FORM>` или `<ISINDEX>`.2021Чаще всего CGI-скрипты находятся в специальной директории сервера `cgi-bin`. HTTP-сервер помещает всю информацию о запросе (такую как имя хоста клиента, запрошенный URL, строку запроса и множество других полезных данных) в окружение оболочки скрипта, выполняет скрипт и отправляет его вывод обратно клиенту.2223Ввод скрипта также подключён к клиенту, и иногда данные формы читаются таким образом; в других случаях данные формы передаются через часть URL «строка запроса». Этот модуль предназначен для обработки различных ситуаций и предоставления более простого интерфейса для Python-скрипта. Он также предоставляет ряд утилит, помогающих при отладке скриптов, и последним дополнением является поддержка загрузки файлов из формы (если браузер это поддерживает).2425Вывод CGI-скрипта должен состоять из двух разделов, разделённых пустой строкой. Первый раздел содержит несколько заголовков, сообщающих клиенту, какие данные следуют. Код Python для генерации минимального раздела заголовков выглядит так:2627```python28print("Content-Type: text/html")    # Далее HTML29print()                             # пустая строка, конец заголовков30```3132Второй раздел обычно представляет собой HTML, что позволяет клиентскому программному обеспечению отображать красиво отформатированный текст с заголовками, встроенными изображениями и т.д. Вот код Python, выводящий простой фрагмент HTML:3334```python35print("<TITLE>CGI script output</TITLE>")36print("<H1>This is my first CGI script</H1>")37print("Hello, world!")38```3940## 21.2.2. Использование модуля cgi4142Для начала следует написать `import cgi`.4344При написании нового скрипта стоит добавить следующие строки:4546```python47import cgitb48cgitb.enable()49```5051Это активирует специальный обработчик исключений, который будет выводить подробные отчеты в веб-браузере при возникновении ошибок. Если вы не хотите показывать пользователям вашего скрипта внутренности программы, можно вместо этого сохранять отчеты в файлы с помощью такого кода:5253```python54import cgitb55cgitb.enable(display=0, logdir="/path/to/logdir")56```5758Очень полезно использовать эту возможность при разработке скрипта. Отчёты, формируемые [`cgitb`](https://python-all.ru/3.3/library/cgitb.html#module-cgitb), содержат информацию, способную сэкономить много времени при поиске ошибок. Строку `cgitb` можно удалить позже, после тестирования скрипта и уверенности в его корректной работе.5960Чтобы получить отправленные данные формы, используйте класс `FieldStorage`. Если форма содержит не-ASCII символы, используйте именованный параметр *encoding*, установленный в значение кодировки, определённой для документа. Обычно она содержится в теге META в разделе HEAD HTML-документа или в заголовке *Content-Type*). Это считывает содержимое формы из стандартного ввода или окружения (в зависимости от значений различных переменных окружения, установленных согласно стандарту CGI). Поскольку это может потребить стандартный ввод, создавать экземпляр следует только один раз.6162Экземпляр `FieldStorage` можно индексировать как словарь Python. Он позволяет проверять членство с помощью оператора [`in`](https://python-all.ru/3.3/reference/expressions.html#in), а также поддерживает стандартный метод словаря [`keys()`](https://python-all.ru/3.3/library/stdtypes.html#dict.keys) и встроенную функцию [`len()`](https://python-all.ru/3.3/library/functions.html#len). Поля формы, содержащие пустые строки, игнорируются и не отображаются в словаре; чтобы сохранить такие значения, укажите истинное значение для необязательного именованного параметра *keep\_blank\_values* при создании экземпляра `FieldStorage`.6364Например, следующий код (который предполагает, что заголовок *Content-Type* и пустая строка уже выведены) проверяет, что поля `name` и `addr` установлены в непустую строку:6566```python67form = cgi.FieldStorage()68if "name" not in form or "addr" not in form:69    print("<H1>Error</H1>")70    print("Please fill in the name and addr fields.")71    return72print("<p>name:", form["name"].value)73print("<p>addr:", form["addr"].value)74...further form processing here...75```7677Здесь поля, доступ к которым осуществляется через `form[key]`, сами являются экземплярами `FieldStorage` (или `MiniFieldStorage`, в зависимости от кодировки формы). Атрибут `value` экземпляра возвращает строковое значение поля. Метод `getvalue()` возвращает это строковое значение напрямую; также он принимает необязательный второй аргумент в качестве значения по умолчанию, которое будет возвращено, если запрошенный ключ отсутствует.7879Если отправленные данные формы содержат несколько полей с одинаковым именем, объект, полученный с помощью `form[key]`, будет не экземпляром `FieldStorage` или `MiniFieldStorage`, а списком таких экземпляров. Аналогично, в этой ситуации `form.getvalue(key)` вернёт список строк. Если вы ожидаете такую возможность (когда HTML-форма содержит несколько полей с одинаковым именем), используйте метод [`getlist()`](https://python-all.ru/3.3/library/cgi.html#cgi.FieldStorage.getlist), который всегда возвращает список значений (так что вам не нужно обрабатывать случай с одним элементом отдельно). Например, этот код объединяет любое количество полей username, разделяя их запятыми:8081```python82value = form.getlist("username")83usernames = ",".join(value)84```8586Если поле представляет загруженный файл, доступ к значению через атрибут `value` или метод `getvalue()` считывает весь файл в память как байты. Это может быть нежелательно. Проверить, является ли поле загруженным файлом, можно, проверив атрибут `filename` или атрибут `file` . Затем можно прочитать данные из атрибута `file` (методы [`read()`](https://python-all.ru/3.3/library/io.html#io.RawIOBase.read) и [`readline()`](https://python-all.ru/3.3/library/io.html#io.IOBase.readline) вернут байты):8788```python89fileitem = form["userfile"]90if fileitem.file:91    # Это загруженный файл; подсчитать строки92    linecount = 093    while True:94        line = fileitem.file.readline()95        if not line: break96        linecount = linecount + 197```9899Если при получении содержимого загруженного файла возникает ошибка (например, когда пользователь прерывает отправку формы, нажав кнопку «Назад» или «Отмена»), атрибут `done` объекта поля будет установлен в значение -1.100101Проект стандарта загрузки файлов предусматривает возможность загрузки нескольких файлов из одного поля (с использованием рекурсивной кодировки *multipart/\**). В этом случае элемент будет похожим на словарь `FieldStorage`. Это можно определить, проверив его атрибут `type`, который должен быть *multipart/form-data* (или, возможно, другой MIME-тип, соответствующий *multipart/\**). В этом случае по нему можно рекурсивно итерироваться, как и по объекту формы верхнего уровня.102103Когда форма отправляется в «старом» формате (как строка запроса или как одна часть данных типа *application/x-www-form-urlencoded*), элементы будут экземплярами класса `MiniFieldStorage`. В этом случае атрибуты `list`, `file` и `filename` всегда равны `None`.104105Форма, отправленная через POST с дополнительной строкой запроса, будет содержать элементы как `FieldStorage`, так и `MiniFieldStorage`.106107## 21.2.3. Интерфейс более высокого уровня108109В предыдущем разделе объясняется, как читать данные CGI-формы с помощью класса `FieldStorage`. В этом разделе описывается интерфейс более высокого уровня, добавленный в этот класс для обеспечения более читаемого и интуитивного способа работы. Этот интерфейс не делает устаревшими методы, описанные в предыдущих разделах – они по-прежнему полезны, например, для эффективной обработки загрузки файлов.110111Интерфейс состоит из двух простых методов. С их помощью можно обрабатывать данные формы универсально, не задумываясь о том, было ли отправлено одно или несколько значений под одним именем.112113В предыдущем разделе было показано, как писать следующий код каждый раз, когда ожидается, что пользователь отправит несколько значений под одним именем:114115```python116item = form.getvalue("item")117if isinstance(item, list):118    # Пользователь запрашивает более одного элемента.119else:120    # Пользователь запрашивает только один элемент.121```122123Такая ситуация часто возникает, например, когда форма содержит группу флажков с одинаковым именем:124125```python126<input type="checkbox" name="item" value="1" />127<input type="checkbox" name="item" value="2" />128```129130Однако в большинстве случаев в форме есть только один элемент управления с определённым именем, и тогда ожидается и требуется только одно значение, связанное с этим именем. Поэтому пишется скрипт, содержащий, например, такой код:131132```python133user = form.getvalue("user").upper()134```135136Проблема с кодом в том, что никогда не следует ожидать, что клиент предоставит корректные входные данные для скриптов. Например, если любопытный пользователь добавит ещё одну пару `user=foo` в строку запроса, скрипт аварийно завершится, поскольку в этой ситуации вызов метода `getvalue("user")` возвращает список вместо строки. Вызов метода [`upper()`](https://python-all.ru/3.3/library/stdtypes.html#str.upper) для списка недопустим (так как в списках нет такого метода) и приводит к исключению [`AttributeError`](https://python-all.ru/3.3/library/exceptions.html#AttributeError).137138Поэтому единственным правильным способом чтения значений данных формы было всегда использовать код, проверяющий, является ли полученное значение одиночным или списком значений. Это утомительно и снижает читаемость скриптов.139140Более удобный подход – использовать методы [`getfirst()`](https://python-all.ru/3.3/library/cgi.html#cgi.FieldStorage.getfirst) и [`getlist()`](https://python-all.ru/3.3/library/cgi.html#cgi.FieldStorage.getlist), предоставляемые этим интерфейсом более высокого уровня.141142#### `FieldStorage.getfirst(name, default=None)`143144Этот метод всегда возвращает только одно значение, связанное с полем формы *name*. Метод возвращает только первое значение в случае, если под таким именем было отправлено несколько значений. Обратите внимание: порядок получения значений может различаться в разных браузерах, и на него не следует полагаться. [\[1\]](https://python-all.ru/3.3/library/cgi.html#id3) Если поле формы или значение отсутствует, метод возвращает значение, указанное необязательным параметром *default*. Если параметр не указан, по умолчанию используется `None`.145146#### `FieldStorage.getlist(name)`147148Этот метод всегда возвращает список значений, связанных с полем формы *name*. Метод возвращает пустой список, если для *name* не существует такого поля или значения. Возвращает список из одного элемента, если существует только одно значение.149150С помощью этих методов можно писать компактный код:151152```python153import cgi154form = cgi.FieldStorage()155user = form.getfirst("user", "").upper()    # Так это безопасно.156for item in form.getlist("item"):157    do_something(item)158```159160## 21.2.4. Функции161162Они полезны, если нужен более тонкий контроль или если требуется использовать некоторые алгоритмы, реализованные в этом модуле, в других ситуациях.163164#### `cgi.parse(fp=None, environ=os.environ, keep_blank_values=False, strict_parsing=False)`165166Разбирает запрос из окружения или из файла (по умолчанию файл – `sys.stdin`). Параметры *keep\_blank\_values* и *strict\_parsing* передаются в [`urllib.parse.parse_qs()`](https://python-all.ru/3.3/library/urllib.parse.html#urllib.parse.parse_qs) без изменений.167168#### `cgi.parse_qs(qs, keep_blank_values=False, strict_parsing=False)`169170Эта функция устарела в данном модуле. Вместо неё используйте [`urllib.parse.parse_qs()`](https://python-all.ru/3.3/library/urllib.parse.html#urllib.parse.parse_qs). Она поддерживается здесь только для обратной совместимости.171172#### `cgi.parse_qsl(qs, keep_blank_values=False, strict_parsing=False)`173174Эта функция устарела в данном модуле. Вместо неё используйте [`urllib.parse.parse_qs()`](https://python-all.ru/3.3/library/urllib.parse.html#urllib.parse.parse_qs). Она поддерживается здесь только для обратной совместимости.175176#### `cgi.parse_multipart(fp, pdict)`177178Разбирает входные данные типа *multipart/form-data* (для загрузки файлов). Аргументы: *fp* – входной файл, *pdict* – словарь, содержащий другие параметры из заголовка *Content-Type*.179180Возвращает словарь, аналогичный [`urllib.parse.parse_qs()`](https://python-all.ru/3.3/library/urllib.parse.html#urllib.parse.parse_qs): ключи – имена полей, каждое значение – список значений для этого поля. Это легко использовать, но не очень хорошо, если ожидается загрузка мегабайтов – в этом случае используйте класс `FieldStorage`, который гораздо более гибок.181182Обратите внимание, что эта функция не разбирает вложенные части multipart – для этого используйте `FieldStorage`.183184#### `cgi.parse_header(string)`185186Разбирает MIME-заголовок (например, *Content-Type*) на основное значение и словарь параметров.187188#### `cgi.test()`189190Надёжный тестовый CGI-скрипт, который можно использовать как основную программу. Выводит минимальные HTTP-заголовки и форматирует всю переданную скрипту информацию в виде HTML.191192#### `cgi.print_environ()`193194Форматирует окружение оболочки в формате HTML.195196#### `cgi.print_form(form)`197198Форматирование формы в HTML.199200#### `cgi.print_directory()`201202Форматирование текущей директории в HTML.203204#### `cgi.print_environ_usage()`205206Вывод в HTML списка полезных переменных окружения (используемых CGI).207208#### `cgi.escape(s, quote=False)`209210Преобразует символы `'&'`, `'<'` и `'>'` в строке *s* в HTML-безопасные последовательности. Используйте это, если нужно отобразить текст, который может содержать такие символы в HTML. Если необязательный флаг *quote* равен true, символ кавычки (`"`) также преобразуется; это помогает при встраивании в значение атрибута HTML, ограниченное двойными кавычками, как в `<a href="...">`. Обратите внимание: одинарные кавычки никогда не преобразуются.211212Устарело с версии 3.2: Эта функция небезопасна, так как *quote* по умолчанию равен false, и поэтому она устарела. Вместо неё используйте [`html.escape()`](https://python-all.ru/3.3/library/html.html#html.escape).213214## 21.2.5. Безопасность215216Есть одно важное правило: если вы вызываете внешнюю программу (через функции [`os.system()`](https://python-all.ru/3.3/library/os.html#os.system) или [`os.popen()`](https://python-all.ru/3.3/library/os.html#os.popen), или другие с аналогичной функциональностью), убедитесь, что не передаёте произвольные строки, полученные от клиента, в оболочку. Это общеизвестная дыра в безопасности, с помощью которой умные хакеры из любой точки Интернета могут заставить доверчивый CGI-скрипт выполнять произвольные команды оболочки. Нельзя доверять даже частям URL или именам полей, поскольку запрос не обязательно приходит из вашей формы!217218Чтобы быть в безопасности, если вам всё же нужно передать строку из формы команде оболочки, стоит убедиться, что строка содержит только буквенно-цифровые символы, дефисы, символы подчёркивания и точки.219220## 21.2.6. Установка CGI-сценария в системе Unix221222Прочитайте документацию вашего HTTP-сервера и уточните у системного администратора каталог, в который следует устанавливать CGI-скрипты; обычно это каталог `cgi-bin` в дереве сервера.223224Убедитесь, что ваш скрипт доступен для чтения и выполнения «другими»; в Unix режим файла должен быть `0o755` восьмеричный (используйте `chmod 0755 filename`). Убедитесь, что первая строка скрипта содержит `#!`, начиная с первой колонки, после которого идёт путь к интерпретатору Python, например:225226```python227#!/usr/local/bin/python228```229230Убедитесь, что интерпретатор Python существует и доступен для выполнения «другими».231232Убедитесь, что любые файлы, которые ваш скрипт должен читать или записывать, доступны для чтения или записи соответственно «другим» – их режим должен быть `0o644` для чтения и `0o666` для записи. Это связано с тем, что из соображений безопасности HTTP-сервер выполняет ваш скрипт от имени пользователя «nobody», без каких-либо особых привилегий. Он может только читать (записывать, выполнять) файлы, которые все могут читать (записывать, выполнять). Текущий каталог во время выполнения также отличается (обычно это каталог cgi-bin сервера), и набор переменных окружения тоже отличается от того, что вы получаете при входе в систему. В частности, не рассчитывайте, что путь поиска исполняемых файлов оболочки (`PATH`) или путь поиска модулей Python ([`PYTHONPATH`](https://python-all.ru/3.3/using/cmdline.html#envvar-PYTHONPATH)) будут установлены во что-то интересное.233234Если вам нужно загружать модули из директории, которой нет в пути поиска модулей Python по умолчанию, можно изменить путь в скрипте перед импортом других модулей. Например:235236```python237import sys238sys.path.insert(0, "/usr/home/joe/lib/python")239sys.path.insert(0, "/usr/local/lib/python")240```241242(Так директория, вставленная последней, будет просматриваться первой!)243244Инструкции для систем, отличных от Unix, различаются; ознакомьтесь с документацией вашего HTTP-сервера (обычно в ней есть раздел о CGI-скриптах).245246## 21.2.7. Тестирование CGI-сценария247248К сожалению, CGI-скрипт обычно не работает при запуске из командной строки, а скрипт, отлично работающий в командной строке, может таинственно отказываться при запуске через сервер. Но есть одна причина, по которой всё же стоит тестировать скрипт из командной строки: если в нём есть синтаксическая ошибка, интерпретатор Python вообще не выполнит его, и HTTP-сервер, скорее всего, отправит клиенту малопонятную ошибку.249250Если в скрипте нет синтаксических ошибок, но он всё равно не работает, ничего не остаётся, кроме как прочитать следующий раздел.251252## 21.2.8. Отладка CGI-сценариев253254Прежде всего проверьте тривиальные ошибки установки – внимательное прочтение раздела выше об установке CGI-скрипта может сэкономить много времени. Если вы сомневаетесь, правильно ли поняли процедуру установки, попробуйте установить копию этого файла модуля (`cgi.py`) как CGI-скрипт. При вызове как скрипт файл выведет своё окружение и содержимое формы в виде HTML. Задайте ему правильный режим и т.д. и отправьте запрос. Если он установлен в стандартный каталог `cgi-bin`, то можно отправить запрос, введя в браузере URL следующего вида:255256```python257http://yourhostname/cgi-bin/cgi.py?name=Joe+Blow&addr=At+Home258```259260Если это даёт ошибку 404, сервер не может найти скрипт – возможно, его нужно установить в другой каталог. Если возникает другая ошибка, значит, есть проблема с установкой, которую следует устранить, прежде чем двигаться дальше. Если вы получили аккуратно отформатированный список окружения и содержимого формы (в этом примере поля должны быть перечислены как «addr» со значением «At Home» и «name» со значением «Joe Blow»), то скрипт `cgi.py` установлен правильно. Если вы выполните ту же процедуру для своего скрипта, то сможете его отладить.261262Следующим шагом может быть вызов функции [`test()`](https://python-all.ru/3.3/library/test.html#module-test) модуля [`cgi`](https://python-all.ru/3.3/library/cgi.html#module-cgi) из вашего скрипта: замените его основной код одним оператором263264```python265cgi.test()266```267268Это должно дать те же результаты, что и установка самого файла `cgi.py`.269270Когда обычный скрипт Python вызывает необработанное исключение (по любой причине: опечатка в имени модуля, файл, который не удаётся открыть, и т.п.), интерпретатор Python печатает подробную трассировку и завершает работу. Хотя интерпретатор Python всё ещё делает это, когда ваш CGI-скрипт вызывает исключение, скорее всего, трассировка попадёт в один из журнальных файлов HTTP-сервера или вообще будет отброшена.271272К счастью, как только вам удалось заставить скрипт выполнить *какой-либо* код, вы можете легко отправлять трассировки в веб-браузер с помощью модуля [`cgitb`](https://python-all.ru/3.3/library/cgitb.html#module-cgitb). Если вы ещё этого не сделали, просто добавьте строки:273274```python275import cgitb276cgitb.enable()277```278279в начало скрипта. Затем попробуйте запустить его снова; при возникновении проблемы вы увидите подробный отчёт, который, вероятно, укажет на причину сбоя.280281Если вы подозреваете, что может быть проблема с импортом модуля [`cgitb`](https://python-all.ru/3.3/library/cgitb.html#module-cgitb), можно использовать ещё более надёжный подход (использующий только встроенные модули):282283```python284import sys285sys.stderr = sys.stdout286print("Content-Type: text/plain")287print()288...your code here...289```290291Этот подход полагается на интерпретатор Python для печати трассировки. Тип содержимого вывода устанавливается в обычный текст, что отключает всю обработку HTML. Если ваш скрипт работает, сырой HTML будет отображён клиентом. Если он вызывает исключение, скорее всего, после вывода первых двух строк будет показана трассировка. Поскольку интерпретация HTML не происходит, трассировка будет читаемой.292293## 21.2.9. Часто встречающиеся проблемы и их решения294295- Большинство HTTP-серверов буферизуют вывод CGI-скриптов до завершения скрипта. Это означает, что невозможно отображать индикатор выполнения на экране клиента во время работы скрипта.296- Проверьте инструкции по установке выше.297- Проверьте файлы журнала HTTP-сервера. (`tail -f logfile` в отдельном окне может быть полезно!)298- Всегда сначала проверяйте скрипт на синтаксические ошибки, выполнив что-то вроде `python script.py`.299- Если в вашем скрипте нет синтаксических ошибок, попробуйте добавить `import cgitb; cgitb.enable()` в начало скрипта.300- При вызове внешних программ убедитесь, что они доступны. Обычно это означает использование абсолютных путей – `PATH` обычно не настроен на что-то полезное в CGI-скрипте.301- При чтении или записи внешних файлов убедитесь, что они могут быть прочитаны или записаны тем идентификатором пользователя (userid), под которым будет выполняться ваш CGI-скрипт: обычно это идентификатор пользователя, под которым работает веб-сервер, или явно указанный идентификатор для функции `suexec` веб-сервера.302- Не пытайтесь установить CGI-скрипту режим set-uid. На большинстве систем это не работает и к тому же создаёт угрозу безопасности.303304Сноски305306| [\[1\]](https://python-all.ru/3.3/library/cgi.html#id2) | Обратите внимание, что некоторые последние версии спецификации HTML действительно определяют порядок, в котором должны передаваться значения полей, но определение того, был ли запрос получен от соответствующего спецификации браузера, или вообще от браузера, – задача утомительная и чреватая ошибками. |307| --- | --- |308