Inheritance diagram for bs4.element.NavigableString:

Collaboration diagram for bs4.element.NavigableString:

Public Member Functions
Self	__new__ (cls, Union[str, bytes] value)

Self	__deepcopy__ (self, Dict[Any, Any] memo, bool recursive=False)

Tuple[str]	__getnewargs__ (self)

str	__getitem__ (self, Union[int\|slice] key)

str	string (self)

str	output_ready (self, _FormatterOrName formatter="minimal")

None	name (self)

None	name (self, str name)

Iterator[str]	strings (self)

Public Member Functions inherited from bs4.element.PageElement
None	setup (self, Optional[Tag] parent=None, _AtMostOneElement previous_element=None, _AtMostOneElement next_element=None, _AtMostOneElement previous_sibling=None, _AtMostOneElement next_sibling=None)

str	format_string (self, str s, Optional[_FormatterOrName] formatter)

Formatter	formatter_for_name (self, Union[_FormatterOrName, _EntitySubstitutionFunction] formatter_name)

Self	__copy__ (self)

Iterator[str]	stripped_strings (self)

str	get_text (self, str separator="", bool strip=False, Iterable[Type[NavigableString]] types=default)

Self	replace_with (self, *_InsertableElement args)

Tag	wrap (self, Tag wrap_inside)

Self	extract (self, Optional[int] _self_index=None)

None	decompose (self)

List[PageElement]	insert_before (self, *_InsertableElement args)

List[PageElement]	insert_after (self, *_InsertableElement args)

_AtMostOneTag	find_next (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, None string=None, **_StrainableAttribute kwargs)

_AtMostOneNavigableString	find_next (self, None name=None, None attrs=None, _StrainableString string="", **_StrainableAttribute kwargs)

Union[_AtMostOneTag, _AtMostOneNavigableString, _AtMostOneElement]	find_next (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, Optional[_StrainableString] string=None, **_StrainableAttribute kwargs)

_SomeTags	find_all_next (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, None string=None, Optional[int] limit=None, int _stacklevel=2, **_StrainableAttribute kwargs)

_SomeNavigableStrings	find_all_next (self, None name=None, None attrs=None, _StrainableString string="", Optional[int] limit=None, int _stacklevel=2, **_StrainableAttribute kwargs)

Union[_SomeTags, _SomeNavigableStrings, _QueryResults]	find_all_next (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, Optional[_StrainableString] string=None, Optional[int] limit=None, int _stacklevel=2, **_StrainableAttribute kwargs)

_AtMostOneTag	find_next_sibling (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, None string=None, **_StrainableAttribute kwargs)

_AtMostOneNavigableString	find_next_sibling (self, None name=None, None attrs=None, _StrainableString string="", **_StrainableAttribute kwargs)

Union[_AtMostOneTag, _AtMostOneNavigableString, _AtMostOneElement]	find_next_sibling (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, Optional[_StrainableString] string=None, **_StrainableAttribute kwargs)

_SomeTags	find_next_siblings (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, None string=None, Optional[int] limit=None, int _stacklevel=2, **_StrainableAttribute kwargs)

_SomeNavigableStrings	find_next_siblings (self, None name=None, None attrs=None, _StrainableString string="", Optional[int] limit=None, int _stacklevel=2, **_StrainableAttribute kwargs)

Union[_SomeTags, _SomeNavigableStrings, _QueryResults]	find_next_siblings (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, Optional[_StrainableString] string=None, Optional[int] limit=None, int _stacklevel=2, **_StrainableAttribute kwargs)

_AtMostOneTag	find_previous (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, None string=None, **_StrainableAttribute kwargs)

_AtMostOneNavigableString	find_previous (self, None name=None, None attrs=None, _StrainableString string="", **_StrainableAttribute kwargs)

Union[_AtMostOneTag, _AtMostOneNavigableString, _AtMostOneElement]	find_previous (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, Optional[_StrainableString] string=None, **_StrainableAttribute kwargs)

_SomeTags	find_all_previous (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, None string=None, Optional[int] limit=None, int _stacklevel=2, **_StrainableAttribute kwargs)

_SomeNavigableStrings	find_all_previous (self, None name=None, None attrs=None, _StrainableString string="", Optional[int] limit=None, int _stacklevel=2, **_StrainableAttribute kwargs)

Union[_SomeTags, _SomeNavigableStrings, _QueryResults]	find_all_previous (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, Optional[_StrainableString] string=None, Optional[int] limit=None, int _stacklevel=2, **_StrainableAttribute kwargs)

_AtMostOneTag	find_previous_sibling (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, None string=None, **_StrainableAttribute kwargs)

_AtMostOneNavigableString	find_previous_sibling (self, None name=None, None attrs=None, _StrainableString string="", **_StrainableAttribute kwargs)

Union[_AtMostOneTag, _AtMostOneNavigableString, _AtMostOneElement]	find_previous_sibling (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, Optional[_StrainableString] string=None, **_StrainableAttribute kwargs)

_SomeTags	find_previous_siblings (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, None string=None, Optional[int] limit=None, int _stacklevel=2, **_StrainableAttribute kwargs)

_SomeNavigableStrings	find_previous_siblings (self, None name=None, None attrs=None, _StrainableString string="", Optional[int] limit=None, int _stacklevel=2, **_StrainableAttribute kwargs)

Union[_SomeTags, _SomeNavigableStrings, _QueryResults]	find_previous_siblings (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, Optional[_StrainableString] string=None, Optional[int] limit=None, int _stacklevel=2, **_StrainableAttribute kwargs)

_AtMostOneTag	find_parent (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, **_StrainableAttribute kwargs)

_SomeTags	find_parents (self, _FindMethodName name=None, Optional[_StrainableAttributes] attrs=None, Optional[int] limit=None, int _stacklevel=2, **_StrainableAttribute kwargs)

_AtMostOneElement	next (self)

_AtMostOneElement	previous (self)

Iterator[PageElement]	next_elements (self)

Iterator[PageElement]	self_and_next_elements (self)

Iterator[PageElement]	next_siblings (self)

Iterator[PageElement]	self_and_next_siblings (self)

Iterator[PageElement]	previous_elements (self)

Iterator[PageElement]	self_and_previous_elements (self)

Iterator[PageElement]	previous_siblings (self)

Iterator[PageElement]	self_and_previous_siblings (self)

Iterator[Tag]	parents (self)

Iterator[PageElement]	self_and_parents (self)

bool	decomposed (self)

Iterator[PageElement]	nextGenerator (self)

Iterator[PageElement]	nextSiblingGenerator (self)

Iterator[PageElement]	previousGenerator (self)

Iterator[PageElement]	previousSiblingGenerator (self)

Iterator[PageElement]	parentGenerator (self)

Static Public Attributes
str	PREFIX = ""

str	SUFFIX = ""

Static Public Attributes inherited from bs4.element.PageElement
Optional	known_xml = None

Optional	parent [Tag]

_AtMostOneElement	next_element

_AtMostOneElement	previous_element

_AtMostOneElement	next_sibling

_AtMostOneElement	previous_sibling

bool	hidden = False

	nextSibling = _deprecated_alias("nextSibling", "next_sibling", "4.0.0")

	previousSibling = _deprecated_alias("previousSibling", "previous_sibling", "4.0.0")

Iterable	default = tuple()

str	getText = get_text

	replaceWith = _deprecated_function_alias("replaceWith", "replace_with", "4.0.0")

	findNext = _deprecated_function_alias("findNext", "find_next", "4.0.0")

	findAllNext = _deprecated_function_alias("findAllNext", "find_all_next", "4.0.0")

	findNextSibling

	findNextSiblings

	fetchNextSiblings

	findPrevious = _deprecated_function_alias("findPrevious", "find_previous", "3.0.0")

	findAllPrevious

	fetchAllPrevious

	findPreviousSibling

	findPreviousSiblings

	fetchPreviousSiblings

	findParent = _deprecated_function_alias("findParent", "find_parent", "4.0.0")

	findParents = _deprecated_function_alias("findParents", "find_parents", "4.0.0")

	fetchParents = _deprecated_function_alias("fetchParents", "find_parents", "3.0.0")

Protected Member Functions
Iterator[str]	_all_strings (self, bool strip=False, _OneOrMoreStringTypes types=PageElement.default)

Protected Member Functions inherited from bs4.element.PageElement
bool	_is_xml (self)

_AtMostOneElement	_last_descendant (self, bool is_initialized=True, bool accept_self=True)

_AtMostOneElement	_find_one (self, Callable method, _FindMethodName name, Optional[_StrainableAttributes] attrs, Optional[_StrainableString] string, **_StrainableAttribute kwargs)

_QueryResults	_find_all (self, _FindMethodName name, Optional[_StrainableAttributes] attrs, Optional[_StrainableString] string, Optional[int] limit, Iterator[PageElement] generator, int _stacklevel=3, **_StrainableAttribute kwargs)

Iterator[PageElement]	_self_and (self, Iterator[PageElement] other_generator)

Additional Inherited Members
Public Attributes inherited from bs4.element.PageElement
	parent

	previous_element

	next_element

	next_sibling

	previous_sibling

	find_all_next

	next_elements

	find_next_siblings

	next_siblings

	find_all_previous

	previous_elements

	find_previous_siblings

	previous_siblings

	parents

Static Protected Attributes inherited from bs4.element.PageElement
bool	_decomposed

	_lastRecursiveChild

Properties inherited from bs4.element.PageElement
	text = property(get_text)

Detailed Description

A Python string that is part of a parse tree.

When Beautiful Soup parses the markup ``<b>penguin</b>``, it will
create a `NavigableString` for the string "penguin".

Member Function Documentation

◆ deepcopy()

Self bs4.element.NavigableString.__deepcopy__	(		self,
		Dict[Any, Any]	memo,
		bool	recursive = `False`
	)

A copy of a NavigableString has the same contents and class
as the original, but it is not connected to the parse tree.

:param recursive: This parameter is ignored; it's only defined
   so that NavigableString.__deepcopy__ implements the same
   signature as Tag.__deepcopy__.

Reimplemented from bs4.element.PageElement.

◆ getitem()

str bs4.element.NavigableString.__getitem__	(		self,
		Union[int\|slice]	key
	)

Raise an exception

◆ new()

Self bs4.element.NavigableString.__new__	(		cls,
		Union[str, bytes]	value
	)

Create a new NavigableString.

When unpickling a NavigableString, this method is called with
the string in DEFAULT_OUTPUT_ENCODING. That encoding needs to be
passed in to the superclass's __new__ or the superclass won't know
how to handle non-ASCII characters.

◆ _all_strings()

Iterator[str] bs4.element.NavigableString._all_strings	(		self,
		bool	strip = `False`,
		_OneOrMoreStringTypes	types = `PageElement.default`
	)

protected

Yield all strings of certain classes, possibly stripping them.

This makes it easy for NavigableString to implement methods
like get_text() as conveniences, creating a consistent
text-extraction API across all PageElements.

:param strip: If True, all strings will be stripped before being
    yielded.

:param types: A tuple of NavigableString subclasses. If this
    NavigableString isn't one of those subclasses, the
    sequence will be empty. By default, the subclasses
    considered are NavigableString and CData objects. That
    means no comments, processing instructions, etc.

:yield: A sequence that either contains this string, or is empty.

Reimplemented from bs4.element.PageElement.

◆ name() [1/2]

None bs4.element.NavigableString.name ( self )

Since a NavigableString is not a Tag, it has no .name.

This property is implemented so that code like this doesn't crash
when run on a mixture of Tag and NavigableString objects:
    [x.name for x in tag.children]

:meta private:

◆ name() [2/2]

None bs4.element.NavigableString.name	(		self,
		str	name
	)

Prevent NavigableString.name from ever being set.

:meta private:

◆ output_ready()

str bs4.element.NavigableString.output_ready	(		self,
		_FormatterOrName	formatter = `"minimal"`
	)

Run the string through the provided formatter, making it
ready for output as part of an HTML or XML document.

:param formatter: A `Formatter` object, or a string naming one
    of the standard formatters.

Reimplemented in bs4.element.PreformattedString.

◆ string()

str bs4.element.NavigableString.string ( self )

Convenience property defined to match `Tag.string`.

:return: This property always returns the `NavigableString` it was
   called on.

:meta private:

◆ strings()

Iterator[str] bs4.element.NavigableString.strings ( self )

Yield this string, but only if it is interesting.

This is defined the way it is for compatibility with
`Tag.strings`. See `Tag` for information on which strings are
interesting in a given context.

:yield: A sequence that either contains this string, or is empty.

The documentation for this class was generated from the following file:

docs/help/help-venv/lib/python3.12/site-packages/bs4/element.py

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members