Module invenio_rest_api_client.models

Contains all the data models used in inputs/outputs

Sub-modules

Classes

AcceptARequestBody

class AcceptARequestBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Access

class Access(
    record: invenio_rest_api_client.models.access_record.AccessRecord,
    files: invenio_rest_api_client.models.access_files.AccessFiles,
    embargo: invenio_rest_api_client.types.Unset | ForwardRef('Embargo') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Denotes record-specific read (visibility) options.

More informations can be found on InvenioRDM Official page: https://inveniordm.docs.cern.ch/reference/metadata/#access

Attributes:
    record (AccessRecord): Read access to the record.

        `public` means anyone can see the record/files, `restricted` means only the owner(s) or specific users can see
        the record/files.
    files (AccessFiles): Read access to the record's files.

        `public` means anyone can see the record/files, `restricted` means only the owner(s) or specific users can see
        the record/files.
    embargo (Union[Unset, Embargo]): Only in the cases of `"record": "restricted"`` or `"files": "restricted"`` can
        an embargo be provided as input.
        However, once an embargo is lifted, the embargo section is kept for transparency.

        Denotes when an embargo must be lifted, at which point the record is made publicly accessible.

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

embargo

files

record

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AccessFiles

class AccessFiles(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

PUBLIC

RESTRICTED

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

AccessRecord

class AccessRecord(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

PUBLIC

RESTRICTED

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

AddGroupMembersBody

class AddGroupMembersBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AdditionalDescription

class AdditionalDescription(
    description: str,
    type_: 'AdditionalDescriptionType',
    lang: invenio_rest_api_client.types.Unset | ForwardRef('Lang') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Additional description in addition to the primary description (e.g. abstracts in other languages), methods or

further notes.

Attributes:
    description (str): Free text.
    type_ (AdditionalDescriptionType): The type of the description.
    lang (Union[Unset, Lang]): The language of the associated item.

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

description

lang

type_

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AdditionalDescriptionType

class AdditionalDescriptionType(
    id: invenio_rest_api_client.models.additional_description_type_id.AdditionalDescriptionTypeId,
    title: 'AdditionalDescriptionTypeTitle'
)

The type of the description.

Attributes

Name	Type	Description	Default
id	AdditionalDescriptionTypeId	Description type id from the controlled vocabulary	None
title	AdditionalDescriptionTypeTitle	The corresponding localized human readable label.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

id

title

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AdditionalDescriptionTypeId

class AdditionalDescriptionTypeId(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

ABSTRACT

METHODS

OTHER

SERIES_INFORMATION

TABLE_OF_CONTENTS

TECHNICAL_INFO

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

AdditionalDescriptionTypeTitle

class AdditionalDescriptionTypeTitle(

)

The corresponding localized human readable label.

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AdditionalTitle

class AdditionalTitle(
    title: str,
    type_: 'AdditionalTitleType',
    lang: invenio_rest_api_client.types.Unset | ForwardRef('Lang') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Additional name or title by which a resource is known.

Attributes

Name	Type	Description	Default
title	str	The additional title.	None
type_	AdditionalTitleType	The type of the title.	None
lang	Union[Unset, Lang]	The language of the associated item.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

lang

title

type_

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AdditionalTitleType

class AdditionalTitleType(
    id: invenio_rest_api_client.models.additional_title_type_id.AdditionalTitleTypeId,
    title: 'AdditionalTitleTypeTitle'
)

The type of the title.

Attributes

Name	Type	Description	Default
id	AdditionalTitleTypeId	Title type id from the controlled vocabulary.	None
title	AdditionalTitleTypeTitle	The corresponding localized human readable label	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

id

title

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AdditionalTitleTypeId

class AdditionalTitleTypeId(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

ALTERNATIVE_TITLE

OTHER

SUBTITLE

TRANSLATED_TITLE

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

AdditionalTitleTypeTitle

class AdditionalTitleTypeTitle(

)

The corresponding localized human readable label

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Affiliation

class Affiliation(
    id: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    name: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Affilations if person_or_org.type is personal.

Attributes

Name	Type	Description	Default
id	Union[Unset, str]	The organizational or institutional id from the controlled vocabulary.	None
name	Union[Unset, str]	The name of the organisation or institution.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

id

name

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AlternateIdentifier

class AlternateIdentifier(
    identifier: str,
    scheme: invenio_rest_api_client.models.identifier_scheme.IdentifierScheme
)

Persistent identifier for the resource other than the ones registered as system-managed internal or external

persistent identifiers.

Attributes:
    identifier (str): identifier value
    scheme (IdentifierScheme): The scheme of the identifier

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

identifier

scheme

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AuditLogEntry

class AuditLogEntry(
    id: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    created: invenio_rest_api_client.types.Unset | datetime.datetime = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    action: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    resource: invenio_rest_api_client.types.Unset | ForwardRef('AuditLogEntryResource') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    metadata: invenio_rest_api_client.types.Unset | ForwardRef('AuditLogEntryMetadata') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    user: invenio_rest_api_client.types.Unset | ForwardRef('AuditLogEntryUser') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    links: invenio_rest_api_client.types.Unset | ForwardRef('AuditLogEntryLinks') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Conflict - Resource already exists or operation conflicts

Attributes

Name	Type	Description	Default
id	Union[Unset, str]	Unique identifier for the log entry Example: 9913abd2-1a7c-42cb-a73e-e48a9e1bf4f2.	None
created	Union[Unset, datetime.datetime]	Timestamp when the log entry was created Example: 2025-06-20T08:05:27.730677+00:00.	None
action	Union[Unset, str]	Action performed Example: record.publish.	None
resource	Union[Unset, AuditLogEntryResource]	Resource affected by the action	None
metadata	Union[Unset, AuditLogEntryMetadata]	Additional metadata about the log entry	None
user	Union[Unset, AuditLogEntryUser]	User who performed the action	None
links	Union[Unset, AuditLogEntryLinks]	Links related to the log entry	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

action

additional_keys

additional_properties

created

id

links

metadata

resource

user

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AuditLogEntryLinks

class AuditLogEntryLinks(
    self_: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Links related to the log entry

Attributes

Name	Type	Description	Default
self_	Union[Unset, str]	Self link to the log entry Example: https://example.com/api/audit- logs/9913abd2-1a7c-42cb-a73e-e48a9e1bf4f2.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

self_

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AuditLogEntryMetadata

class AuditLogEntryMetadata(
    ip_address: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    session: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    parent_pid: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    revision_id: invenio_rest_api_client.types.Unset | int = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Additional metadata about the log entry

Attributes

Name	Type	Description	Default
ip_address	Union[Unset, str]	IP address from which the action was performed	None
session	Union[Unset, str]	Session identifier	None
parent_pid	Union[Unset, str]	Parent persistent identifier Example: 1av3p-t2p41.	None
revision_id	Union[Unset, int]	Revision ID of the resource Example: 110.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

ip_address

parent_pid

revision_id

session

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AuditLogEntryResource

class AuditLogEntryResource(
    type_: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    id: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Resource affected by the action

Attributes

Name	Type	Description	Default
type_	Union[Unset, str]	Type of the resource Example: record.	None
id	Union[Unset, str]	ID of the resource Example: 5anb0-85626.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

id

type_

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AuditLogEntryUser

class AuditLogEntryUser(
    id: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    username: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    email: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

User who performed the action

Attributes

Name	Type	Description	Default
id	Union[Unset, str]	User ID Example: 2.	None
username	Union[Unset, str]	Username Example: user.	None
email	Union[Unset, str]	User email address Example: user@demo.org.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

email

id

username

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AuditLogList

class AuditLogList(
    hits: invenio_rest_api_client.types.Unset | ForwardRef('AuditLogListHits') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    aggregations: invenio_rest_api_client.types.Unset | ForwardRef('AuditLogListAggregations') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Attributes:

hits (Union[Unset, AuditLogListHits]): aggregations (Union[Unset, AuditLogListAggregations]): Aggregation results (if any)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

aggregations

hits

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AuditLogListAggregations

class AuditLogListAggregations(

)

Aggregation results (if any)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AuditLogListHits

class AuditLogListHits(
    total: invenio_rest_api_client.types.Unset | int = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    hits: invenio_rest_api_client.types.Unset | list['AuditLogEntry'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Attributes:

total (Union[Unset, int]): Total number of log entries hits (Union[Unset, list['AuditLogEntry']]):

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

hits

total

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Award

class Award(
    id: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    title: invenio_rest_api_client.types.Unset | ForwardRef('AwardTitle') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    number: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    identifiers: invenio_rest_api_client.types.Unset | list['AwardIdentifier'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

The award (grant) sponsored by the funder.

Attributes

Name	Type	Description	Default
id	Union[Unset, str]	The award id from the controlled vocabulary.	None
title	Union[Unset, AwardTitle]	The localized title of the award.	None
number	Union[Unset, str]	The code assigned by the funder to a sponsored award (grant).	None
identifiers	Union[Unset, list['AwardIdentifier']]	Identifiers for the award.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

id

identifiers

number

title

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AwardIdentifier

class AwardIdentifier(
    scheme: str,
    identifier: str
)

Identifier for the award.

Attributes

Name	Type	Description	Default
scheme	str	The identifier scheme.	None
identifier	str	Actual value of the identifier.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

identifier

scheme

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

AwardTitle

class AwardTitle(

)

The localized title of the award.

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

CancelARequestBody

class CancelARequestBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

CreateACommunityBody

class CreateACommunityBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

CreateADraftRecordBody

class CreateADraftRecordBody(
    access: invenio_rest_api_client.types.Unset | ForwardRef('Access') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    files: invenio_rest_api_client.types.Unset | ForwardRef('Files') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    metadata: invenio_rest_api_client.types.Unset | ForwardRef('Metadata') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    custom_fields: invenio_rest_api_client.types.Unset | ForwardRef('CreateADraftRecordBodyCustomFields') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    pids: invenio_rest_api_client.types.Unset | ForwardRef('PIDs') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Attributes:

access (Union[Unset, Access]): Denotes record-specific read (visibility) options.

More informations can be found on InvenioRDM Official page:
https://inveniordm.docs.cern.ch/reference/metadata/#access

files (Union[Unset, Files]): Files options for the record.

More informations can be found on InvenioRDM Official page:
https://inveniordm.docs.cern.ch/reference/rest_api_drafts_records/#files-options

metadata (Union[Unset, Metadata]): Metadata schema of bibliographic records in InvenioRDM.

More informations can be found on InvenioRDM Official page:
https://inveniordm.docs.cern.ch/reference/metadata/#metadata

custom_fields (Union[Unset, CreateADraftRecordBodyCustomFields]): pids (Union[Unset, PIDs]):

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

access

additional_keys

additional_properties

custom_fields

files

metadata

pids

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

CreateADraftRecordBodyCustomFields

class CreateADraftRecordBodyCustomFields(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

CreateAFeaturedCommunityEntryBody

class CreateAFeaturedCommunityEntryBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

CreateASetBody

class CreateASetBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

CreateAnAccessLinkBody

class CreateAnAccessLinkBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Created

class Created(
    access: invenio_rest_api_client.types.Unset | ForwardRef('Access') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    created: invenio_rest_api_client.types.Unset | datetime.datetime = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    expires_at: invenio_rest_api_client.types.Unset | datetime.datetime = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    files: invenio_rest_api_client.types.Unset | ForwardRef('Files') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    id: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    is_published: invenio_rest_api_client.types.Unset | bool = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    links: invenio_rest_api_client.types.Unset | ForwardRef('CreatedLinks') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    metadata: invenio_rest_api_client.types.Unset | ForwardRef('CreatedMetadata') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    parent: invenio_rest_api_client.types.Unset | ForwardRef('CreatedParent') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    pids: invenio_rest_api_client.types.Unset | ForwardRef('PIDs') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    revision_id: invenio_rest_api_client.types.Unset | int = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    updated: invenio_rest_api_client.types.Unset | datetime.datetime = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    versions: invenio_rest_api_client.types.Unset | ForwardRef('Version') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Attributes:

access (Union[Unset, Access]): Denotes record-specific read (visibility) options.

More informations can be found on InvenioRDM Official page:
https://inveniordm.docs.cern.ch/reference/metadata/#access

created (Union[Unset, datetime.datetime]): expires_at (Union[Unset, datetime.datetime]): files (Union[Unset, Files]): Files options for the record.

More informations can be found on InvenioRDM Official page:
https://inveniordm.docs.cern.ch/reference/rest_api_drafts_records/#files-options

id (Union[Unset, str]): is_published (Union[Unset, bool]): links (Union[Unset, CreatedLinks]): metadata (Union[Unset, CreatedMetadata]): parent (Union[Unset, CreatedParent]): pids (Union[Unset, PIDs]): revision_id (Union[Unset, int]): updated (Union[Unset, datetime.datetime]): versions (Union[Unset, Version]):

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

access

additional_keys

additional_properties

created

expires_at

files

id

is_published

links

metadata

parent

pids

revision_id

updated

versions

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

CreatedLinks

class CreatedLinks(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

CreatedMetadata

class CreatedMetadata(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

CreatedParent

class CreatedParent(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

CreateupdateAReviewRequestBody

class CreateupdateAReviewRequestBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

CreateupdateAReviewRequestResponse200

class CreateupdateAReviewRequestResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Creator

class Creator(
    person_or_org: 'PersonOrOrg',
    role: invenio_rest_api_client.types.Unset | ForwardRef('Role') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    affiliations: invenio_rest_api_client.types.Unset | list['Affiliation'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Attributes:

person_or_org (PersonOrOrg): The person or organization. role (Union[Unset, Role]): The role of the person or organisation selected from a customizable controlled vocabulary. affiliations (Union[Unset, list['Affiliation']]): Affilations if person_or_org.type is personal.

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

affiliations

person_or_org

role

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

CustomFields

class CustomFields(

)

Custom fields metadata for the record. (v10 and newer).

More informations can be found on InvenioRDM Official page: https://inveniordm.docs.cern.ch/operate/customize/metadata/custom_fields/records/#declaring-custom-fields

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Date

class Date(
    date: datetime.date,
    type_: 'DateType',
    description: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Date relevant to the resource.

Attributes

Name	Type	Description	Default
date	datetime.date	A date or time interval according to Extended Date Time Format Level 0.	None
type_	DateType	The type of date.	None
description	Union[Unset, str]		None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

date

description

type_

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

DateType

class DateType(
    id: invenio_rest_api_client.models.date_type_id.DateTypeId,
    title: 'DateTypeTitle'
)

The type of date.

Attributes

Name	Type	Description	Default
id	DateTypeId	Date type id from the controlled vocabulary	None
title	DateTypeTitle	The corresponding localized human readable label	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

id

title

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

DateTypeId

class DateTypeId(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

ACCEPTED

AVAILABLE

COLLECTED

COPYRIGHTED

CREATED

ISSUED

OTHER

SUBMITTED

UPDATED

VALID

WITHDRAWN

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

DateTypeTitle

class DateTypeTitle(

)

The corresponding localized human readable label

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

DeclineARequestBody

class DeclineARequestBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

DeleteACommentResponse200

class DeleteACommentResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

DeleteADoiResponse200

class DeleteADoiResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

DeleteADraftFileResponse200

class DeleteADraftFileResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

DeleteAFeaturedCommunityEntryResponse200

class DeleteAFeaturedCommunityEntryResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

DeleteAReviewRequestResponse200

class DeleteAReviewRequestResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

DeleteASetResponse200

class DeleteASetResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

DeleteAnAccessLinkResponse200

class DeleteAnAccessLinkResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

DeleteCommunityLogoResponse200

class DeleteCommunityLogoResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

DeleteCommunityResponse200

class DeleteCommunityResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

DeleteRecordCommunityResponse200

class DeleteRecordCommunityResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

DeletediscardADraftRecordResponse200

class DeletediscardADraftRecordResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

DownloadADraftFileResponse200

class DownloadADraftFileResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

DownloadARecordFileResponse200

class DownloadARecordFileResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Embargo

class Embargo(
    active: invenio_rest_api_client.types.Unset | bool = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    until: invenio_rest_api_client.types.Unset | datetime.date = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    reason: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Only in the cases of "record": "restricted"`` or"files": "restricted"`` can an embargo be provided as input.

However, once an embargo is lifted, the embargo section is kept for transparency.

Denotes when an embargo must be lifted, at which point the record is made publicly accessible.

Attributes:
    active (Union[Unset, bool]): Is the record under embargo or not.
    until (Union[Unset, datetime.date]): Required if `"active": "true"`.
    reason (Union[Unset, str]): Explanation for the embargo.

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

active

additional_keys

additional_properties

reason

until

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

ExportRecordAsCslResponse200

class ExportRecordAsCslResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

ExportRecordAsDatacitejsonResponse200

class ExportRecordAsDatacitejsonResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

ExportRecordAsDatacitexmlResponse200

class ExportRecordAsDatacitexmlResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

ExportRecordAsDublincoreXmlResponse200

class ExportRecordAsDublincoreXmlResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

ExportRecordAsJsonResponse200

class ExportRecordAsJsonResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Feature

class Feature(
    geometry: ForwardRef('GeoJSONLineString') | ForwardRef('GeoJSONMultiLineString') | ForwardRef('GeoJSONMultiPoint') | ForwardRef('GeoJSONMultiPolygon') | ForwardRef('GeoJSONPoint') | ForwardRef('GeoJSONPolygon') | invenio_rest_api_client.types.Unset = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    identifiers: invenio_rest_api_client.types.Unset | list['FeatureIdentifier'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    place: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    description: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

A GeoJSON feature object.

Attributes

Name	Type	Description	Default
geometry	Union['GeoJSONLineString', 'GeoJSONMultiLineString', 'GeoJSONMultiPoint', 'GeoJSONMultiPolygon','GeoJSONPoint', 'GeoJSONPolygon', Unset]		None
identifiers	Union[Unset, list['FeatureIdentifier']]	A list of geographic location identifiers.	None
place	Union[Unset, str]	Free text, used to describe a geographical location.	None
description	Union[Unset, str]	Free text, used for any extra information related to the location.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

description

geometry

identifiers

place

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

FeatureIdentifier

class FeatureIdentifier(
    id: str,
    scheme: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

A geographic location identifier.

Attributes

Name	Type	Description	Default
id	str	A globally unique identifier for the location.	None
scheme	Union[Unset, str]	The scheme of the identifier.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

id

scheme

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

FileTransfer

class FileTransfer(
    type_: invenio_rest_api_client.types.Unset | invenio_rest_api_client.models.file_transfer_type.FileTransferType = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    url: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Attributes:

type_ (Union[Unset, FileTransferType]): The actual technology that is used to store a file url (Union[Unset, str]): URL to fetch the file from

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

type_

url

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

FileTransferItem

class FileTransferItem(
    key: str,
    size: invenio_rest_api_client.types.Unset | int = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    checksum: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    transfer: invenio_rest_api_client.types.Unset | ForwardRef('FileTransfer') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

A file object.

Attributes

Name	Type	Description	Default
key	str	Key (filename) of the file	None
size	Union[Unset, int]	Size of the file in bytes.	None
checksum	Union[Unset, str]	Checksum of the file.	None
transfer	Union[Unset, FileTransfer]		None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

checksum

key

size

transfer

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

FileTransferType

class FileTransferType(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

Files

class Files(
    enabled: invenio_rest_api_client.types.Unset | bool = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    default_preview: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    order: invenio_rest_api_client.types.Unset | list[str] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Files options for the record.

More informations can be found on InvenioRDM Official page: https://inveniordm.docs.cern.ch/reference/rest_api_drafts_records/#files-options

Attributes:
    enabled (Union[Unset, bool]): Should (and can) files be attached to this record or not.
    default_preview (Union[Unset, str]): Filename of file to be previewed by default.
    order (Union[Unset, list[str]]): Array of filename strings in display order.

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

default_preview

enabled

order

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Funder

class Funder(
    id: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    name: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

The organisation of the funding provider.

Attributes

Name	Type	Description	Default
id	Union[Unset, str]	The funder id from the controlled vocabulary.	None
name	Union[Unset, str]	The name of the funder.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

id

name

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Funding

class Funding(
    funder: 'Funder',
    award: invenio_rest_api_client.types.Unset | ForwardRef('Award') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Information about financial support (funding) for the resource being registered.

Attributes

Name	Type	Description	Default
funder	Funder	The organisation of the funding provider.	None
award	Union[Unset, Award]	The award (grant) sponsored by the funder.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

award

funder

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GeoJSONLineString

class GeoJSONLineString(
    type_: invenio_rest_api_client.models.geo_json_line_string_type.GeoJSONLineStringType,
    coordinates: list[list[float]],
    bbox: invenio_rest_api_client.types.Unset | list[float] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Attributes:

type_ (GeoJSONLineStringType): coordinates (list[list[float]]): bbox (Union[Unset, list[float]]):

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

bbox

coordinates

type_

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GeoJSONLineStringType

class GeoJSONLineStringType(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

LINESTRING

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

GeoJSONMultiLineString

class GeoJSONMultiLineString(
    type_: invenio_rest_api_client.models.geo_json_multi_line_string_type.GeoJSONMultiLineStringType,
    coordinates: list[list[list[float]]],
    bbox: invenio_rest_api_client.types.Unset | list[float] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Attributes:

type_ (GeoJSONMultiLineStringType): coordinates (list[list[list[float]]]): bbox (Union[Unset, list[float]]):

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

bbox

coordinates

type_

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GeoJSONMultiLineStringType

class GeoJSONMultiLineStringType(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

MULTILINESTRING

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

GeoJSONMultiPoint

class GeoJSONMultiPoint(
    type_: invenio_rest_api_client.models.geo_json_multi_point_type.GeoJSONMultiPointType,
    coordinates: list[list[float]],
    bbox: invenio_rest_api_client.types.Unset | list[float] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Attributes:

type_ (GeoJSONMultiPointType): coordinates (list[list[float]]): bbox (Union[Unset, list[float]]):

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

bbox

coordinates

type_

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GeoJSONMultiPointType

class GeoJSONMultiPointType(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

MULTIPOINT

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

GeoJSONMultiPolygon

class GeoJSONMultiPolygon(
    type_: invenio_rest_api_client.models.geo_json_multi_polygon_type.GeoJSONMultiPolygonType,
    coordinates: list[list[list[list[float]]]],
    bbox: invenio_rest_api_client.types.Unset | list[float] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Attributes:

type_ (GeoJSONMultiPolygonType): coordinates (list[list[list[list[float]]]]): bbox (Union[Unset, list[float]]):

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

bbox

coordinates

type_

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GeoJSONMultiPolygonType

class GeoJSONMultiPolygonType(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

MULTIPOLYGON

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

GeoJSONPoint

class GeoJSONPoint(
    type_: invenio_rest_api_client.models.geo_json_point_type.GeoJSONPointType,
    coordinates: list[float],
    bbox: invenio_rest_api_client.types.Unset | list[float] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Attributes:

type_ (GeoJSONPointType): coordinates (list[float]): bbox (Union[Unset, list[float]]):

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

bbox

coordinates

type_

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GeoJSONPointType

class GeoJSONPointType(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

POINT

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

GeoJSONPolygon

class GeoJSONPolygon(
    type_: invenio_rest_api_client.models.geo_json_polygon_type.GeoJSONPolygonType,
    coordinates: list[list[list[float]]],
    bbox: invenio_rest_api_client.types.Unset | list[float] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Attributes:

type_ (GeoJSONPolygonType): coordinates (list[list[list[float]]]): bbox (Union[Unset, list[float]]):

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

bbox

coordinates

type_

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GeoJSONPolygonType

class GeoJSONPolygonType(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

POLYGON

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

GetACommentResponse200

class GetACommentResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetACommunityResponse200

class GetACommunityResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetADraftFilesMetadataResponse200

class GetADraftFilesMetadataResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetADraftRecordsResponse200

class GetADraftRecordsResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetARecordByIdResponse200

class GetARecordByIdResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetARecordFilesMetadataResponse200

class GetARecordFilesMetadataResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetARequestResponse200

class GetARequestResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetARequestsTimelineResponse200

class GetARequestsTimelineResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetAReviewRequestResponse200

class GetAReviewRequestResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetASetByIdResponse200

class GetASetByIdResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetAUserByIdResponse200

class GetAUserByIdResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetAVocabularyRecordByIdResponse200

class GetAVocabularyRecordByIdResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetAllDraftRecordsResponse200

class GetAllDraftRecordsResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetAllVersionsResponse200

class GetAllVersionsResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetAnAccessLinkByIdResponse200

class GetAnAccessLinkByIdResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetAvatarForGroupResponse200

class GetAvatarForGroupResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetAvatarForUserResponse200

class GetAvatarForUserResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetCommunityLogoResponse200

class GetCommunityLogoResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetCommunityRecordsResponse200

class GetCommunityRecordsResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetFeaturedCommunityEntryResponse200

class GetFeaturedCommunityEntryResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetGroupByIdResponse200

class GetGroupByIdResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetLatestVersionResponse200

class GetLatestVersionResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetMetadataFormatsResponse200

class GetMetadataFormatsResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetNamesByIdResponse200

class GetNamesByIdResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetNamesResponse200

class GetNamesResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetStatisticsBody

class GetStatisticsBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

GetUserByIdDetailedResponse200

class GetUserByIdDetailedResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Identifier

class Identifier(
    scheme: invenio_rest_api_client.models.person_or_org_identifier_scheme.PersonOrOrgIdentifierScheme,
    identifier: str
)

Person or organisation identifier.

Attributes

Name	Type	Description	Default
scheme	PersonOrOrgIdentifierScheme	The identifier scheme. Note that the identifiers' schemes are passed lowercased e.g. ORCID is `orcid`.	None
identifier	str	Actual value of the identifier.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

identifier

scheme

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

IdentifierScheme

class IdentifierScheme(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

ADS

ARK

ARXIV

CROSSREFFUNDERID

DOI

EAN13

EISSN

GRID

HANDLE

IGSN

ISBN

ISNI

ISSN

ISTC

LISSN

LSID

OTHER

PMID

PURL

UPC

URL

URN

W3ID

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

InviteUserMembersBody

class InviteUserMembersBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Lang

class Lang(
    id: str
)

The language of the associated item.

Attributes

Name	Type	Description	Default
id	str	The ISO-639-3 language code.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

id

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

ListADraftsFilesResponse200

class ListADraftsFilesResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

ListARecordsFilesResponse200

class ListARecordsFilesResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

ListAccessLinksResponse200

class ListAccessLinksResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Location

class Location(
    features: list['Feature']
)

Spatial region or named place where the data was gathered or about which the data is focused.

Attributes

Name	Type	Description	Default
features	list['Feature']	A list of GeoJSON feature objects.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

features

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Metadata

class Metadata(
    resource_type: 'ResourceType',
    title: str,
    publication_date: datetime.date,
    creators: list['Creator'],
    publisher: str,
    additional_titles: invenio_rest_api_client.types.Unset | list['AdditionalTitle'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    description: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    additional_descriptions: invenio_rest_api_client.types.Unset | list['AdditionalDescription'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    rights: invenio_rest_api_client.types.Unset | list['Right'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    copyright_: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    contributors: invenio_rest_api_client.types.Unset | list['Creator'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    subjects: invenio_rest_api_client.types.Unset | list['Subject'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    languages: invenio_rest_api_client.types.Unset | list['Lang'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    dates: invenio_rest_api_client.types.Unset | list['Date'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    version: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    identifiers: invenio_rest_api_client.types.Unset | list['AlternateIdentifier'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    related_identifiers: invenio_rest_api_client.types.Unset | list['RelatedIdentifier'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    sizes: invenio_rest_api_client.types.Unset | list[str] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    formats: invenio_rest_api_client.types.Unset | list[str] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    locations: invenio_rest_api_client.types.Unset | list['Location'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    funding: invenio_rest_api_client.types.Unset | list['Funding'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    references: invenio_rest_api_client.types.Unset | list['Reference'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Metadata schema of bibliographic records in InvenioRDM.

More informations can be found on InvenioRDM Official page: https://inveniordm.docs.cern.ch/reference/metadata/#metadata

Attributes:
    resource_type (ResourceType): The type of the resource described by the record.
    title (str): A primary name or primary title by which a resource is known.
    publication_date (datetime.date): The date when the resource was or will be made publicly available.
    creators (list['Creator']): The creators field registers those persons or organisations that should be credited
        for the resource described by the record.
    publisher (str): The name of the entity that holds, archives, publishes, prints, distributes, releases, issues,
        or produces the resource.
    additional_titles (Union[Unset, list['AdditionalTitle']]): Additional names or titles by which a resource is
        known
    description (Union[Unset, str]): The description of a record.
    additional_descriptions (Union[Unset, list['AdditionalDescription']]): Additional descriptions in addition to
        the primary description (e.g. abstracts in other languages), methods or further notes.
    rights (Union[Unset, list['Right']]): Rights management statement for the resource.
    copyright_ (Union[Unset, str]): The copyright field allows authors or depositors to specify a copyright
        statement for the record.
    contributors (Union[Unset, list['Creator']]): The organisations or persons responsible for collecting, managing,
        distributing, or otherwise contributing to the development of the resource.
    subjects (Union[Unset, list['Subject']]): Subject, keyword, classification code, or key phrase describing the
        resource.
    languages (Union[Unset, list['Lang']]): The languages of the resource.
    dates (Union[Unset, list['Date']]): Different dates relevant to the resource.
    version (Union[Unset, str]): The version number of the resource.
    identifiers (Union[Unset, list['AlternateIdentifier']]): Persistent identifiers for the resource other than the
        ones registered as system-managed internal or external persistent identifiers.
    related_identifiers (Union[Unset, list['RelatedIdentifier']]): Identifiers of related resources.
    sizes (Union[Unset, list[str]]): Size (e.g. bytes, pages, inches, etc.) or duration (extent), e.g. hours,
        minutes, days, etc., of a resource.
    formats (Union[Unset, list[str]]): Technical format of the resource.
    locations (Union[Unset, list['Location']]): Spatial region or named place where the data was gathered or about
        which the data is focused.
    funding (Union[Unset, list['Funding']]): Information about financial support (funding) for the resource being
        registered.
    references (Union[Unset, list['Reference']]): A list of reference strings.

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_descriptions

additional_keys

additional_properties

additional_titles

contributors

copyright_

creators

dates

description

formats

funding

identifiers

languages

locations

publication_date

publisher

references

related_identifiers

resource_type

rights

sizes

subjects

title

version

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

PID

class PID(
    identifier: invenio_rest_api_client.types.Unset | Any = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    provider: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    client: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

An external persistent identifier object.

Attributes

Name	Type	Description	Default
identifier	Union[Unset, Any]	An identifier.	None
provider	Union[Unset, str]	The provider of the persistent identifier.	None
client	Union[Unset, str]	Client identifier for the specific PID.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

client

identifier

provider

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

PIDs

class PIDs(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

PersonOrOrg

class PersonOrOrg(
    type_: invenio_rest_api_client.models.person_or_org_type.PersonOrOrgType,
    given_name: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    family_name: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    name: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    identifiers: invenio_rest_api_client.types.Unset | list['Identifier'] = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

The person or organization.

Attributes

Name	Type	Description	Default
type_	PersonOrOrgType	The type of name.	None
given_name	Union[Unset, str]	Given name(s).	None
family_name	Union[Unset, str]	Family name.	None
name	Union[Unset, str]	The full name of the organisation. For a person, this field is generated from `given_name` and `family_name`.	None
identifiers	Union[Unset, list['Identifier']]	Person or organisation identifiers.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

family_name

given_name

identifiers

name

type_

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

PersonOrOrgIdentifierScheme

class PersonOrOrgIdentifierScheme(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

GND

ISNI

ORCID

ROR

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

PersonOrOrgType

class PersonOrOrgType(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

ORGANIZATIONAL

PERSONAL

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

Reference

class Reference(
    reference: str,
    scheme: invenio_rest_api_client.types.Unset | invenio_rest_api_client.models.identifier_scheme.IdentifierScheme = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    identifier: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Reference string.

Attributes

Name	Type	Description	Default
reference	str	The full reference string.	None
scheme	Union[Unset, IdentifierScheme]	The scheme of the identifier	None
identifier	Union[Unset, str]	The identifier if known.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

identifier

reference

scheme

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

RelatedIdentifier

class RelatedIdentifier(
    identifier: str,
    scheme: invenio_rest_api_client.models.identifier_scheme.IdentifierScheme,
    relation_type: 'RelationType',
    resource_type: invenio_rest_api_client.types.Unset | ForwardRef('RelatedIdentifierResourceType') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Identifier of related resources.

Attributes

Name	Type	Description	Default
identifier	str	A global unique persistent identifier for a related resource.	None
scheme	IdentifierScheme	The scheme of the identifier	None
relation_type	RelationType	The relation of the record to this related resource.	None
resource_type	Union[Unset, RelatedIdentifierResourceType]	The resource type of the related resource	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

identifier

relation_type

resource_type

scheme

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

RelatedIdentifierResourceType

class RelatedIdentifierResourceType(
    id: invenio_rest_api_client.models.related_identifier_resource_type_id.RelatedIdentifierResourceTypeId,
    title: 'RelatedIdentifierResourceTypeTitle'
)

The resource type of the related resource

Attributes

Name	Type	Description	Default
id	RelatedIdentifierResourceTypeId	Date type id from the controlled vocabulary.	None
title	RelatedIdentifierResourceTypeTitle	The corresponding localized human readable label	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

id

title

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

RelatedIdentifierResourceTypeId

class RelatedIdentifierResourceTypeId(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

AUDIO

DATASET

EVENT

IMAGE

IMAGE_DIAGRAM

IMAGE_DRAWING

IMAGE_FIGURE

IMAGE_OTHER

IMAGE_PHOTO

IMAGE_PLOT

LESSON

MODEL

OTHER

PHYSICALOBJECT

POSTER

PRESENTATION

PUBLICATION

PUBLICATION_ANNOTATIONCOLLECTION

PUBLICATION_ARTICLE

PUBLICATION_BOOK

PUBLICATION_CONFERENCEPAPER

PUBLICATION_CONFERENCEPROCEEDING

PUBLICATION_DATAMANAGEMENTPLAN

PUBLICATION_DATAPAPER

PUBLICATION_DELIVERABLE

PUBLICATION_DISSERTATION

PUBLICATION_JOURNAL

PUBLICATION_MILESTONE

PUBLICATION_OTHER

PUBLICATION_PATENT

PUBLICATION_PEERREVIEW

PUBLICATION_PREPRINT

PUBLICATION_PROPOSAL

PUBLICATION_REPORT

PUBLICATION_SECTION

PUBLICATION_SOFTWAREDOCUMENTATION

PUBLICATION_STANDARD

PUBLICATION_TAXONOMICTREATMENT

PUBLICATION_TECHNICALNOTE

PUBLICATION_THESIS

PUBLICATION_WORKINGPAPER

SOFTWARE

SOFTWARE_COMPUTATIONALNOTEBOOK

VIDEO

WORKFLOW

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

RelatedIdentifierResourceTypeTitle

class RelatedIdentifierResourceTypeTitle(

)

The corresponding localized human readable label

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

RelationType

class RelationType(
    id: invenio_rest_api_client.models.relation_type_id.RelationTypeId,
    title: 'RelationTypeTitle'
)

The relation of the record to this related resource.

Attributes

Name	Type	Description	Default
id	RelationTypeId	Relation type id from the controlled vocabulary	None
title	RelationTypeTitle	The corresponding localized human readable label	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

id

title

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

RelationTypeId

class RelationTypeId(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

CITES

COMPILES

CONTINUES

DESCRIBES

DOCUMENTS

HASMETADATA

HASPART

HASVERSION

ISCITEDBY

ISCOMPILEDBY

ISCONTINUEDBY

ISDERIVEDFROM

ISDESCRIBEDBY

ISDOCUMENTEDBY

ISIDENTICALTO

ISMETADATAFOR

ISNEWVERSIONOF

ISOBSOLETEDBY

ISORIGINALFORMOF

ISPARTOF

ISPREVIOUSVERSIONOF

ISPUBLISHEDIN

ISREFERENCEDBY

ISREQUIREDBY

ISREVIEWEDBY

ISSOURCEOF

ISSUPPLEMENTEDBY

ISSUPPLEMENTTO

ISVARIANTFORMOF

ISVERSIONOF

OBSOLETES

REFERENCES

REQUIRES

REVIEWS

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

RelationTypeTitle

class RelationTypeTitle(

)

The corresponding localized human readable label

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

RemoveMembersLeaveCommunityResponse200

class RemoveMembersLeaveCommunityResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

RenameACommunityBody

class RenameACommunityBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

ResourceType

class ResourceType(
    id: invenio_rest_api_client.models.resource_type_id.ResourceTypeId
)

The type of the resource described by the record.

Attributes

Name	Type	Description	Default
id	ResourceTypeId	The resource type id from the controlled vocabulary.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

id

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

ResourceTypeId

class ResourceTypeId(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

AUDIO

DATASET

EVENT

IMAGE

IMAGE_DIAGRAM

IMAGE_DRAWING

IMAGE_FIGURE

IMAGE_OTHER

IMAGE_PHOTO

IMAGE_PLOT

LESSON

MODEL

OTHER

PHYSICALOBJECT

POSTER

PRESENTATION

PUBLICATION

PUBLICATION_ANNOTATIONCOLLECTION

PUBLICATION_ARTICLE

PUBLICATION_BOOK

PUBLICATION_CONFERENCEPAPER

PUBLICATION_CONFERENCEPROCEEDING

PUBLICATION_DATAMANAGEMENTPLAN

PUBLICATION_DATAPAPER

PUBLICATION_DELIVERABLE

PUBLICATION_DISSERTATION

PUBLICATION_JOURNAL

PUBLICATION_MILESTONE

PUBLICATION_OTHER

PUBLICATION_PATENT

PUBLICATION_PEERREVIEW

PUBLICATION_PREPRINT

PUBLICATION_PROPOSAL

PUBLICATION_REPORT

PUBLICATION_SECTION

PUBLICATION_SOFTWAREDOCUMENTATION

PUBLICATION_STANDARD

PUBLICATION_TAXONOMICTREATMENT

PUBLICATION_TECHNICALNOTE

PUBLICATION_THESIS

PUBLICATION_WORKINGPAPER

SOFTWARE

SOFTWARE_COMPUTATIONALNOTEBOOK

VIDEO

WORKFLOW

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

Right

class Right(
    id: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    title: invenio_rest_api_client.types.Unset | ForwardRef('RightTitle') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    description: invenio_rest_api_client.types.Unset | ForwardRef('RightDescription') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    links: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Right management statement for the resource.

Attributes

Name	Type	Description	Default
id	Union[Unset, str]	Identifier value.	None
title	Union[Unset, RightTitle]	Localized human readable title.	None
description	Union[Unset, RightDescription]	Localized license description text	None
links	Union[Unset, str]	Link to full license.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

description

id

links

title

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

RightDescription

class RightDescription(

)

Localized license description text

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

RightTitle

class RightTitle(

)

Localized human readable title.

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Role

class Role(
    id: invenio_rest_api_client.models.role_id.RoleId
)

The role of the person or organisation selected from a customizable controlled vocabulary.

Attributes

Name	Type	Description	Default
id	RoleId	The role's controlled vocabulary identifier.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

id

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

RoleId

class RoleId(
    /,
    *args,
    **kwargs
)

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 'utf-8'. errors defaults to 'strict'.

Ancestors (in MRO)

builtins.str
enum.Enum

Class variables

CONTACTPERSON

DATACOLLECTOR

DATACURATOR

DATAMANAGER

DISTRIBUTOR

EDITOR

HOSTINGINSTITUTION

OTHER

PRODUCER

PROJECTLEADER

PROJECTMANAGER

PROJECTMEMBER

REGISTRATIONAGENCY

REGISTRATIONAUTHORITY

RELATEDPERSON

RESEARCHER

RESEARCHGROUP

RIGHTSHOLDER

SPONSOR

SUPERVISOR

WORKPACKAGELEADER

name

value

Static methods

maketrans

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

Methods

capitalize

def capitalize(
    self,
    /
)

Return a capitalized version of the string.

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

casefold

def casefold(
    self,
    /
)

Return a version of the string suitable for caseless comparisons.

center

def center(
    self,
    width,
    fillchar=' ',
    /
)

Return a centered string of length width.

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

count

def count(
    ...
)

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

def 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

def endswith(
    ...
)

Return True if the string ends with the specified suffix, False otherwise.

suffix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

expandtabs

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

find

def find(
    ...
)

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

def format(
    self,
    /,
    *args,
    **kwargs
)

Return a formatted version of the string, using substitutions from args and kwargs.

The substitutions are identified by braces ('{' and '}').

format_map

def format_map(
    self,
    mapping,
    /
)

Return a formatted version of the string, using substitutions from mapping.

The substitutions are identified by braces ('{' and '}').

index

def index(
    ...
)

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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def 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

def isprintable(
    self,
    /
)

Return True if all characters in the string are printable, False otherwise.

A character is printable if repr() may use it in its output.

isspace

def 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

def 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

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

join

def join(
    self,
    iterable,
    /
)

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

def 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

def lower(
    self,
    /
)

Return a copy of the string converted to lowercase.

lstrip

def 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

def partition(
    self,
    sep,
    /
)

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.

removeprefix

def 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

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

replace

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

rfind

def rfind(
    ...
)

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

def rindex(
    ...
)

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.

rjust

def 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

def rpartition(
    self,
    sep,
    /
)

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

def rsplit(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the end of the string and works to the front.

rstrip

def 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

def split(
    self,
    /,
    sep=None,
    maxsplit=-1
)

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. -1 (the default value) means no limit.

Splitting starts at the front of the string and works to the end.

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

def splitlines(
    self,
    /,
    keepends=False
)

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.

startswith

def startswith(
    ...
)

Return True if the string starts with the specified prefix, False otherwise.

prefix A string or a tuple of strings to try. start Optional start position. Default: start of the string. end Optional stop position. Default: end of the string.

strip

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

swapcase

def swapcase(
    self,
    /
)

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title

def 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

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

upper

def upper(
    self,
    /
)

Return a copy of the string converted to uppercase.

zfill

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

SearchCommunitiesResponse200

class SearchCommunitiesResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SearchFeaturedCommunitiesResponse200

class SearchFeaturedCommunitiesResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SearchGroupsResponse200

class SearchGroupsResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SearchInvitationsResponse200

class SearchInvitationsResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SearchMembersResponse200

class SearchMembersResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SearchPublicMembersResponse200

class SearchPublicMembersResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SearchRecordsResponse200

class SearchRecordsResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SearchRequestsResponse200

class SearchRequestsResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SearchSetsResponse200

class SearchSetsResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SearchUserCommunitiesResponse200

class SearchUserCommunitiesResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SearchVocabulariesLanguagesResponse200

class SearchVocabulariesLanguagesResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SearchVocabulariesLicensesResponse200

class SearchVocabulariesLicensesResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SearchVocabulariesRelationtypesResponse200

class SearchVocabulariesRelationtypesResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SearchVocabulariesResourcetypesResponse200

class SearchVocabulariesResourcetypesResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SearchVocabulariesResponse200

class SearchVocabulariesResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SpecificVocabulariesAffiliationsByIdResponse200

class SpecificVocabulariesAffiliationsByIdResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SpecificVocabulariesAffiliationsResponse200

class SpecificVocabulariesAffiliationsResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SpecificVocabulariesAwardsByIdResponse200

class SpecificVocabulariesAwardsByIdResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SpecificVocabulariesAwardsResponse200

class SpecificVocabulariesAwardsResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SpecificVocabulariesFundersByIdResponse200

class SpecificVocabulariesFundersByIdResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SpecificVocabulariesFundersResponse200

class SpecificVocabulariesFundersResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SpecificVocabulariesSubjectsByIdResponse200

class SpecificVocabulariesSubjectsByIdResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SpecificVocabulariesSubjectsResponse200

class SpecificVocabulariesSubjectsResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Step2UploadADraftFilesContentResponse200

class Step2UploadADraftFilesContentResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Subject

class Subject(
    id: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    subject: invenio_rest_api_client.types.Unset | str = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Subject, keyword, classification code, or key phrase describing the resource.

Attributes

Name	Type	Description	Default
id	Union[Unset, str]	The identifier of the subject from the controlled vocabulary.	None
subject	Union[Unset, str]	A custom keyword.	None

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

id

subject

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SubmitACommentOnARequestBody

class SubmitACommentOnARequestBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

SubmitARecordForReviewBody

class SubmitARecordForReviewBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateACommentBody

class UpdateACommentBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateACommentResponse200

class UpdateACommentResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateACommunityBody

class UpdateACommunityBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateACommunityResponse200

class UpdateACommunityResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateADraftRecordResponse200

class UpdateADraftRecordResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateAFeaturedCommunityEntryBody

class UpdateAFeaturedCommunityEntryBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateAFeaturedCommunityEntryResponse200

class UpdateAFeaturedCommunityEntryResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateARequestBody

class UpdateARequestBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateARequestResponse200

class UpdateARequestResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateASetBody

class UpdateASetBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateASetResponse200

class UpdateASetResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateAnAccessLinkBody

class UpdateAnAccessLinkBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateAnAccessLinkResponse200

class UpdateAnAccessLinkResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateCommunityLogoResponse200

class UpdateCommunityLogoResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateDraftRecord

class UpdateDraftRecord(
    access: invenio_rest_api_client.types.Unset | ForwardRef('Access') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    files: invenio_rest_api_client.types.Unset | ForwardRef('Files') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    metadata: invenio_rest_api_client.types.Unset | ForwardRef('Metadata') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    custom_fields: invenio_rest_api_client.types.Unset | ForwardRef('CustomFields') = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Attributes:

access (Union[Unset, Access]): Denotes record-specific read (visibility) options.

More informations can be found on InvenioRDM Official page:
https://inveniordm.docs.cern.ch/reference/metadata/#access

files (Union[Unset, Files]): Files options for the record.

More informations can be found on InvenioRDM Official page:
https://inveniordm.docs.cern.ch/reference/rest_api_drafts_records/#files-options

metadata (Union[Unset, Metadata]): Metadata schema of bibliographic records in InvenioRDM.

More informations can be found on InvenioRDM Official page:
https://inveniordm.docs.cern.ch/reference/metadata/#metadata

custom_fields (Union[Unset, CustomFields]): Custom fields metadata for the record. (v10 and newer).

More informations can be found on InvenioRDM Official page:
https://inveniordm.docs.cern.ch/operate/customize/metadata/custom_fields/records/#declaring-custom-fields

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

access

additional_keys

additional_properties

custom_fields

files

metadata

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateInvitationsBody

class UpdateInvitationsBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateInvitationsResponse200

class UpdateInvitationsResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateMembersBody

class UpdateMembersBody(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

UpdateMembersResponse200

class UpdateMembersResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

Version

class Version(
    index: invenio_rest_api_client.types.Unset | int = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    is_latest: invenio_rest_api_client.types.Unset | bool = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>,
    is_latest_draft: invenio_rest_api_client.types.Unset | bool = <invenio_rest_api_client.types.Unset object at 0x7f5f74d96cf0>
)

Attributes:

index (Union[Unset, int]): is_latest (Union[Unset, bool]): is_latest_draft (Union[Unset, bool]):

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

index

is_latest

is_latest_draft

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

VocabulariesContributorsrolesResponse200

class VocabulariesContributorsrolesResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

VocabulariesCreatorsrolesResponse200

class VocabulariesCreatorsrolesResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

VocabulariesDatetypesResponse200

class VocabulariesDatetypesResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]

VocabulariesDescriptiontypesResponse200

class VocabulariesDescriptiontypesResponse200(

)

Static methods

from_dict

def from_dict(
    src_dict: collections.abc.Mapping[str, typing.Any]
) -> ~T

Instance variables

additional_keys

additional_properties

Methods

to_dict

def to_dict(
    self
) -> dict[str, typing.Any]