URL-помощники

Функции для работы с URL.

Содержит реализации функций из urllib.parse, которые обрабатывают байты и строки.

class werkzeug.urls.BaseURL(scheme, netloc, path, query, fragment)

Базовый класс для URL и BytesURL.

Создаёт новый экземпляр _URLTuple(схема, доменное имя, путь, запрос, фрагмент)

Параметры:

схема (str) –
доменное имя (str) –
путь (str) –
запрос (str) –
фрагмент (str) –

property ascii_host: Optional[str]: Работает точно так же, как host, но возвращает результат, ограниченный символами ASCII. Если обнаруживается доменное имя, не соответствующее ASCII, оно пытается выполнить декодирование IDNA. Это полезно для операций с сокетами, когда URL может содержать символы с национальными особенностями.

property auth: Optional[str]: Часть аутентификации в URL, если доступна, None в противном случае.

decode_netloc()

Декодирует часть доменного имени в строку.

Тип возвращаемого значения:: str

decode_query(*args, **kwargs)

Декодирует часть запроса URL. Это сокращение вызова url_decode() для аргумента запроса. Аргументы и ключевые аргументы передаются в url_decode() без изменений.

Параметры:

args (Any) –
kwargs (Any) –

Тип возвращаемого значения:

ds.MultiDict[str, str]

encode_netloc()

Кодирует часть доменного имени в безопасный для URL ASCII формат в виде байтов.

Тип возвращаемого значения:: str

get_file_location(pathformat=None)

Возвращает кортеж с расположением файла в формате (server, location). Если доменное имя в URL пустое или указывает на localhost, оно представлено как None.

Формат pathformat по умолчанию определяется автоматически, но его необходимо задавать при работе с URL определённой системы. Поддерживаемые значения: 'windows' при работе с путями Windows или DOS и 'posix' при работе с путями posix.

Если URL не указывает на локальный файл, сервер и расположение представлены как None.

Параметры:: pathformat (Optional[str]) – Ожидаемый формат компонента пути. В настоящее время поддерживаются 'windows' и 'posix'. По умолчанию None - автоматическое определение.
Тип возвращаемого значения:: Tuple[Optional[str], Optional[str]]

property host: Optional[str]: Часть доменного имени URL, если доступна, иначе None. Доменное имя — это имя хоста или IP-адрес, указанный в URL. Порт не включён.

join(*args, **kwargs)

Объединяет этот URL с другим. Это просто функция удобства для вызова url_join() и повторного парсинга возвращаемого значения.

Параметры:

args (Any) –
kwargs (Any) –

Тип возвращаемого значения:

BaseURL

property password: Optional[str]: Пароль, если он был частью URL, None в противном случае. Подвергается URL-декодированию и всегда является строкой.

property port: Optional[int]: Порт в URL в виде целого числа, если он присутствовал, None в противном случае. Не заполняет порты по умолчанию.

property raw_password: Optional[str]: Пароль, если он был частью URL, None в противном случае. В отличие от password, этот не декодируется.

property raw_username: Optional[str]: Имя пользователя, если оно было частью URL, None в противном случае. В отличие от username, этот не декодируется.

replace(**kwargs)

Возвращает URL с теми же значениями, за исключением параметров, получивших новые значения в указанных ключевых аргументах.

Параметры:: kwargs (Any) –
Тип возвращаемого значения:: BaseURL

to_iri_tuple()

Возвращает кортеж URL, содержащий IRI. Будет пытаться декодировать как можно больше информации в URL без потери информации, аналогично тому, как это делает веб-браузер для строки URL.

Обычно более интересно непосредственно вызвать uri_to_iri(), которое вернёт строку.

Тип возвращаемого значения:: BaseURL

to_uri_tuple()

Возвращает кортеж BytesURL, содержащий URI. Кодирует всю информацию в URL в ASCII в соответствии с правилами, которым следует веб-браузер.

Обычно более интересно непосредственно вызвать iri_to_uri(), которое вернёт строку.

Тип возвращаемого значения:: BaseURL

END_OF_DOCUMENT_MARKER

to_url()

Возвращает строку или байты URL в зависимости от типа хранимой информации. Это всего лишь удобная функция для вызова url_unparse() для этого URL.

Тип возвращаемого значения:: str

property username: Optional[str]: Имя пользователя, если оно было частью URL, None в противном случае. Проходит URL-декодирование и всегда является строкой.

class werkzeug.urls.BytesURL(scheme, netloc, path, query, fragment)

Представляет собой обработанный URL в байтах.

Создает новый экземпляр _URLTuple(схема, доменное имя, путь, запрос, фрагмент)

Параметры:

схема (str) –
доменное имя (str) –
путь (str) –
запрос (str) –
фрагмент (str) –

decode(charset='utf-8', errors='replace')

Декодирует URL в кортеж, состоящий из строк. Кодировка символов используется только для пути, запроса и фрагмента.

Параметры:

кодировка символов (str) –
ошибки (str) –

Тип возвращаемого значения:

URL

encode_netloc()

Возвращает доменное имя неизменным в виде байтов.

Тип возвращаемого значения:: bytes

class werkzeug.urls.URL(scheme, netloc, path, query, fragment)

Представляет собой обработанный URL. Ведет себя как обычный кортеж, но также имеет дополнительные атрибуты, которые предоставляют более подробную информацию о URL.

Создает новый экземпляр _URLTuple(схема, доменное имя, путь, запрос, фрагмент)

Параметры:

схема (str) –
доменное имя (str) –
путь (str) –
запрос (str) –
фрагмент (str) –

encode(charset='utf-8', errors='replace')

Кодирует URL в кортеж, состоящий из байтов. Кодировка символов используется только для пути, запроса и фрагмента.

Параметры:

кодировка символов (str) –
ошибки (str) –

Тип возвращаемого значения:

BytesURL

werkzeug.urls.iri_to_uri(iri, charset='utf-8', errors='strict', safe_conversion=False)

Преобразует IRI в URI. Все символы, отличные от ASCII, и небезопасные символы приводятся к виду с использованием кодировки.

>>> iri_to_uri('http://\u2603.net/p\xe5th?q=\xe8ry%DF')
'http://xn--n3h.net/p%C3%A5th?q=%C3%A8ry%DF'

Параметры:

iri (Union[str, Tuple[str, str, str, str, str]]) – IRI для преобразования.
кодировка символов (str) – Кодировка IRI.
ошибки (str) – Обработчик ошибок для использования во время bytes.encode.
безопасное_преобразование (bool) – Возвращает URL без изменений, если он содержит только символы ASCII и без пробелов. См. объяснение ниже.

Тип возвращаемого значения:

str

Существует общая проблема с преобразованием IRI в некоторых протоколах, которые нарушают спецификацию URI. Рассмотрим следующие два IRI:

magnet:?xt=uri:whatever
itms-services://?action=download-manifest

После анализа мы не знаем, требует ли схема //, которая отбрасывается, если пустая, но передает различные значения в конечном URL, если она присутствует или нет. В этом случае можно использовать safe_conversion, которая вернет URL без изменений, если он содержит только символы ASCII и без пробелов. Это может привести к URI с необработанными символами, если он не был правильно обработан, но сохраняет семантику URL. Werkzeug использует это для заголовка Location для перенаправлений.

Изменения

Изменено в версии 0.15: Все зарезервированные символы остаются необработанными. Ранее только некоторые зарезервированные символы оставались необработанными.

Изменено в версии 0.9.6: был добавлен параметр safe_conversion.

Добавлена в версии 0.6.

END_OF_DOCUMENT_MARKER

werkzeug.urls.uri_to_iri(uri, charset='utf-8', errors='werkzeug.url_quote')

Преобразовать URI в IRI. Все допустимые символы UTF-8 снимаются с кавычек, оставляя все служебные и недопустимые символы с кавычками. Если в URL есть домен, он декодируется из Punycode.

>>> uri_to_iri("http://xn--n3h.net/p%C3%A5th?q=%C3%A8ry%DF")
'http://\u2603.net/p\xe5th?q=\xe8ry%DF'

Параметры:

uri (Union[str, Tuple[str, str, str, str, str]]) – URI для преобразования.
charset (str) – Кодировка для кодирования необработанных байтов.
errors (str) – Обработчик ошибок при bytes.encode. По умолчанию недопустимые байты остаются с кавычками.

Тип возвращаемого значения:

str

Журнал изменений

Изменено в версии 0.15: Все служебные и недопустимые символы остаются с кавычками. Раньше сохранялись только некоторые служебные символы, а недопустимые байты заменялись вместо того, чтобы оставаться с кавычками.

Добавлена в версии 0.6.

werkzeug.urls.url_decode(s, charset='utf-8', include_empty=True, errors='replace', separator='&', cls=None)

Разбор строки запроса и возвращение её в виде MultiDict.

Параметры:

s (AnyStr) – Строка запроса для разбора.
charset (str) – Декодирование байтов в строку с помощью этого набора символов. Если не указано, байты возвращаются как есть.
include_empty (bool) – Включать ключи со значениями по умолчанию в словарь.
errors (str) – Поведение обработки ошибок при декодировании байтов.
separator (str) – Разделитель между парами.
cls (Optional[Type[ds.MultiDict]]) – Контейнер для хранения результата вместо MultiDict.

Тип возвращаемого значения:

ds.MultiDict[str, str]

Журнал изменений

Изменено в версии 2.0: Параметр decode_keys устарел и будет удалён в Werkzeug 2.1.

Изменено в версии 0.5: В предыдущих версиях можно было использовать «;» и «&» для декодирования URL. Сейчас поддерживается только «&». Если вы хотите использовать «;», можно указать другой separator.

Изменено в версии 0.5: Добавлен параметр cls.

werkzeug.urls.url_decode_stream(stream, charset='utf-8', include_empty=True, errors='replace', separator=b'&', cls=None, limit=None)

Работает как url_decode(), но декодирует поток. Поведение потока и ограничения соответствуют функциям, подобным make_line_iter(). Генератор пар напрямую передаётся в cls, поэтому вы можете потреблять данные во время их разбора.

Параметры:

stream (IO[bytes]) – поток с закодированной строкой запроса
charset (str) – набор символов строки запроса. Если установлено None, декодирование не будет выполнено.
include_empty (bool) – Установите False если вы не хотите, чтобы пустые значения отображались в словаре.
errors (str) – поведение обработки ошибок при декодировании.
separator (bytes) – разделитель пар, по умолчанию &
cls (Optional[Type[ds.MultiDict]]) – необязательный класс словаря для использования. Если это не указано или None используется по умолчанию MultiDict.
limit (Optional[int]) – длина содержимого данных URL. Не нужно, если предоставлен ограниченный поток.

Тип возвращаемого значения:

ds.MultiDict[str, str]

Журнал изменений

Изменено в версии 2.0: Параметры decode_keys и return_iterator устарели и будут удалены в Werkzeug 2.1.

Добавлена в версии 0.8.

werkzeug.urls.url_encode(obj, charset='utf-8', sort=False, key=None, separator='&')

Кодирование URL-строки для словаря/MultiDict. Если значение None , оно не будет отображаться в строке результата. По умолчанию кодируются только значения в строках целевой кодировки символов.

Параметры:

obj (Union[Mapping[str, str], Iterable[Tuple[str, str]]]) – объект для кодирования в строку запроса.
charset (str) – кодировка символов строки запроса.
sort (bool) – устанавливается в True , если вы хотите отсортировать параметры по key.
separator (str) – разделитель, используемый для пар.
key (Optional[Callable[[Tuple[str, str]], Any]]) – необязательная функция для сортировки. Подробнее см. в документации sorted().

Тип возвращаемого значения:

str

Изменения

Изменено в версии 2.0: Параметр encode_keys устарел и будет удален в Werkzeug 2.1.

Изменено в версии 0.5: Добавлены параметры sort, key, и separator.

werkzeug.urls.url_encode_stream(obj, stream=None, charset='utf-8', sort=False, key=None, separator='&')

Аналогично url_encode(), но записывает результаты в объект потока. Если поток None , возвращается генератор всех закодированных пар.

Параметры:

obj (Union[Mapping[str, str], Iterable[Tuple[str, str]]]) – объект для кодирования в строку запроса.
stream (Optional[IO[str]]) – поток для записи закодированного объекта или None , если должен возвращаться итератор закодированных пар. В этом случае аргумент разделителя игнорируется.
charset (str) – кодировка символов строки запроса.
sort (bool) – устанавливается в True , если вы хотите отсортировать параметры по key.
separator (str) – разделитель, используемый для пар.
key (Optional[Callable[[Tuple[str, str]], Any]]) – необязательная функция для сортировки. Подробнее см. в документации sorted().

Тип возвращаемого значения:

None

Изменения

Изменено в версии 2.0: Параметр encode_keys устарел и будет удален в Werkzeug 2.1.

Добавлено в версии 0.8.

werkzeug.urls.url_fix(s, charset='utf-8')

Иногда вы получаете URL от пользователя, который не является действительным URL, потому что он содержит небезопасные символы, такие как пробелы и т.д. Эта функция может исправить некоторые проблемы аналогично тому, как браузеры обрабатывают вводимые пользователем данные:

>>> url_fix('http://de.wikipedia.org/wiki/Elf (Begriffskl\xe4rung)')
'http://de.wikipedia.org/wiki/Elf%20(Begriffskl%C3%A4rung)'

Параметры:

s (str) – строка с URL, которую нужно исправить.
charset (str) – целевая кодировка символов URL, если URL был передан как строка.

Тип возвращаемого значения:

str

werkzeug.urls.url_join(base, url, allow_fragments=True)

Объединяет базовый URL и, возможно, относительный URL для получения абсолютного представления последнего.

Параметры:

base (Union[str, Tuple[str, str, str, str, str]]) – базовый URL для операции объединения.
url (Union[str, Tuple[str, str, str, str, str]]) – URL для объединения.
allow_fragments (bool) – указывает, разрешены ли фрагменты.

Тип возвращаемого значения:

str

werkzeug.urls.url_parse(url, scheme=None, allow_fragments=True)

Разбирает URL из строки в кортеж URL. Если у URL нет схемы, она может быть предоставлена в качестве второго аргумента. В противном случае она игнорируется. Фрагменты URL могут быть удалены, если установить allow_fragments в False.

Обратной функцией является url_unparse().

Параметры:

url (str) – URL для разбора.
scheme (Optional[str]) – используемая по умолчанию схема, если URL является бессхемным.
allow_fragments (bool) – если установлено в False, фрагмент будет удален из URL.

Тип возвращаемого значения:

BaseURL

werkzeug.urls.url_quote(string, charset='utf-8', errors='strict', safe='/:', unsafe='')

Кодирует строку URL с заданной кодировкой.

Параметры:

s – строка для кодирования.
charset (str) – используемая кодировка.
safe (Union[str, bytes]) – необязательная последовательность безопасных символов.
unsafe (Union[str, bytes]) – необязательная последовательность небезопасных символов.
string (Union[str, bytes]) –
errors (str) –

Тип возвращаемого значения:

str

Изменения

В версии 0.9.2: Добавлен параметр unsafe.

werkzeug.urls.url_quote_plus(string, charset='utf-8', errors='strict', safe='')

Кодирует строку URL с заданной кодировкой и преобразует пробелы в “+”.

Параметры:

s – строка для кодирования.
charset (str) – используемая кодировка.
safe (str) – необязательная последовательность безопасных символов.
string (str) –
errors (str) –

Тип возвращаемого значения:

str

werkzeug.urls.url_unparse(components)

Обратная операция к url_parse(). Принимает произвольные, а также кортежи URL и возвращает URL в виде строки.

Параметры:: components (Tuple[str, str, str, str, str]) – разбор URL в виде кортежа, который должен быть преобразован в строку URL.
Тип возвращаемого значения:: str

werkzeug.urls.url_unquote(s, charset='utf-8', errors='replace', unsafe='')

Декодирование URL-строки с заданной кодировкой. Если кодировка установлена в None, декодирование не выполняется, и возвращаются исходные байты.

Параметры:

s (Union[str, bytes]) – строка для декодирования.
charset (str) – кодировка строки запроса. Если установлена в None, декодирование не выполняется.
errors (str) – обработка ошибок при декодировании.
unsafe (str) –

Тип возвращаемого значения:

str

werkzeug.urls.url_unquote_plus(s, charset='utf-8', errors='replace')

Декодирование URL-строки с заданной кодировкой и преобразованием “+” в пробел.

По умолчанию ошибки кодирования игнорируются. Если нужно другое поведение, можно установить errors на 'replace' или 'strict'.

Параметры:

s (Union[str, bytes]) – Строка для декодирования.
charset (str) – кодировка строки запроса. Если установлена в None, декодирование не выполняется.
errors (str) – Обработка ошибок при декодировании.

Тип возвращаемого значения:

str