soupsieve API reference

113 public APIs from soupsieve (facelessuser/soupsieve) — 22 classes, 20 functions, 71 methods. Signatures extracted by static analysis of the actual source.

Repository: facelessuser/soupsieve

Kind	Count
Classes	22
Functions	20
Methods	71

API list

classhatch_build.CustomMetadataHook

Our metadata hook.

classsoupsieve.__meta__.Version

Get the version (PEP 440).

funcsoupsieve.__meta__.parse_version(ver:str) -> Version

Parse version into a comparable Version tuple.

func

soupsieve.closest(select:str, tag:bs4.Tag, namespaces:dict[str, str] | None=None, flags:int=0, *custom:dict[str, str] | None=None, **kwargs:Any) -> bs4.Tag | None

Match closest ancestor.

func

soupsieve.compile(pattern:str, namespaces:dict[str, str] | None=None, flags:int=0, *custom:dict[str, str] | None=None, **kwargs:Any) -> cm.SoupSieve

Compile CSS pattern.

classsoupsieve.css_match.CSSMatch

Perform CSS matching.

methodsoupsieve.css_match.CSSMatch.closest() -> bs4.Tag | None

Match closest ancestor.

methodsoupsieve.css_match.CSSMatch.extended_language_filter(lang_range:str, lang_tag:str) -> bool

Filter the language tags.

methodsoupsieve.css_match.CSSMatch.filter() -> list[bs4.Tag]

Filter tag's children.

methodsoupsieve.css_match.CSSMatch.find_bidi(el:bs4.Tag) -> int | None

Get directionality from element text.

funcsoupsieve.css_match.CSSMatch.get_parent_form(el:bs4.Tag) -> bs4.Tag | None

Find this input's form.

methodsoupsieve.css_match.CSSMatch.get_prefix(el:bs4.Tag) -> str | None

Get prefix.

methodsoupsieve.css_match.CSSMatch.get_tag(el:bs4.Tag | None) -> str | None

Get tag.

methodsoupsieve.css_match.CSSMatch.get_tag_ns(el:bs4.Tag | None) -> str

Get tag namespace.

methodsoupsieve.css_match.CSSMatch.is_html_tag(el:bs4.Tag | None) -> bool

Check if tag is in HTML namespace.

methodsoupsieve.css_match.CSSMatch.match(el:bs4.Tag) -> bool

Match.

methodsoupsieve.css_match.CSSMatch.match_attribute_name(el:bs4.Tag, attr:str, prefix:str | None) -> str | Sequence[str] | None

Match attribute name and return value if it exists.

methodsoupsieve.css_match.CSSMatch.match_attributes(el:bs4.Tag, attributes:tuple[ct.SelectorAttribute, ...]) -> bool

Match attributes.

methodsoupsieve.css_match.CSSMatch.match_classes(el:bs4.Tag, classes:tuple[str, ...]) -> bool

Match element's classes.

methodsoupsieve.css_match.CSSMatch.match_contains(el:bs4.Tag, contains:tuple[ct.SelectorContains, ...]) -> bool

Match element if it contains text.

methodsoupsieve.css_match.CSSMatch.match_default(el:bs4.Tag) -> bool

Match default.

methodsoupsieve.css_match.CSSMatch.match_defined(el:bs4.Tag) -> bool

Match defined.

methodsoupsieve.css_match.CSSMatch.match_dir(el:bs4.Tag | None, directionality:int) -> bool

Check directionality.

methodsoupsieve.css_match.CSSMatch.match_empty(el:bs4.Tag) -> bool

Check if element is empty (if requested).

methodsoupsieve.css_match.CSSMatch.match_future_child(parent:bs4.Tag, relation:ct.SelectorList, recursive:bool=False) -> bool

Match future child.

methodsoupsieve.css_match.CSSMatch.match_future_relations(el:bs4.Tag, relation:ct.SelectorList) -> bool

Match future relationship.

methodsoupsieve.css_match.CSSMatch.match_id(el:bs4.Tag, ids:tuple[str, ...]) -> bool

Match element's ID.

methodsoupsieve.css_match.CSSMatch.match_indeterminate(el:bs4.Tag) -> bool

Match default.

methodsoupsieve.css_match.CSSMatch.match_lang(el:bs4.Tag, langs:tuple[ct.SelectorLang, ...]) -> bool

Match languages.

methodsoupsieve.css_match.CSSMatch.match_namespace(el:bs4.Tag, tag:ct.SelectorTag) -> bool

Match the namespace of the element.

methodsoupsieve.css_match.CSSMatch.match_nth(el:bs4.Tag, nth:tuple[ct.SelectorNth, ...]) -> bool

Match `nth` elements.

methodsoupsieve.css_match.CSSMatch.match_nth_tag_type(el:bs4.Tag, child:bs4.Tag) -> bool

Match tag type for `nth` matches.

methodsoupsieve.css_match.CSSMatch.match_past_relations(el:bs4.Tag, relation:ct.SelectorList) -> bool

Match past relationship.

methodsoupsieve.css_match.CSSMatch.match_placeholder_shown(el:bs4.Tag) -> bool

Match placeholder shown according to HTML spec.

methodsoupsieve.css_match.CSSMatch.match_range(el:bs4.Tag, condition:int) -> bool

Match range.

methodsoupsieve.css_match.CSSMatch.match_relations(el:bs4.Tag, relation:ct.SelectorList) -> bool

Match relationship to other elements.

methodsoupsieve.css_match.CSSMatch.match_root(el:bs4.Tag) -> bool

Match element as root.

methodsoupsieve.css_match.CSSMatch.match_scope(el:bs4.Tag) -> bool

Match element as scope.

methodsoupsieve.css_match.CSSMatch.match_selectors(el:bs4.Tag, selectors:ct.SelectorList) -> bool

Check if element matches one of the selectors.

methodsoupsieve.css_match.CSSMatch.match_subselectors(el:bs4.Tag, selectors:tuple[ct.SelectorList, ...]) -> bool

Match selectors.

methodsoupsieve.css_match.CSSMatch.match_tag(el:bs4.Tag, tag:ct.SelectorTag | None) -> bool

Match the tag.

methodsoupsieve.css_match.CSSMatch.match_tagname(el:bs4.Tag, tag:ct.SelectorTag) -> bool

Match tag name.

methodsoupsieve.css_match.CSSMatch.select(limit:int=0) -> Iterator[bs4.Tag]

Match all tags under the targeted tag.

methodsoupsieve.css_match.CSSMatch.supports_namespaces() -> bool

Check if namespaces are supported in the HTML type.

classsoupsieve.css_match.Inputs

Class for parsing and validating input items.

methodsoupsieve.css_match.Inputs.parse_value(itype:str, value:str | None) -> tuple[float, ...] | None

Parse the input value.

methodsoupsieve.css_match.Inputs.validate_day(year:int, month:int, day:int) -> bool

Validate day.

methodsoupsieve.css_match.Inputs.validate_hour(hour:int) -> bool

Validate hour.

methodsoupsieve.css_match.Inputs.validate_minutes(minutes:int) -> bool

Validate minutes.

methodsoupsieve.css_match.Inputs.validate_month(month:int) -> bool

Validate month.

methodsoupsieve.css_match.Inputs.validate_week(year:int, week:int) -> bool

Validate week.

methodsoupsieve.css_match.Inputs.validate_year(year:int) -> bool

Validate year.

classsoupsieve.css_match.SoupSieve

Compiled Soup Sieve selector matching object.

methodsoupsieve.css_match.SoupSieve.closest(tag:bs4.Tag) -> bs4.Tag | None

Match closest ancestor.

methodsoupsieve.css_match.SoupSieve.filter(iterable:Iterable[bs4.Tag]) -> list[bs4.Tag]

Filter.

methodsoupsieve.css_match.SoupSieve.iselect(tag:bs4.Tag, limit:int=0) -> Iterator[bs4.Tag]

Iterate the specified tags.

methodsoupsieve.css_match.SoupSieve.match(tag:bs4.Tag) -> bool

Match.

methodsoupsieve.css_match.SoupSieve.select(tag:bs4.Tag, limit:int=0) -> list[bs4.Tag]

Select the specified tags.

methodsoupsieve.css_match.SoupSieve.select_one(tag:bs4.Tag) -> bs4.Tag | None

Select a single tag.

classsoupsieve.css_parser.CSSParser

Parse CSS selectors.

methodsoupsieve.css_parser.CSSParser.increment_count(increment:int=1) -> None

Check the current selector count.

methodsoupsieve.css_parser.CSSParser.parse_class_id(sel:_Selector, m:Match[str], has_selector:bool) -> bool

Parse HTML classes and ids.

method

soupsieve.css_parser.CSSParser.parse_combinator(sel:_Selector, m:Match[str], has_selector:bool, selectors:list[_Selector], relations:list[_Selector], is_pseudo:bool, is_forgive:bool, index:int) -> tuple[bool, _Selector]

Parse combinator tokens.

method

soupsieve.css_parser.CSSParser.parse_has_combinator(sel:_Selector, m:Match[str], has_selector:bool, selectors:list[_Selector], rel_type:str, index:int) -> tuple[bool, _Selector, str]

Parse combinator tokens.

method

soupsieve.css_parser.CSSParser.parse_pseudo_class(sel:_Selector, m:Match[str], has_selector:bool, iselector:Iterator[tuple[str, Match[str]]], is_html:bool) -> tuple[bool, bool]

Parse pseudo class.

methodsoupsieve.css_parser.CSSParser.parse_pseudo_class_custom(sel:_Selector, m:Match[str], has_selector:bool) -> bool

Parse custom pseudo class alias.

methodsoupsieve.css_parser.CSSParser.parse_pseudo_contains(sel:_Selector, m:Match[str], has_selector:bool) -> bool

Parse contains.

methodsoupsieve.css_parser.CSSParser.parse_pseudo_dir(sel:_Selector, m:Match[str], has_selector:bool) -> bool

Parse pseudo direction.

methodsoupsieve.css_parser.CSSParser.parse_pseudo_lang(sel:_Selector, m:Match[str], has_selector:bool) -> bool

Parse pseudo language.

method

soupsieve.css_parser.CSSParser.parse_pseudo_nth(sel:_Selector, m:Match[str], has_selector:bool, iselector:Iterator[tuple[str, Match[str]]]) -> bool

Parse `nth` pseudo.

method

soupsieve.css_parser.CSSParser.parse_pseudo_open(sel:_Selector, name:str, has_selector:bool, iselector:Iterator[tuple[str, Match[str]]], index:int) -> bool

Parse pseudo with opening bracket.

method

soupsieve.css_parser.CSSParser.parse_selectors(iselector:Iterator[tuple[str, Match[str]]], index:int=0, flags:int=0) -> ct.SelectorList

Parse selectors.

methodsoupsieve.css_parser.CSSParser.parse_tag_pattern(sel:_Selector, m:Match[str], has_selector:bool) -> bool

Parse tag pattern from regex match.

methodsoupsieve.css_parser.CSSParser.process_selectors(index:int=0, flags:int=0) -> ct.SelectorList

Process selectors.

methodsoupsieve.css_parser.CSSParser.selector_iter(pattern:str) -> Iterator[tuple[str, Match[str]]]

Iterate selector tokens.

classsoupsieve.css_parser.PseudoSelectorMap

Pseudo selector map.

classsoupsieve.css_parser.SelectorPattern

Selector pattern.

methodsoupsieve.css_parser.SelectorPattern.get_name() -> str

Get name.

methodsoupsieve.css_parser.SelectorPattern.match(selector:str, index:int, flags:int) -> Match[str] | None

Match the selector.

methodsoupsieve.css_parser.SelectorPattern.re_pattern() -> re.Pattern[str]

Retrieve the compiled regular expression pattern.

classsoupsieve.css_parser.SpecialPseudoPattern

Selector pattern.

methodsoupsieve.css_parser.SpecialPseudoPattern.get_name() -> str

Get name.

methodsoupsieve.css_parser.SpecialPseudoPattern.match(selector:str, index:int, flags:int) -> Match[str] | None

Match the selector.

funcsoupsieve.css_parser.css_unescape(content:str) -> str

Unescape CSS value.

funcsoupsieve.css_parser.escape(ident:str) -> str

Escape identifier.

funcsoupsieve.css_parser.process_custom(custom:ct.CustomSelectors | None) -> dict[str, str | ct.SelectorList]

Process custom.

funcsoupsieve.css_parser.replace(m:Match[str]) -> str

Replace with the appropriate substitute.

classsoupsieve.css_types.CustomSelectors

Custom selectors.

classsoupsieve.css_types.Immutable

Immutable.

methodsoupsieve.css_types.Immutable.pretty() -> None

Pretty print.

classsoupsieve.css_types.ImmutableDict

Hashable, immutable dictionary.

classsoupsieve.css_types.Namespaces

Namespaces.

classsoupsieve.css_types.Selector

Selector.

classsoupsieve.css_types.SelectorAttribute

Selector attribute rule.

classsoupsieve.css_types.SelectorContains

Selector contains rule.

classsoupsieve.css_types.SelectorLang

Selector language rules.

classsoupsieve.css_types.SelectorList

Selector list.

classsoupsieve.css_types.SelectorNth

Selector nth type.

classsoupsieve.css_types.SelectorNull

Null Selector.

classsoupsieve.css_types.SelectorTag

Selector tag.

funcsoupsieve.css_types.pickle_register(obj:Any) -> None

Allow object to be pickled.

funcsoupsieve.escape(ident:str) -> str

Escape identifier.

func

soupsieve.filter(select:str, iterable:Iterable[bs4.Tag], namespaces:dict[str, str] | None=None, flags:int=0, *custom:dict[str, str] | None=None, **kwargs:Any) -> list[bs4.Tag]

Filter list of nodes.

func

soupsieve.iselect(select:str, tag:bs4.Tag, namespaces:dict[str, str] | None=None, limit:int=0, flags:int=0, *custom:dict[str, str] | None=None, **kwargs:Any) -> Iterator[bs4.Tag]

Iterate the specified tags.

func

soupsieve.match(select:str, tag:bs4.Tag, namespaces:dict[str, str] | None=None, flags:int=0, *custom:dict[str, str] | None=None, **kwargs:Any) -> bool

Match node.

funcsoupsieve.pretty.pretty(obj:Any) -> str

Make the object output string pretty.

funcsoupsieve.purge() -> None

Purge cached patterns.

func

soupsieve.select(select:str, tag:bs4.Tag, namespaces:dict[str, str] | None=None, limit:int=0, flags:int=0, *custom:dict[str, str] | None=None, **kwargs:Any) -> list[bs4.Tag]

Select the specified tags.

func

soupsieve.select_one(select:str, tag:bs4.Tag, namespaces:dict[str, str] | None=None, flags:int=0, *custom:dict[str, str] | None=None, **kwargs:Any) -> bs4.Tag | None

Select a single tag.

classsoupsieve.util.SelectorSyntaxError

Syntax error in a CSS selector.

funcsoupsieve.util.get_pattern_context(pattern:str, index:int) -> tuple[str, int, int]

Get the pattern context.

funcsoupsieve.util.lower(string:str) -> str

Lower.

funcsoupsieve.util.warn_deprecated(message:str, stacklevel:int=2) -> None

Warn deprecated.

About this data

These signatures were extracted from the public source of facelessuser/soupsieve using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries