2026-06-02 05:14 @216.73.216.198 CrawledBy Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)
Markdown Format | JSON API | MCP Server Tool
Help on package markupsafe: NAME markupsafe PACKAGE CONTENTS _native _speedups CLASSES builtins.str(builtins.object) Markup string.Formatter(builtins.object) EscapeFormatter class EscapeFormatter(string.Formatter) | EscapeFormatter(escape: Callable[[Any], markupsafe.Markup]) -> None | | Method resolution order: | EscapeFormatter | string.Formatter | builtins.object | | Methods defined here: | | __init__(self, escape: Callable[[Any], markupsafe.Markup]) -> None | Initialize self. See help(type(self)) for accurate signature. | | format_field(self, value: Any, format_spec: str) -> str | | ---------------------------------------------------------------------- | Data descriptors defined here: | | escape | | ---------------------------------------------------------------------- | Methods inherited from string.Formatter: | | check_unused_args(self, used_args, args, kwargs) | | convert_field(self, value, conversion) | | format(self, format_string, /, *args, **kwargs) | | get_field(self, field_name, args, kwargs) | # given a field_name, find the object it references. | # field_name: the field being looked up, e.g. "0.name" | # or "lookup[3]" | # used_args: a set of which args have been used | # args, kwargs: as passed in to vformat | | get_value(self, key, args, kwargs) | | parse(self, format_string) | # returns an iterable that contains tuples of the form: | # (literal_text, field_name, format_spec, conversion) | # literal_text can be zero length | # field_name can be None, in which case there's no | # object to format and output | # if field_name is not None, it is looked up, formatted | # with format_spec and conversion and then used | | vformat(self, format_string, args, kwargs) | | ---------------------------------------------------------------------- | Data descriptors inherited from string.Formatter: | | __dict__ | dictionary for instance variables (if defined) | | __weakref__ | list of weak references to the object (if defined) class Markup(builtins.str) | Markup(base: Any = '', encoding: Optional[str] = None, errors: str = 'strict') -> 'Markup' | | A string that is ready to be safely inserted into an HTML or XML | document, either because it was escaped or because it was marked | safe. | | Passing an object to the constructor converts it to text and wraps | it to mark it safe without escaping. To escape the text, use the | :meth:`escape` class method instead. | | >>> Markup("Hello, <em>World</em>!") | Markup('Hello, <em>World</em>!') | >>> Markup(42) | Markup('42') | >>> Markup.escape("Hello, <em>World</em>!") | Markup('Hello <em>World</em>!') | | This implements the ``__html__()`` interface that some frameworks | use. Passing an object that implements ``__html__()`` will wrap the | output of that method, marking it safe. | | >>> class Foo: | ... def __html__(self): | ... return '<a href="/foo">foo</a>' | ... | >>> Markup(Foo()) | Markup('<a href="/foo">foo</a>') | | This is a subclass of :class:`str`. It has the same methods, but | escapes their arguments and returns a ``Markup`` instance. | | >>> Markup("<em>%s</em>") % ("foo & bar",) | Markup('<em>foo & bar</em>') | >>> Markup("<em>Hello</em> ") + "<foo>" | Markup('<em>Hello</em> <foo>') | | Method resolution order: | Markup | builtins.str | builtins.object | | Methods defined here: | | __add__(self, other: Union[str, ForwardRef('HasHTML')]) -> 'Markup' | Return self+value. | | __getitem__(self, key, /) | Return self[key]. | | __html__(self) -> 'Markup' | | __html_format__(self, format_spec: str) -> 'Markup' | | __mod__(self, arg: Any) -> 'Markup' | Return self%value. | | __mul__(self, num: int) -> 'Markup' | Return self*value. | | __radd__(self, other: Union[str, ForwardRef('HasHTML')]) -> 'Markup' | | __repr__(self) -> str | Return repr(self). | | __rmul__ = __mul__(self, num: int) -> 'Markup' | | capitalize(self, /) | Return a capitalized version of the string. | | More specifically, make the first character have upper case and the rest lower | case. | | center(self, width, fillchar=' ', /) | Return a centered string of length width. | | Padding is done using the specified fill character (default is a space). | | expandtabs(self, /, tabsize=8) | Return a copy where all tab characters are expanded using spaces. | | If tabsize is not given, a tab size of 8 characters is assumed. | | format(self, *args: Any, **kwargs: Any) -> 'Markup' | S.format(*args, **kwargs) -> str | | Return a formatted version of S, using substitutions from args and kwargs. | The substitutions are identified by braces ('{' and '}'). | | join(self, seq: Iterable[Union[str, ForwardRef('HasHTML')]]) -> 'Markup' | Concatenate any number of strings. | | The string whose method is called is inserted in between each given string. | The result is returned as a new string. | | Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs' | | ljust(self, width, fillchar=' ', /) | Return a left-justified string of length width. | | Padding is done using the specified fill character (default is a space). | | lower(self, /) | Return a copy of the string converted to lowercase. | | lstrip(self, chars=None, /) | Return a copy of the string with leading whitespace removed. | | If chars is given and not None, remove characters in chars instead. | | partition(self, sep: str) -> Tuple[ForwardRef('Markup'), ForwardRef('Markup'), ForwardRef('Markup')] | Partition the string into three parts using the given separator. | | This will search for the separator in the string. If the separator is found, | returns a 3-tuple containing the part before the separator, the separator | itself, and the part after it. | | If the separator is not found, returns a 3-tuple containing the original string | and two empty strings. | | replace(self, old, new, count=-1, /) | Return a copy with all occurrences of substring old replaced by new. | | count | Maximum number of occurrences to replace. | -1 (the default value) means replace all occurrences. | | If the optional argument count is given, only the first count occurrences are | replaced. | | rjust(self, width, fillchar=' ', /) | Return a right-justified string of length width. | | Padding is done using the specified fill character (default is a space). | | rpartition(self, sep: str) -> Tuple[ForwardRef('Markup'), ForwardRef('Markup'), ForwardRef('Markup')] | Partition the string into three parts using the given separator. | | This will search for the separator in the string, starting at the end. If | the separator is found, returns a 3-tuple containing the part before the | separator, the separator itself, and the part after it. | | If the separator is not found, returns a 3-tuple containing two empty strings | and the original string. | | rsplit(self, sep: Optional[str] = None, maxsplit: int = -1) -> List[ForwardRef('Markup')] | Return a list of the substrings in the string, using sep as the separator string. | | sep | The separator used to split the string. | | When set to None (the default value), will split on any whitespace | character (including \\n \\r \\t \\f and spaces) and will discard | empty strings from the result. | maxsplit | Maximum number of splits (starting from the left). | -1 (the default value) means no limit. | | Splitting starts at the end of the string and works to the front. | | rstrip(self, chars=None, /) | Return a copy of the string with trailing whitespace removed. | | If chars is given and not None, remove characters in chars instead. | | split(self, sep: Optional[str] = None, maxsplit: int = -1) -> List[ForwardRef('Markup')] | Return a list of the substrings in the string, using sep as the separator string. | | sep | The separator used to split the string. | | When set to None (the default value), will split on any whitespace | character (including \\n \\r \\t \\f and spaces) and will discard | empty strings from the result. | maxsplit | Maximum number of splits (starting from the left). | -1 (the default value) means no limit. | | Note, str.split() is mainly useful for data that has been intentionally | delimited. With natural text that includes punctuation, consider using | the regular expression module. | | splitlines(self, keepends: bool = False) -> List[ForwardRef('Markup')] | Return a list of the lines in the string, breaking at line boundaries. | | Line breaks are not included in the resulting list unless keepends is given and | true. | | strip(self, chars=None, /) | Return a copy of the string with leading and trailing whitespace removed. | | If chars is given and not None, remove characters in chars instead. | | striptags(self) -> str | :meth:`unescape` the markup, remove tags, and normalize | whitespace to single spaces. | | >>> Markup("Main » <em>About</em>").striptags() | 'Main » About' | | swapcase(self, /) | Convert uppercase characters to lowercase and lowercase characters to uppercase. | | title(self, /) | Return a version of the string where each word is titlecased. | | More specifically, words start with uppercased characters and all remaining | cased characters have lower case. | | translate(self, table, /) | Replace each character in the string using the given translation table. | | table | Translation table, which must be a mapping of Unicode ordinals to | Unicode ordinals, strings, or None. | | The table must implement lookup/indexing via __getitem__, for instance a | dictionary or list. If this operation raises LookupError, the character is | left untouched. Characters mapped to None are deleted. | | unescape(self) -> str | Convert escaped markup back into a text string. This replaces | HTML entities with the characters they represent. | | >>> Markup("Main » <em>About</em>").unescape() | 'Main » <em>About</em>' | | upper(self, /) | Return a copy of the string converted to uppercase. | | zfill(self, width, /) | Pad a numeric string with zeros on the left, to fill a field of the given width. | | The string is never truncated. | | ---------------------------------------------------------------------- | Class methods defined here: | | escape(s: Any) -> 'Markup' from builtins.type | Escape a string. Calls :func:`escape` and ensures that for | subclasses the correct type is returned. | | ---------------------------------------------------------------------- | Static methods defined here: | | __new__(cls, base: Any = '', encoding: Optional[str] = None, errors: str = 'strict') -> 'Markup' | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Methods inherited from builtins.str: | | __contains__(self, key, /) | Return key in self. | | __eq__(self, value, /) | Return self==value. | | __format__(self, format_spec, /) | Return a formatted version of the string as described by format_spec. | | __ge__(self, value, /) | Return self>=value. | | __getattribute__(self, name, /) | Return getattr(self, name). | | __getnewargs__(...) | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __iter__(self, /) | Implement iter(self). | | __le__(self, value, /) | Return self<=value. | | __len__(self, /) | Return len(self). | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __rmod__(self, value, /) | Return value%self. | | __sizeof__(self, /) | Return the size of the string in memory, in bytes. | | __str__(self, /) | Return str(self). | | casefold(self, /) | Return a version of the string suitable for caseless comparisons. | | count(...) | S.count(sub[, start[, end]]) -> int | | Return the number of non-overlapping occurrences of substring sub in | string S[start:end]. Optional arguments start and end are | interpreted as in slice notation. | | encode(self, /, encoding='utf-8', errors='strict') | Encode the string using the codec registered for encoding. | | encoding | The encoding in which to encode the string. | errors | The error handling scheme to use for encoding errors. | The default is 'strict' meaning that encoding errors raise a | UnicodeEncodeError. Other possible values are 'ignore', 'replace' and | 'xmlcharrefreplace' as well as any other name registered with | codecs.register_error that can handle UnicodeEncodeErrors. | | endswith(...) | S.endswith(suffix[, start[, end]]) -> bool | | Return True if S ends with the specified suffix, False otherwise. | With optional start, test S beginning at that position. | With optional end, stop comparing S at that position. | suffix can also be a tuple of strings to try. | | find(...) | S.find(sub[, start[, end]]) -> int | | Return the lowest index in S where substring sub is found, | such that sub is contained within S[start:end]. Optional | arguments start and end are interpreted as in slice notation. | | Return -1 on failure. | | format_map(...) | S.format_map(mapping) -> str | | Return a formatted version of S, using substitutions from mapping. | The substitutions are identified by braces ('{' and '}'). | | index(...) | S.index(sub[, start[, end]]) -> int | | Return the lowest index in S where substring sub is found, | such that sub is contained within S[start:end]. Optional | arguments start and end are interpreted as in slice notation. | | Raises ValueError when the substring is not found. | | isalnum(self, /) | Return True if the string is an alpha-numeric string, False otherwise. | | A string is alpha-numeric if all characters in the string are alpha-numeric and | there is at least one character in the string. | | isalpha(self, /) | Return True if the string is an alphabetic string, False otherwise. | | A string is alphabetic if all characters in the string are alphabetic and there | is at least one character in the string. | | isascii(self, /) | Return True if all characters in the string are ASCII, False otherwise. | | ASCII characters have code points in the range U+0000-U+007F. | Empty string is ASCII too. | | isdecimal(self, /) | Return True if the string is a decimal string, False otherwise. | | A string is a decimal string if all characters in the string are decimal and | there is at least one character in the string. | | isdigit(self, /) | Return True if the string is a digit string, False otherwise. | | A string is a digit string if all characters in the string are digits and there | is at least one character in the string. | | isidentifier(self, /) | Return True if the string is a valid Python identifier, False otherwise. | | Call keyword.iskeyword(s) to test whether string s is a reserved identifier, | such as "def" or "class". | | islower(self, /) | Return True if the string is a lowercase string, False otherwise. | | A string is lowercase if all cased characters in the string are lowercase and | there is at least one cased character in the string. | | isnumeric(self, /) | Return True if the string is a numeric string, False otherwise. | | A string is numeric if all characters in the string are numeric and there is at | least one character in the string. | | isprintable(self, /) | Return True if the string is printable, False otherwise. | | A string is printable if all of its characters are considered printable in | repr() or if it is empty. | | isspace(self, /) | Return True if the string is a whitespace string, False otherwise. | | A string is whitespace if all characters in the string are whitespace and there | is at least one character in the string. | | istitle(self, /) | Return True if the string is a title-cased string, False otherwise. | | In a title-cased string, upper- and title-case characters may only | follow uncased characters and lowercase characters only cased ones. | | isupper(self, /) | Return True if the string is an uppercase string, False otherwise. | | A string is uppercase if all cased characters in the string are uppercase and | there is at least one cased character in the string. | | removeprefix(self, prefix, /) | Return a str with the given prefix string removed if present. | | If the string starts with the prefix string, return string[len(prefix):]. | Otherwise, return a copy of the original string. | | removesuffix(self, suffix, /) | Return a str with the given suffix string removed if present. | | If the string ends with the suffix string and that suffix is not empty, | return string[:-len(suffix)]. Otherwise, return a copy of the original | string. | | rfind(...) | S.rfind(sub[, start[, end]]) -> int | | Return the highest index in S where substring sub is found, | such that sub is contained within S[start:end]. Optional | arguments start and end are interpreted as in slice notation. | | Return -1 on failure. | | rindex(...) | S.rindex(sub[, start[, end]]) -> int | | Return the highest index in S where substring sub is found, | such that sub is contained within S[start:end]. Optional | arguments start and end are interpreted as in slice notation. | | Raises ValueError when the substring is not found. | | startswith(...) | S.startswith(prefix[, start[, end]]) -> bool | | Return True if S starts with the specified prefix, False otherwise. | With optional start, test S beginning at that position. | With optional end, stop comparing S at that position. | prefix can also be a tuple of strings to try. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.str: | | maketrans(...) | Return a translation table usable for str.translate(). | | If there is only one argument, it must be a dictionary mapping Unicode | ordinals (integers) or characters to Unicode ordinals, strings or None. | Character keys will be then converted to ordinals. | If there are two arguments, they must be strings of equal length, and | in the resulting dictionary, each character in x will be mapped to the | character at the same position in y. If there is a third argument, it | must be a string, whose characters will be mapped to None in the result. FUNCTIONS escape(...) Replace the characters ``&``, ``<``, ``>``, ``'``, and ``"`` in the string with HTML-safe sequences. Use this if you need to display text that might contain such characters in HTML. If the object has an ``__html__`` method, it is called and the return value is assumed to already be safe for HTML. :param s: An object to be converted to a string and escaped. :return: A :class:`Markup` string with the escaped text. escape_silent(...) Like :func:`escape` but treats ``None`` as the empty string. Useful with optional values, as otherwise you get the string ``'None'`` when the value is ``None``. >>> escape(None) Markup('None') >>> escape_silent(None) Markup('') soft_str(...) Convert an object to a string if it isn't already. This preserves a :class:`Markup` string rather than converting it back to a basic string, so it will still be marked as safe and won't be escaped again. >>> value = escape("<User 1>") >>> value Markup('<User 1>') >>> escape(str(value)) Markup('&lt;User 1&gt;') >>> escape(soft_str(value)) Markup('<User 1>') soft_unicode(...) VERSION 2.0.1 FILE /usr/lib/python3/dist-packages/markupsafe/__init__.py
Generated by phpMan Author: Che Dong Under GNU General Public License
2026-06-02 05:14 @216.73.216.198 CrawledBy Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)