yarl の API リファレンス

yarl (aio-libs/yarl) の公開 API 69 件 —— クラス 3、関数 22、メソッド 44。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

種別	件数
クラス	3
関数	22
メソッド	44

API 一覧

func

packaging.pep517_backend._backend.build_editable(wheel_directory:str, config_settings:_ConfigDict | None=None, metadata_directory:str | None=None) -> str

Produce a built wheel for editable installs.

func

packaging.pep517_backend._backend.build_wheel(wheel_directory:str, config_settings:_ConfigDict | None=None, metadata_directory:str | None=None) -> str

Produce a built wheel.

funcpackaging.pep517_backend._compat.chdir_cm(path:'os.PathLike[str]') -> _c.Iterator[None]

Temporarily change the current directory, recovering on exit.

classpackaging.pep517_backend._cython_configuration.Config

Data structure for the TOML config.

func

packaging.pep517_backend._transformers.get_cli_kwargs_from_config(kwargs_map:dict[str, str | dict[str, str]]) -> list[str]

Make a list of options with values from config.

funcpackaging.pep517_backend._transformers.get_enabled_cli_flags_from_config(flags_map:_c.Mapping[str, bool]) -> list[str]

Make a list of enabled boolean flags from config.

funcpackaging.pep517_backend._transformers.sanitize_rst_roles(rst_source_text:str) -> str

Replace RST roles with inline highlighting.

funcpackaging.pep517_backend.cli.run_main_program(argv:_c.Sequence[str]) -> int | str

Invoke ``translate-cython`` or fail.

func

yarl._parse.make_netloc(user:str | None, password:str | None, host:str | None, port:int | None, encode:bool=False) -> str

Make netloc from parts.

funcyarl._parse.query_to_pairs(query_string:str) -> list[tuple[str, str]]

Parse a query given as a string argument.

funcyarl._parse.split_netloc(netloc:str) -> tuple[str | None, str | None, str | None, int | None]

Split netloc into username, password, host and port.

funcyarl._parse.split_url(url:str) -> SplitURLType

Split URL into parts.

funcyarl._parse.unsplit_result(scheme:str, netloc:str, url:str, query:str, fragment:str) -> str

Unsplit a URL without any normalization.

funcyarl._path.normalize_path_segments(segments:Sequence[str]) -> list[str]

Drop '.' and '..' from a sequence of str segments

funcyarl._query.get_str_query(*args:Any, **kwargs:Any) -> str | None

Return a query string from supported args.

funcyarl._query.get_str_query_from_iterable(items:Iterable[tuple[str | istr, SimpleQuery]]) -> str

Return a query string from an iterable.

funcyarl._query.query_var(v:SimpleQuery) -> str

Convert a query variable to a string.

classyarl._url.CacheInfo

Host encoding cache.

methodyarl._url.URL.absolute() -> bool

A check for absolute URLs.

methodyarl._url.URL.authority() -> str

Decoded authority part of URL.

method

yarl._url.URL.build(*scheme:str='', *authority:str='', *user:str | None=None, *password:str | None=None, *host:str='', *port:int | None=None, *path:str='', *query:Query | None=None, *query_string:str='', *fragment:str='', *encoded:bool=False) -> 'URL'

Creates and returns a new URL

methodyarl._url.URL.explicit_port() -> int | None

Port part of URL, without scheme-based fallback.

methodyarl._url.URL.fragment() -> str

Decoded fragment part of URL.

methodyarl._url.URL.host() -> str | None

Decoded host part of URL.

methodyarl._url.URL.host_port_subcomponent() -> str | None

Return the host and port subcomponent part of URL.

methodyarl._url.URL.host_subcomponent() -> str | None

Return the host subcomponent part of URL.

methodyarl._url.URL.human_repr() -> str

Return decoded human readable string for URL representation.

methodyarl._url.URL.is_absolute() -> bool

A check for absolute URLs.

methodyarl._url.URL.is_default_port() -> bool

A check for default port.

methodyarl._url.URL.joinpath(*encoded:bool=False, *other:str) -> 'URL'

Return a new URL with the elements in other appended to the path.

methodyarl._url.URL.name() -> str

The last part of parts.

methodyarl._url.URL.origin() -> 'URL'

Return an URL with scheme, host and port parts only.

methodyarl._url.URL.parts() -> tuple[str, ...]

A tuple containing decoded *path* parts.

methodyarl._url.URL.password() -> str | None

Decoded password part of URL.

methodyarl._url.URL.path() -> str

Decoded path of URL.

methodyarl._url.URL.path_qs() -> str

Decoded path of URL with query.

methodyarl._url.URL.path_safe() -> str

Decoded path of URL.

methodyarl._url.URL.port() -> int | None

Port part of URL, with scheme-based fallback.

methodyarl._url.URL.query_string() -> str

Decoded query part of URL.

methodyarl._url.URL.raw_authority() -> str

Encoded authority part of URL.

methodyarl._url.URL.raw_fragment() -> str

Encoded fragment part of URL.

methodyarl._url.URL.raw_host() -> str | None

Encoded host part of URL.

methodyarl._url.URL.raw_name() -> str

The last part of raw_parts.

methodyarl._url.URL.raw_parts() -> tuple[str, ...]

A tuple containing encoded *path* parts.

methodyarl._url.URL.raw_password() -> str | None

Encoded password part of URL.

methodyarl._url.URL.raw_path() -> str

Encoded path of URL.

methodyarl._url.URL.raw_path_qs() -> str

Encoded path of URL with query.

methodyarl._url.URL.raw_query_string() -> str

Encoded query part of URL.

methodyarl._url.URL.raw_user() -> str | None

Encoded user part of URL.

methodyarl._url.URL.relative() -> 'URL'

Return a relative part of the URL.

methodyarl._url.URL.scheme() -> str

Scheme for absolute URLs.

methodyarl._url.URL.user() -> str | None

Decoded user part of URL.

methodyarl._url.URL.with_fragment(fragment:str | None) -> 'URL'

Return a new URL with fragment replaced.

methodyarl._url.URL.with_host(host:str) -> 'URL'

Return a new URL with host replaced.

methodyarl._url.URL.with_name(name:str, *keep_query:bool=False, *keep_fragment:bool=False) -> 'URL'

Return a new URL with name (last part of path) replaced.

methodyarl._url.URL.with_password(password:str | None) -> 'URL'

Return a new URL with password replaced.

methodyarl._url.URL.with_path(path:str, *encoded:bool=False, *keep_query:bool=False, *keep_fragment:bool=False) -> 'URL'

Return a new URL with path replaced.

methodyarl._url.URL.with_port(port:int | None) -> 'URL'

Return a new URL with port replaced.

methodyarl._url.URL.with_scheme(scheme:str) -> 'URL'

Return a new URL with scheme replaced.

methodyarl._url.URL.with_suffix(suffix:str, *keep_query:bool=False, *keep_fragment:bool=False) -> 'URL'

Return a new URL with suffix (file extension of name) replaced.

methodyarl._url.URL.with_user(user:str | None) -> 'URL'

Return a new URL with user replaced.

methodyarl._url.URL.without_query_params(*query_params:str) -> 'URL'

Remove some keys from query part and return new URL.

classyarl._url.UndefinedType

Singleton type for use with not set sentinel values.

func

yarl._url.build_pre_encoded_url(scheme:str, authority:str, user:str | None, password:str | None, host:str, port:int | None, path:str, query_string:str, fragment:str) -> 'URL'

Build a pre-encoded URL from parts.

funcyarl._url.cache_clear() -> None

Clear all LRU caches.

funcyarl._url.cache_info() -> CacheInfo

Report cache statistics.

funcyarl._url.encode_url(url_str:str) -> 'URL'

Parse unencoded URL.

funcyarl._url.from_parts_uncached(scheme:str, netloc:str, path:str, query:str, fragment:str) -> 'URL'

Create a new URL from parts.

funcyarl._url.pre_encoded_url(url_str:str) -> 'URL'

Parse pre-encoded URL.

この情報について

掲載しているシグネチャは aio-libs/yarl の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る