package np

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
type tag = [
  1. | `Str
]
type t = [ `Object | `Str ] Obj.t
val of_pyobject : Py.Object.t -> t
val to_pyobject : [> tag ] Obj.t -> Py.Object.t
val create : ?object_:Py.Object.t -> unit -> t

str(object='') -> str str(bytes_or_buffer, encoding[, errors]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to 'strict'.

val __getitem__ : key:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

Return selfkey.

val __iter__ : [> tag ] Obj.t -> Py.Object.t

Implement iter(self).

val capitalize : [> tag ] Obj.t -> Py.Object.t

Return a capitalized version of the string.

More specifically, make the first character have upper case and the rest lower case.

val casefold : [> tag ] Obj.t -> Py.Object.t

Return a version of the string suitable for caseless comparisons.

val center : ?fillchar:Py.Object.t -> width:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

Return a centered string of length width.

Padding is done using the specified fill character (default is a space).

val count : ?start:Py.Object.t -> ?end_:Py.Object.t -> sub:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

S.count(sub, start[, end]) -> int

Return the number of non-overlapping occurrences of substring sub in string Sstart:end. Optional arguments start and end are interpreted as in slice notation.

val encode : ?encoding:Py.Object.t -> ?errors:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

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.

val endswith : ?start:Py.Object.t -> ?end_:Py.Object.t -> suffix:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

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.

val expandtabs : ?tabsize:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

Return a copy where all tab characters are expanded using spaces.

If tabsize is not given, a tab size of 8 characters is assumed.

val find : ?start:Py.Object.t -> ?end_:Py.Object.t -> sub:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

S.find(sub, start[, end]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within Sstart:end. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

val format : ?kwargs:(string * Py.Object.t) list -> Py.Object.t list -> [> tag ] Obj.t -> Py.Object.t

S.format( *args, **kwargs) -> str

Return a formatted version of S, using substitutions from args and kwargs. The substitutions are identified by braces ('' and '').

val format_map : mapping:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

S.format_map(mapping) -> str

Return a formatted version of S, using substitutions from mapping. The substitutions are identified by braces ('' and '').

val index : ?start:Py.Object.t -> ?end_:Py.Object.t -> sub:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

S.index(sub, start[, end]) -> int

Return the lowest index in S where substring sub is found, such that sub is contained within Sstart:end. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

val isalnum : [> tag ] Obj.t -> Py.Object.t

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.

val isalpha : [> tag ] Obj.t -> Py.Object.t

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.

val isascii : [> tag ] Obj.t -> Py.Object.t

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.

val isdecimal : [> tag ] Obj.t -> Py.Object.t

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.

val isdigit : [> tag ] Obj.t -> Py.Object.t

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.

val isidentifier : [> tag ] Obj.t -> Py.Object.t

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

val islower : [> tag ] Obj.t -> Py.Object.t

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.

val isnumeric : [> tag ] Obj.t -> Py.Object.t

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.

val isprintable : [> tag ] Obj.t -> Py.Object.t

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.

val isspace : [> tag ] Obj.t -> Py.Object.t

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.

val istitle : [> tag ] Obj.t -> Py.Object.t

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.

val isupper : [> tag ] Obj.t -> Py.Object.t

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.

val join : iterable:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

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'

val ljust : ?fillchar:Py.Object.t -> width:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

Return a left-justified string of length width.

Padding is done using the specified fill character (default is a space).

val lower : [> tag ] Obj.t -> Py.Object.t

Return a copy of the string converted to lowercase.

val lstrip : ?chars:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

Return a copy of the string with leading whitespace removed.

If chars is given and not None, remove characters in chars instead.

val partition : sep:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

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.

val replace : ?count:Py.Object.t -> old:Py.Object.t -> new_:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

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.

val rfind : ?start:Py.Object.t -> ?end_:Py.Object.t -> sub:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

S.rfind(sub, start[, end]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within Sstart:end. Optional arguments start and end are interpreted as in slice notation.

Return -1 on failure.

val rindex : ?start:Py.Object.t -> ?end_:Py.Object.t -> sub:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

S.rindex(sub, start[, end]) -> int

Return the highest index in S where substring sub is found, such that sub is contained within Sstart:end. Optional arguments start and end are interpreted as in slice notation.

Raises ValueError when the substring is not found.

val rjust : ?fillchar:Py.Object.t -> width:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

Return a right-justified string of length width.

Padding is done using the specified fill character (default is a space).

val rpartition : sep:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

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.

val rsplit : ?sep:Py.Object.t -> ?maxsplit:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

Return a list of the words in the string, using sep as the delimiter string.

sep The delimiter according which to split the string. None (the default value) means split according to any whitespace, and discard empty strings from the result. maxsplit Maximum number of splits to do. -1 (the default value) means no limit.

Splits are done starting at the end of the string and working to the front.

val rstrip : ?chars:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

Return a copy of the string with trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

val split : ?sep:Py.Object.t -> ?maxsplit:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

Return a list of the words in the string, using sep as the delimiter string.

sep The delimiter according which to split the string. None (the default value) means split according to any whitespace, and discard empty strings from the result. maxsplit Maximum number of splits to do. -1 (the default value) means no limit.

val splitlines : ?keepends:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

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.

val startswith : ?start:Py.Object.t -> ?end_:Py.Object.t -> prefix:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

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.

val strip : ?chars:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

Return a copy of the string with leading and trailing whitespace removed.

If chars is given and not None, remove characters in chars instead.

val swapcase : [> tag ] Obj.t -> Py.Object.t

Convert uppercase characters to lowercase and lowercase characters to uppercase.

val title : [> tag ] Obj.t -> Py.Object.t

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.

val translate : table:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

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.

val upper : [> tag ] Obj.t -> Py.Object.t

Return a copy of the string converted to uppercase.

val zfill : width:Py.Object.t -> [> tag ] Obj.t -> Py.Object.t

Pad a numeric string with zeros on the left, to fill a field of the given width.

The string is never truncated.

val to_string : t -> string

Print the object to a human-readable representation.

val show : t -> string

Print the object to a human-readable representation.

val pp : Stdlib.Format.formatter -> t -> unit

Pretty-print the object to a formatter.