Справочные данные по 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) –

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

werkzeug.urls.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) –
Тип возвращаемого значения: werkzeug.urls.BaseURL

to_iri_tuple()

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

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

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

to_uri_tuple()

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

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

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

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) –

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

werkzeug.urls.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) –

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

werkzeug.urls.BytesURL

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

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

>>> 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.

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 , если требуется итератор по закодированным парам. В этом случае параметр separator игнорируется.
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

END_OF_DOCUMENT_MARKER

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.

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

werkzeug.urls.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-строку с указанной кодировкой. Если charset установлен в 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