mgnipy.emgapi_v2_client.models package

Contents

mgnipy.emgapi_v2_client.models package#

Contains all the data models used in inputs/outputs

class AdditionalContainedGenomeSchema(genome, updated_at, run_accession=<mgnipy.emgapi_v2_client.types.Unset object>, containment=<mgnipy.emgapi_v2_client.types.Unset object>, cani=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
genome#

Simple schema for a Genome model.

Type:

GenomeSchema

updated_at#
Type:

datetime.datetime | None

run_accession#

ENA accession of the run that produced this assembly

Type:

None | str | Unset

containment#

Containment score for the genome within the assembly

Type:

float | None | Unset

cani#

Containment Average Nucleotide Identity (cANI)

Type:

float | None | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
cani: float | None | Unset#
containment: float | None | Unset#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

genome: GenomeSchema#
run_accession: None | str | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

updated_at: datetime.datetime | None #
class AnalysedRun(experiment_type, instrument_model, instrument_platform, accession=<mgnipy.emgapi_v2_client.types.Unset object>, sample_accession=<mgnipy.emgapi_v2_client.types.Unset object>, study_accession=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
  • experiment_type (str )

  • instrument_model (None | str )

  • instrument_platform (None | str )

  • accession (None | str | Unset)

  • sample_accession (None | str | Unset)

  • study_accession (None | str | Unset)

experiment_type#

Experiment type refers to the type of sequencing data that was analysed, e.g. amplicon reads or a metagenome assembly

Type:

str

instrument_model#
Type:

None | str

instrument_platform#
Type:

None | str

accession#
Type:

None | str | Unset

sample_accession#

ENA accession of the sample associated with this run

Type:

None | str | Unset

study_accession#

ENA accession of the study associated with this run

Type:

None | str | Unset

accession: None | str | Unset#
property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
experiment_type: str #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

instrument_model: None | str #
instrument_platform: None | str #
sample_accession: None | str | Unset#
study_accession: None | str | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class AnalysedRunDetail(experiment_type, instrument_model, instrument_platform, sample, study, accession=<mgnipy.emgapi_v2_client.types.Unset object>, sample_accession=<mgnipy.emgapi_v2_client.types.Unset object>, study_accession=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
experiment_type#

Experiment type refers to the type of sequencing data that was analysed, e.g. amplicon reads or a metagenome assembly

Type:

str

instrument_model#
Type:

None | str

instrument_platform#
Type:

None | str

sample#
Type:

MGnifySample | None

study#
Type:

MGnifyStudy | None

accession#
Type:

None | str | Unset

sample_accession#

ENA accession of the sample associated with this run

Type:

None | str | Unset

study_accession#

ENA accession of the study associated with this run

Type:

None | str | Unset

accession: None | str | Unset#
property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
experiment_type: str #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

instrument_model: None | str #
instrument_platform: None | str #
sample: MGnifySample | None #
sample_accession: None | str | Unset#
study: MGnifyStudy | None #
study_accession: None | str | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class AnalysisGetMgnifyAnalysisWithAnnotationsOfTypeMGnifyFunctionalAnalysisAnnotationType(*values)[source]#

Bases: str , Enum

PFAMS = 'pfams'#
TAXONOMIES_DADA2_PR2 = 'taxonomies__dada2_pr2'#
TAXONOMIES_DADA2_SILVA = 'taxonomies__dada2_silva'#
TAXONOMIES_ITS_ONE_DB = 'taxonomies__its_one_db'#
TAXONOMIES_LSU = 'taxonomies__lsu'#
TAXONOMIES_PR2 = 'taxonomies__pr2'#
TAXONOMIES_SSU = 'taxonomies__ssu'#
TAXONOMIES_UNITE = 'taxonomies__unite'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class AnnotatedResult(mgnify, cobs)[source]#

Bases: object

Parameters:
mgnify#
Type:

GenomeList

cobs#
Type:

CobsMatch

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
cobs: CobsMatch#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

mgnify: GenomeList#
to_dict()[source]#
Return type:

dict [str , Any ]

class Assembly(updated_at, accession=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
updated_at#
Type:

datetime.datetime

accession#
Type:

None | str | Unset

accession: None | str | Unset#
property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

updated_at: datetime #
class AssemblyDetail(updated_at, accession=<mgnipy.emgapi_v2_client.types.Unset object>, run_accession=<mgnipy.emgapi_v2_client.types.Unset object>, sample_accession=<mgnipy.emgapi_v2_client.types.Unset object>, reads_study_accession=<mgnipy.emgapi_v2_client.types.Unset object>, assembly_study_accession=<mgnipy.emgapi_v2_client.types.Unset object>, assembler_name=<mgnipy.emgapi_v2_client.types.Unset object>, assembler_version=<mgnipy.emgapi_v2_client.types.Unset object>, metadata=<mgnipy.emgapi_v2_client.types.Unset object>, status=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
updated_at#
Type:

datetime.datetime

accession#
Type:

None | str | Unset

run_accession#
Type:

None | str | Unset

sample_accession#
Type:

None | str | Unset

reads_study_accession#
Type:

None | str | Unset

assembly_study_accession#
Type:

None | str | Unset

assembler_name#
Type:

None | str | Unset

assembler_version#
Type:

None | str | Unset

metadata#

Additional metadata associated with the assembly

Type:

AssemblyDetailMetadataType0 | None | Unset

status#

Status information for the assembly

Type:

AssemblyDetailStatusType0 | None | Unset

accession: None | str | Unset#
property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
assembler_name: None | str | Unset#
assembler_version: None | str | Unset#
assembly_study_accession: None | str | Unset#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

metadata: AssemblyDetailMetadataType0 | None | Unset#
reads_study_accession: None | str | Unset#
run_accession: None | str | Unset#
sample_accession: None | str | Unset#
status: AssemblyDetailStatusType0 | None | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

updated_at: datetime.datetime #
class AssemblyDetailMetadataType0[source]#

Bases: object

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class AssemblyDetailStatusType0[source]#

Bases: object

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class Biome(biome_name, lineage=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
biome_name#
Type:

str

lineage#
Type:

str | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
biome_name: str #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

lineage: str | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class BiomeListFilters(biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, max_depth=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
biome_lineage#

The lineage to match, including all descendant biomes

Type:

None | str | Unset

max_depth#

Maximum depth of the biome lineage to include, e.g. root is 1 and root:Host- Associated:Human is level 3

Type:

int | None | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
biome_lineage: None | str | Unset#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

max_depth: int | None | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class CobsMatch(genome, percent_kmers_found=0.0, num_kmers=<mgnipy.emgapi_v2_client.types.Unset object>, num_kmers_found=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
genome#
Type:

str

percent_kmers_found#

Default: 0.0.

Type:

float | None | Unset

num_kmers#
Type:

int | None | Unset

num_kmers_found#
Type:

int | None | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

genome: str #
num_kmers: int | None | Unset#
num_kmers_found: int | None | Unset#
percent_kmers_found: float | None | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class DownloadFileIndexFile(index_type, path=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

An index file (e.g., a .fai for a FASTA file of .gzi for a bgzip file) of a DownloadFile.

Parameters:
index_type#
Type:

DownloadFileIndexFileIndexType

path#
Type:

str | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

index_type: DownloadFileIndexFileIndexType#
path: str | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class DownloadFileIndexFileIndexType(*values)[source]#

Bases: str , Enum

CSI = 'csi'#
FAI = 'fai'#
GZI = 'gzi'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class DownloadFileType(*values)[source]#

Bases: str , Enum

BIOM = 'biom'#
CSV = 'csv'#
FASTA = 'fasta'#
GFF = 'gff'#
HTML = 'html'#
JSON = 'json'#
OTHER = 'other'#
SVG = 'svg'#
TREE = 'tree'#
TSV = 'tsv'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class DownloadType(*values)[source]#

Bases: str , Enum

ANALYSIS_RO_CRATE = 'Analysis RO Crate'#
CODING_SEQUENCES = 'Coding Sequences'#
FUNCTIONAL_ANALYSIS = 'Functional analysis'#
GENOME_ANALYSIS = 'Genome analysis'#
NON_CODING_RNAS = 'non-coding RNAs'#
OTHER = 'Other'#
QUALITY_CONTROL = 'Quality control'#
SEQUENCE_DATA = 'Sequence data'#
STATISTICS = 'Statistics'#
TAXONOMIC_ANALYSIS = 'Taxonomic analysis'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class ENASampleFields(*values)[source]#

Bases: str , Enum

AGE = 'age'#
ALTITUDE = 'altitude'#
ASSEMBLY_QUALITY = 'assembly_quality'#
ASSEMBLY_SOFTWARE = 'assembly_software'#
BINNING_SOFTWARE = 'binning_software'#
BIO_MATERIAL = 'bio_material'#
BROAD_SCALE_ENVIRONMENTAL_CONTEXT = 'broad_scale_environmental_context'#
BROKER_NAME = 'broker_name'#
CELL_LINE = 'cell_line'#
CELL_TYPE = 'cell_type'#
CENTER_NAME = 'center_name'#
CHECKLIST = 'checklist'#
COLLECTED_BY = 'collected_by'#
COLLECTION_DATE = 'collection_date'#
COLLECTION_DATE_END = 'collection_date_end'#
COLLECTION_DATE_START = 'collection_date_start'#
COMPLETENESS_SCORE = 'completeness_score'#
CONTAMINATION_SCORE = 'contamination_score'#
COUNTRY = 'country'#
CULTIVAR = 'cultivar'#
CULTURE_COLLECTION = 'culture_collection'#
DATAHUB = 'datahub'#
DEPTH = 'depth'#
DESCRIPTION = 'description'#
DEV_STAGE = 'dev_stage'#
DISEASE = 'disease'#
ECOTYPE = 'ecotype'#
ELEVATION = 'elevation'#
ENVIRONMENTAL_MEDIUM = 'environmental_medium'#
ENVIRONMENTAL_SAMPLE = 'environmental_sample'#
ENVIRONMENT_BIOME = 'environment_biome'#
ENVIRONMENT_FEATURE = 'environment_feature'#
ENVIRONMENT_MATERIAL = 'environment_material'#
EXPERIMENTAL_FACTOR = 'experimental_factor'#
FIRST_PUBLIC = 'first_public'#
GERMLINE = 'germline'#
HOST = 'host'#
HOST_BODY_SITE = 'host_body_site'#
HOST_GENOTYPE = 'host_genotype'#
HOST_GRAVIDITY = 'host_gravidity'#
HOST_GROWTH_CONDITIONS = 'host_growth_conditions'#
HOST_PHENOTYPE = 'host_phenotype'#
HOST_SCIENTIFIC_NAME = 'host_scientific_name'#
HOST_SEX = 'host_sex'#
HOST_STATUS = 'host_status'#
HOST_TAX_ID = 'host_tax_id'#
IDENTIFIED_BY = 'identified_by'#
INVESTIGATION_TYPE = 'investigation_type'#
ISOLATE = 'isolate'#
ISOLATION_SOURCE = 'isolation_source'#
KEYWORDS = 'keywords'#
LAST_UPDATED = 'last_updated'#
LAT = 'lat'#
LOCAL_ENVIRONMENTAL_CONTEXT = 'local_environmental_context'#
LOCATION = 'location'#
LOCATION_END = 'location_end'#
LOCATION_START = 'location_start'#
LON = 'lon'#
MARINE_REGION = 'marine_region'#
MATING_TYPE = 'mating_type'#
NCBI_REPORTING_STANDARD = 'ncbi_reporting_standard'#
PH = 'ph'#
PROJECT_NAME = 'project_name'#
PROTOCOL_LABEL = 'protocol_label'#
RELATED_SAMPLE_ACCESSION = 'related_sample_accession'#
SALINITY = 'salinity'#
SAMPLE_ACCESSION = 'sample_accession'#
SAMPLE_ALIAS = 'sample_alias'#
SAMPLE_CAPTURE_STATUS = 'sample_capture_status'#
SAMPLE_COLLECTION = 'sample_collection'#
SAMPLE_DESCRIPTION = 'sample_description'#
SAMPLE_MATERIAL = 'sample_material'#
SAMPLE_TITLE = 'sample_title'#
SAMPLING_CAMPAIGN = 'sampling_campaign'#
SAMPLING_PLATFORM = 'sampling_platform'#
SAMPLING_SITE = 'sampling_site'#
SCIENTIFIC_NAME = 'scientific_name'#
SECONDARY_SAMPLE_ACCESSION = 'secondary_sample_accession'#
SEQUENCING_METHOD = 'sequencing_method'#
SEROTYPE = 'serotype'#
SEROVAR = 'serovar'#
SEX = 'sex'#
SPECIMEN_VOUCHER = 'specimen_voucher'#
STATUS = 'status'#
STRAIN = 'strain'#
STUDY_ACCESSION = 'study_accession'#
SUBMISSION_ACCESSION = 'submission_accession'#
SUBMISSION_TOOL = 'submission_tool'#
SUBMITTED_HOST_SEX = 'submitted_host_sex'#
SUB_SPECIES = 'sub_species'#
SUB_STRAIN = 'sub_strain'#
TAG = 'tag'#
TARGET_GENE = 'target_gene'#
TAXONOMIC_CLASSIFICATION = 'taxonomic_classification'#
TAXONOMIC_IDENTITY_MARKER = 'taxonomic_identity_marker'#
TAX_ID = 'tax_id'#
TAX_LINEAGE = 'tax_lineage'#
TEMPERATURE = 'temperature'#
TISSUE_LIB = 'tissue_lib'#
TISSUE_TYPE = 'tissue_type'#
VARIETY = 'variety'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class ENAStudyFields(*values)[source]#

Bases: str , Enum

BREED = 'breed'#
BROKER_NAME = 'broker_name'#
CENTER_NAME = 'center_name'#
CULTIVAR = 'cultivar'#
DATAHUB = 'datahub'#
DESCRIPTION = 'description'#
FIRST_PUBLIC = 'first_public'#
GEO_ACCESSION = 'geo_accession'#
ISOLATE = 'isolate'#
KEYWORDS = 'keywords'#
LAST_UPDATED = 'last_updated'#
PARENT_STUDY_ACCESSION = 'parent_study_accession'#
PROJECT_NAME = 'project_name'#
SCIENTIFIC_NAME = 'scientific_name'#
SECONDARY_STUDY_ACCESSION = 'secondary_study_accession'#
SECONDARY_STUDY_ALIAS = 'secondary_study_alias'#
SECONDARY_STUDY_CENTER_NAME = 'secondary_study_center_name'#
STATUS = 'status'#
STRAIN = 'strain'#
STUDY_ACCESSION = 'study_accession'#
STUDY_ALIAS = 'study_alias'#
STUDY_DESCRIPTION = 'study_description'#
STUDY_NAME = 'study_name'#
STUDY_TITLE = 'study_title'#
SUBMISSION_TOOL = 'submission_tool'#
TAG = 'tag'#
TAX_DIVISION = 'tax_division'#
TAX_ID = 'tax_id'#
TAX_LINEAGE = 'tax_lineage'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class EuropePmcAnnotation(annotation_text, mentions)[source]#

Bases: object

Parameters:
annotation_text#

Text of the annotation

Type:

str

mentions#

List of occurrence where the annotation is mentioned in the publication

Type:

list [EuropePmcAnnotationMention]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
annotation_text: str #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

mentions: list [EuropePmcAnnotationMention]#
to_dict()[source]#
Return type:

dict [str , Any ]

class EuropePmcAnnotationGroup(annotation_type, title, description, annotations)[source]#

Bases: object

Parameters:
annotation_type#

Type (i.e. the concept) of the annotation

Type:

str

title#

Explanatory version of the annotation type

Type:

str

description#

Detailed description of the annotation type

Type:

str

annotations#

List of annotations of the given type

Type:

list [EuropePmcAnnotation]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
annotation_type: str #
annotations: list [EuropePmcAnnotation]#
description: str #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

title: str #
to_dict()[source]#
Return type:

dict [str , Any ]

class EuropePmcAnnotationMention(exact, type_, tags, id=<mgnipy.emgapi_v2_client.types.Unset object>, postfix=<mgnipy.emgapi_v2_client.types.Unset object>, prefix=<mgnipy.emgapi_v2_client.types.Unset object>, provider='Metagenomic', section=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
exact#

The exact text of the annotation in the text

Type:

str

type_#

The type of the annotation

Type:

str

tags#

A list of tags that associate the annotation with an ontology term

Type:

list [EuropePmcAnnotationTag]

id#
Type:

None | str | Unset

postfix#

The text immediately following the annotation

Type:

None | str | Unset

prefix#

The text immediately preceding the annotation

Type:

None | str | Unset

provider#

The provider of the annotation Default: ‘Metagenomic’.

Type:

str | Unset

section#

The section of the text where the annotation occurs

Type:

None | str | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
exact: str #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

id: None | str | Unset#
postfix: None | str | Unset#
prefix: None | str | Unset#
provider: str | Unset#
section: None | str | Unset#
tags: list [EuropePmcAnnotationTag]#
to_dict()[source]#
Return type:

dict [str , Any ]

type_: str #
class EuropePmcAnnotationTag(name, uri)[source]#

Bases: object

Parameters:
name#
Type:

str

uri#
Type:

str

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

name: str #
to_dict()[source]#
Return type:

dict [str , Any ]

uri: str #
class ExperimentTypes(*values)[source]#

Bases: str , Enum

AMPLI = 'AMPLI'#
ASSEM = 'ASSEM'#
HYASS = 'HYASS'#
LRASS = 'LRASS'#
METAB = 'METAB'#
METAG = 'METAG'#
METAT = 'METAT'#
UNKNO = 'UNKNO'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class GenomeAssemblyLinkSchema(genome, updated_at, species_rep=<mgnipy.emgapi_v2_client.types.Unset object>, mag_accession=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
genome#

Simple schema for a Genome model.

Type:

GenomeSchema

updated_at#
Type:

datetime.datetime | None

species_rep#

Deposition database accession for species representative

Type:

None | str | Unset

mag_accession#

Deposition database for MAG

Type:

None | str | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

genome: GenomeSchema#
mag_accession: None | str | Unset#
species_rep: None | str | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

updated_at: datetime.datetime | None #
class GenomeCatalogueBase(catalogue_id, version, name, status, description, protein_catalogue_description, updated_at, result_directory, unclustered_genome_count, ftp_url, pipeline_version_tag, catalogue_biome_label, catalogue_type, other_stats, downloads, protein_catalogue_name=<mgnipy.emgapi_v2_client.types.Unset object>, genome_count=<mgnipy.emgapi_v2_client.types.Unset object>, biome=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
catalogue_id#
Type:

str

version#
Type:

str

name#
Type:

str

status#
Type:

GenomeCatalogueBaseStatus

description#
Type:

None | str

protein_catalogue_description#
Type:

None | str

updated_at#
Type:

datetime.datetime

result_directory#
Type:

None | str

unclustered_genome_count#

Total number of genomes in the catalogue, including non-cluster- representatives not available via this API.

Type:

int | None

ftp_url#
Type:

str

pipeline_version_tag#
Type:

str

catalogue_biome_label#
Type:

str

catalogue_type#
Type:

GenomeCatalogueBaseCatalogueType

other_stats#
Type:

GenomeCatalogueBaseOtherStatsType0 | None

downloads#
Type:

list [MGnifyGenomeCatalogueDownloadFile]

protein_catalogue_name#
Type:

None | str | Unset

genome_count#
Type:

int | None | Unset

biome#
Type:

Biome | None | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
biome: Biome | None | Unset#
catalogue_biome_label: str #
catalogue_id: str #
catalogue_type: GenomeCatalogueBaseCatalogueType#
description: None | str #
downloads: list [MGnifyGenomeCatalogueDownloadFile]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

ftp_url: str #
genome_count: int | None | Unset#
name: str #
other_stats: GenomeCatalogueBaseOtherStatsType0 | None #
pipeline_version_tag: str #
protein_catalogue_description: None | str #
protein_catalogue_name: None | str | Unset#
result_directory: None | str #
status: GenomeCatalogueBaseStatus#
to_dict()[source]#
Return type:

dict [str , Any ]

unclustered_genome_count: int | None #
updated_at: datetime.datetime #
version: str #
class GenomeCatalogueBaseCatalogueType(*values)[source]#

Bases: str , Enum

EUKARYOTES = 'eukaryotes'#
PROKARYOTES = 'prokaryotes'#
VIRUSES = 'viruses'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class GenomeCatalogueBaseOtherStatsType0[source]#

Bases: object

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class GenomeCatalogueBaseStatus(*values)[source]#

Bases: str , Enum

DRAFT = 'draft'#
PUBLISHED = 'published'#
READY = 'ready'#
RETIRED = 'retired'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class GenomeCatalogueDetail(catalogue_id, version, name, status, description, protein_catalogue_description, updated_at, result_directory, unclustered_genome_count, ftp_url, pipeline_version_tag, catalogue_biome_label, catalogue_type, other_stats, downloads, protein_catalogue_name=<mgnipy.emgapi_v2_client.types.Unset object>, genome_count=<mgnipy.emgapi_v2_client.types.Unset object>, biome=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
catalogue_id#
Type:

str

version#
Type:

str

name#
Type:

str

status#
Type:

GenomeCatalogueDetailStatus

description#
Type:

None | str

protein_catalogue_description#
Type:

None | str

updated_at#
Type:

datetime.datetime

result_directory#
Type:

None | str

unclustered_genome_count#

Total number of genomes in the catalogue, including non-cluster- representatives not available via this API.

Type:

int | None

ftp_url#
Type:

str

pipeline_version_tag#
Type:

str

catalogue_biome_label#
Type:

str

catalogue_type#
Type:

GenomeCatalogueDetailCatalogueType

other_stats#
Type:

GenomeCatalogueDetailOtherStatsType0 | None

downloads#
Type:

list [MGnifyGenomeCatalogueDownloadFile]

protein_catalogue_name#
Type:

None | str | Unset

genome_count#
Type:

int | None | Unset

biome#
Type:

Biome | None | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
biome: Biome | None | Unset#
catalogue_biome_label: str #
catalogue_id: str #
catalogue_type: GenomeCatalogueDetailCatalogueType#
description: None | str #
downloads: list [MGnifyGenomeCatalogueDownloadFile]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

ftp_url: str #
genome_count: int | None | Unset#
name: str #
other_stats: GenomeCatalogueDetailOtherStatsType0 | None #
pipeline_version_tag: str #
protein_catalogue_description: None | str #
protein_catalogue_name: None | str | Unset#
result_directory: None | str #
status: GenomeCatalogueDetailStatus#
to_dict()[source]#
Return type:

dict [str , Any ]

unclustered_genome_count: int | None #
updated_at: datetime.datetime #
version: str #
class GenomeCatalogueDetailCatalogueType(*values)[source]#

Bases: str , Enum

EUKARYOTES = 'eukaryotes'#
PROKARYOTES = 'prokaryotes'#
VIRUSES = 'viruses'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class GenomeCatalogueDetailOtherStatsType0[source]#

Bases: object

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class GenomeCatalogueDetailStatus(*values)[source]#

Bases: str , Enum

DRAFT = 'draft'#
PUBLISHED = 'published'#
READY = 'ready'#
RETIRED = 'retired'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class GenomeCatalogueList(catalogue_id, version, name, status, description, protein_catalogue_description, updated_at, result_directory, unclustered_genome_count, ftp_url, pipeline_version_tag, catalogue_biome_label, catalogue_type, other_stats, downloads, protein_catalogue_name=<mgnipy.emgapi_v2_client.types.Unset object>, genome_count=<mgnipy.emgapi_v2_client.types.Unset object>, biome=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
catalogue_id#
Type:

str

version#
Type:

str

name#
Type:

str

status#
Type:

GenomeCatalogueListStatus

description#
Type:

None | str

protein_catalogue_description#
Type:

None | str

updated_at#
Type:

datetime.datetime

result_directory#
Type:

None | str

unclustered_genome_count#

Total number of genomes in the catalogue, including non-cluster- representatives not available via this API.

Type:

int | None

ftp_url#
Type:

str

pipeline_version_tag#
Type:

str

catalogue_biome_label#
Type:

str

catalogue_type#
Type:

GenomeCatalogueListCatalogueType

other_stats#
Type:

GenomeCatalogueListOtherStatsType0 | None

downloads#
Type:

list [MGnifyGenomeCatalogueDownloadFile]

protein_catalogue_name#
Type:

None | str | Unset

genome_count#
Type:

int | None | Unset

biome#
Type:

Biome | None | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
biome: Biome | None | Unset#
catalogue_biome_label: str #
catalogue_id: str #
catalogue_type: GenomeCatalogueListCatalogueType#
description: None | str #
downloads: list [MGnifyGenomeCatalogueDownloadFile]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

ftp_url: str #
genome_count: int | None | Unset#
name: str #
other_stats: GenomeCatalogueListOtherStatsType0 | None #
pipeline_version_tag: str #
protein_catalogue_description: None | str #
protein_catalogue_name: None | str | Unset#
result_directory: None | str #
status: GenomeCatalogueListStatus#
to_dict()[source]#
Return type:

dict [str , Any ]

unclustered_genome_count: int | None #
updated_at: datetime.datetime #
version: str #
class GenomeCatalogueListCatalogueType(*values)[source]#

Bases: str , Enum

EUKARYOTES = 'eukaryotes'#
PROKARYOTES = 'prokaryotes'#
VIRUSES = 'viruses'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class GenomeCatalogueListOtherStatsType0[source]#

Bases: object

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class GenomeCatalogueListStatus(*values)[source]#

Bases: str , Enum

DRAFT = 'draft'#
PUBLISHED = 'published'#
READY = 'ready'#
RETIRED = 'retired'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class GenomeDetail(accession, ena_genome_accession, ena_sample_accession, ena_study_accession, ncbi_genome_accession, ncbi_study_accession, img_genome_accession, patric_genome_accession, length, num_contigs, n_50, gc_content, type_, completeness, contamination, catalogue_id, taxon_lineage, updated_at, geographic_origin, downloads, num_genomes_total=<mgnipy.emgapi_v2_client.types.Unset object>, geographic_range=<mgnipy.emgapi_v2_client.types.Unset object>, biome=<mgnipy.emgapi_v2_client.types.Unset object>, rna_5s=<mgnipy.emgapi_v2_client.types.Unset object>, rna_5_8s=<mgnipy.emgapi_v2_client.types.Unset object>, rna_16s=<mgnipy.emgapi_v2_client.types.Unset object>, rna_18s=<mgnipy.emgapi_v2_client.types.Unset object>, rna_23s=<mgnipy.emgapi_v2_client.types.Unset object>, rna_28s=<mgnipy.emgapi_v2_client.types.Unset object>, trnas=<mgnipy.emgapi_v2_client.types.Unset object>, nc_rnas=<mgnipy.emgapi_v2_client.types.Unset object>, eggnog_coverage=<mgnipy.emgapi_v2_client.types.Unset object>, ipr_coverage=<mgnipy.emgapi_v2_client.types.Unset object>, num_proteins=<mgnipy.emgapi_v2_client.types.Unset object>, pangenome_size=<mgnipy.emgapi_v2_client.types.Unset object>, pangenome_core_size=<mgnipy.emgapi_v2_client.types.Unset object>, pangenome_accessory_size=<mgnipy.emgapi_v2_client.types.Unset object>, catalogue=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
accession#
Type:

str

ena_genome_accession#
Type:

None | str

ena_sample_accession#
Type:

None | str

ena_study_accession#
Type:

None | str

ncbi_genome_accession#
Type:

None | str

ncbi_study_accession#
Type:

None | str

img_genome_accession#
Type:

None | str

patric_genome_accession#
Type:

None | str

length#
Type:

int

num_contigs#
Type:

int

n_50#
Type:

int

gc_content#
Type:

float

type_#
Type:

GenomeType

completeness#
Type:

float

contamination#
Type:

float

catalogue_id#
Type:

str

taxon_lineage#
Type:

str

updated_at#
Type:

datetime.datetime

geographic_origin#
Type:

None | str

downloads#
Type:

list [MGnifyGenomeDownloadFile]

num_genomes_total#
Type:

int | None | Unset

geographic_range#
Type:

list [str ] | None | Unset

biome#
Type:

Biome | None | Unset

rna_5s#
Type:

float | None | Unset

rna_5_8s#
Type:

float | None | Unset

rna_16s#
Type:

float | None | Unset

rna_18s#
Type:

float | None | Unset

rna_23s#
Type:

float | None | Unset

rna_28s#
Type:

float | None | Unset

trnas#
Type:

float | None | Unset

nc_rnas#
Type:

float | None | Unset

eggnog_coverage#
Type:

float | None | Unset

ipr_coverage#
Type:

float | None | Unset

num_proteins#
Type:

int | None | Unset

pangenome_size#
Type:

int | None | Unset

pangenome_core_size#
Type:

int | None | Unset

pangenome_accessory_size#
Type:

int | None | Unset

catalogue#
Type:

GenomeCatalogueBase | None | Unset

accession: str #
property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
biome: Biome | None | Unset#
catalogue: GenomeCatalogueBase | None | Unset#
catalogue_id: str #
completeness: float #
contamination: float #
downloads: list [MGnifyGenomeDownloadFile]#
eggnog_coverage: float | None | Unset#
ena_genome_accession: None | str #
ena_sample_accession: None | str #
ena_study_accession: None | str #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

gc_content: float #
geographic_origin: None | str #
geographic_range: list [str ] | None | Unset#
img_genome_accession: None | str #
ipr_coverage: float | None | Unset#
length: int #
n_50: int #
nc_rnas: float | None | Unset#
ncbi_genome_accession: None | str #
ncbi_study_accession: None | str #
num_contigs: int #
num_genomes_total: int | None | Unset#
num_proteins: int | None | Unset#
pangenome_accessory_size: int | None | Unset#
pangenome_core_size: int | None | Unset#
pangenome_size: int | None | Unset#
patric_genome_accession: None | str #
rna_16s: float | None | Unset#
rna_18s: float | None | Unset#
rna_23s: float | None | Unset#
rna_28s: float | None | Unset#
rna_5_8s: float | None | Unset#
rna_5s: float | None | Unset#
taxon_lineage: str #
to_dict()[source]#
Return type:

dict [str , Any ]

trnas: float | None | Unset#
type_: GenomeType#
updated_at: datetime.datetime #
class GenomeFilters(biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, search=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
biome_lineage#

The lineage to match, including all descendant biomes

Type:

None | str | Unset

search#

Search with genome taxonomies and accessions

Type:

None | str | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
biome_lineage: None | str | Unset#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

search: None | str | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class GenomeFragmentSearchOut(data)[source]#

Bases: object

Parameters:

data (GenomeSearchData)

data#
Type:

GenomeSearchData

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
data: GenomeSearchData#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class GenomeList(accession, ena_genome_accession, ena_sample_accession, ena_study_accession, ncbi_genome_accession, ncbi_study_accession, img_genome_accession, patric_genome_accession, length, num_contigs, n_50, gc_content, type_, completeness, contamination, catalogue_id, taxon_lineage, updated_at, geographic_origin, num_genomes_total=<mgnipy.emgapi_v2_client.types.Unset object>, geographic_range=<mgnipy.emgapi_v2_client.types.Unset object>, biome=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
accession#
Type:

str

ena_genome_accession#
Type:

None | str

ena_sample_accession#
Type:

None | str

ena_study_accession#
Type:

None | str

ncbi_genome_accession#
Type:

None | str

ncbi_study_accession#
Type:

None | str

img_genome_accession#
Type:

None | str

patric_genome_accession#
Type:

None | str

length#
Type:

int

num_contigs#
Type:

int

n_50#
Type:

int

gc_content#
Type:

float

type_#
Type:

GenomeType

completeness#
Type:

float

contamination#
Type:

float

catalogue_id#
Type:

str

taxon_lineage#
Type:

str

updated_at#
Type:

datetime.datetime

geographic_origin#
Type:

None | str

num_genomes_total#
Type:

int | None | Unset

geographic_range#
Type:

list [str ] | None | Unset

biome#
Type:

Biome | None | Unset

accession: str #
property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
biome: Biome | None | Unset#
catalogue_id: str #
completeness: float #
contamination: float #
ena_genome_accession: None | str #
ena_sample_accession: None | str #
ena_study_accession: None | str #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

gc_content: float #
geographic_origin: None | str #
geographic_range: list [str ] | None | Unset#
img_genome_accession: None | str #
length: int #
n_50: int #
ncbi_genome_accession: None | str #
ncbi_study_accession: None | str #
num_contigs: int #
num_genomes_total: int | None | Unset#
patric_genome_accession: None | str #
taxon_lineage: str #
to_dict()[source]#
Return type:

dict [str , Any ]

type_: GenomeType#
updated_at: datetime.datetime #
class GenomeSchema(accession, catalogue_id, taxon_lineage, ena_genome_accession, catalogue_version=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Simple schema for a Genome model.

Parameters:
  • accession (str )

  • catalogue_id (None | str )

  • taxon_lineage (None | str )

  • ena_genome_accession (None | str )

  • catalogue_version (None | str | Unset)

accession#
Type:

str

catalogue_id#
Type:

None | str

taxon_lineage#
Type:

None | str

ena_genome_accession#
Type:

None | str

catalogue_version#

Version of the genome catalogue

Type:

None | str | Unset

accession: str #
property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
catalogue_id: None | str #
catalogue_version: None | str | Unset#
ena_genome_accession: None | str #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

taxon_lineage: None | str #
to_dict()[source]#
Return type:

dict [str , Any ]

class GenomeSearchData(results, query=<mgnipy.emgapi_v2_client.types.Unset object>, threshold=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
results#
Type:

list [AnnotatedResult]

query#
Type:

None | str | Unset

threshold#
Type:

float | None | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

query: None | str | Unset#
results: list [AnnotatedResult]#
threshold: float | None | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class GenomeType(*values)[source]#

Bases: str , Enum

ISOLATE = 'Isolate'#
MAG = 'MAG'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class GenomeWithAnnotations(accession, annotations)[source]#

Bases: object

Parameters:
accession#
Type:

str

annotations#
Type:

GenomeWithAnnotationsAnnotations

accession: str #
property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
annotations: GenomeWithAnnotationsAnnotations#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class GenomeWithAnnotationsAnnotations[source]#

Bases: object

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class GetGenomeCatalogueGenomesOrderType0(*values)[source]#

Bases: str , Enum

ACCESSION = 'accession'#
COMPLETENESS = 'completeness'#
CONTAMINATION = 'contamination'#
LENGTH = 'length'#
NUM_GENOMES_TOTAL = 'num_genomes_total'#
VALUE_1 = '-accession'#
VALUE_10 = ''#
VALUE_3 = '-length'#
VALUE_5 = '-completeness'#
VALUE_7 = '-contamination'#
VALUE_9 = '-num_genomes_total'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class Input(page=1, page_size=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
page#

Default: 1.

Type:

int | Unset

page_size#
Type:

int | None | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

page: int | Unset#
page_size: int | None | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class ListMgnifyGenomesOrderType0(*values)[source]#

Bases: str , Enum

ACCESSION = 'accession'#
COMPLETENESS = 'completeness'#
CONTAMINATION = 'contamination'#
LENGTH = 'length'#
NUM_GENOMES_TOTAL = 'num_genomes_total'#
VALUE_1 = '-accession'#
VALUE_10 = ''#
VALUE_3 = '-length'#
VALUE_5 = '-completeness'#
VALUE_7 = '-contamination'#
VALUE_9 = '-num_genomes_total'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class ListMgnifyPublicationsOrderType0(*values)[source]#

Bases: str , Enum

PUBLISHED_YEAR = 'published_year'#
VALUE_1 = '-published_year'#
VALUE_2 = ''#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class ListMgnifySamplesOrderType0(*values)[source]#

Bases: str , Enum

SAMPLE_TITLE = 'sample_title'#
UPDATED_AT = 'updated_at'#
VALUE_1 = '-sample_title'#
VALUE_3 = '-updated_at'#
VALUE_4 = ''#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class ListMgnifyStudiesOrderType0(*values)[source]#

Bases: str , Enum

ACCESSION = 'accession'#
UPDATED_AT = 'updated_at'#
VALUE_1 = '-accession'#
VALUE_3 = '-updated_at'#
VALUE_4 = ''#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class MGnifyAnalysis(experiment_type, study_accession, accession, run, sample, assembly, pipeline_version)[source]#

Bases: object

Parameters:
experiment_type#

Experiment type refers to the type of sequencing data that was analysed, e.g. amplicon reads or a metagenome assembly

Type:

str

study_accession#
Type:

str

accession#
Type:

str

run#
Type:

AnalysedRun | None

sample#
Type:

MGnifySample | None

assembly#
Type:

Assembly | None

pipeline_version#
Type:

None | PipelineVersions

accession: str #
property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
assembly: Assembly | None #
experiment_type: str #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

pipeline_version: None | PipelineVersions#
run: AnalysedRun | None #
sample: MGnifySample | None #
study_accession: str #
to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifyAnalysisDetail(experiment_type, study_accession, accession, run, sample, assembly, pipeline_version, read_run, quality_control_summary, downloads=<mgnipy.emgapi_v2_client.types.Unset object>, results_dir=<mgnipy.emgapi_v2_client.types.Unset object>, metadata=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
experiment_type#

Experiment type refers to the type of sequencing data that was analysed, e.g. amplicon reads or a metagenome assembly

Type:

str

study_accession#
Type:

str

accession#
Type:

str

run#
Type:

AnalysedRun | None

sample#
Type:

MGnifySample | None

assembly#
Type:

Assembly | None

pipeline_version#
Type:

None | PipelineVersions

read_run#

Metadata associated with the original read run(s) this analysis is based on, whether or not those reads were assembled.

Type:

list [AnalysedRun] | None

quality_control_summary#
Type:

MGnifyAnalysisDetailQualityControlSummaryType0 | None

downloads#
Type:

list [MGnifyAnalysisDownloadFile] | Unset

results_dir#

Directory path where analysis results are stored

Type:

None | str | Unset

metadata#

Additional metadata associated with the analysis

Type:

MGnifyAnalysisDetailMetadataType0 | None | Unset

accession: str #
property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
assembly: Assembly | None #
downloads: list [MGnifyAnalysisDownloadFile] | Unset#
experiment_type: str #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

metadata: MGnifyAnalysisDetailMetadataType0 | None | Unset#
pipeline_version: None | PipelineVersions#
quality_control_summary: MGnifyAnalysisDetailQualityControlSummaryType0 | None #
read_run: list [AnalysedRun] | None #
results_dir: None | str | Unset#
run: AnalysedRun | None #
sample: MGnifySample | None #
study_accession: str #
to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifyAnalysisDetailMetadataType0[source]#

Bases: object

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifyAnalysisDetailQualityControlSummaryType0[source]#

Bases: object

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifyAnalysisDownloadFile(file_type, download_type, short_description, long_description, alias, download_group=<mgnipy.emgapi_v2_client.types.Unset object>, path=<mgnipy.emgapi_v2_client.types.Unset object>, file_size_bytes=<mgnipy.emgapi_v2_client.types.Unset object>, index_file=<mgnipy.emgapi_v2_client.types.Unset object>, parent_identifier=<mgnipy.emgapi_v2_client.types.Unset object>, parent_is_private=<mgnipy.emgapi_v2_client.types.Unset object>, parent_results_dir=<mgnipy.emgapi_v2_client.types.Unset object>, index_files=<mgnipy.emgapi_v2_client.types.Unset object>, url=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
file_type#
Type:

DownloadFileType

download_type#
Type:

DownloadType

short_description#

Brief description of the file

Type:

str

long_description#

Detailed description of the file

Type:

str

alias#
Type:

str

download_group#

Group identifier for the download

Type:

None | str | Unset

path#
Type:

str | Unset

file_size_bytes#
Type:

int | None | Unset

index_file#
Type:

DownloadFileIndexFile | list [DownloadFileIndexFile] | None | Unset

parent_identifier#
Type:

int | str | Unset

parent_is_private#
Type:

bool | None | Unset

parent_results_dir#
Type:

None | str | Unset

index_files#
Type:

list [MGnifyDownloadFileIndexFile] | None | Unset

url#
Type:

None | str | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
alias: str #
download_group: None | str | Unset#
download_type: DownloadType#
file_size_bytes: int | None | Unset#
file_type: DownloadFileType#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

index_file: DownloadFileIndexFile | list [DownloadFileIndexFile] | None | Unset#
index_files: list [MGnifyDownloadFileIndexFile] | None | Unset#
long_description: str #
parent_identifier: int | str | Unset#
parent_is_private: bool | None | Unset#
parent_results_dir: None | str | Unset#
path: str | Unset#
short_description: str #
to_dict()[source]#
Return type:

dict [str , Any ]

url: None | str | Unset#
class MGnifyAnalysisTypedAnnotation(count=<mgnipy.emgapi_v2_client.types.Unset object>, description=<mgnipy.emgapi_v2_client.types.Unset object>, organism=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
count#
Type:

int | None | Unset

description#
Type:

None | str | Unset

organism#
Type:

None | str | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
count: int | None | Unset#
description: None | str | Unset#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

organism: None | str | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifyAnalysisWithAnnotations(experiment_type, study_accession, accession, run, sample, assembly, pipeline_version, read_run, quality_control_summary, annotations, downloads=<mgnipy.emgapi_v2_client.types.Unset object>, results_dir=<mgnipy.emgapi_v2_client.types.Unset object>, metadata=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
experiment_type#

Experiment type refers to the type of sequencing data that was analysed, e.g. amplicon reads or a metagenome assembly

Type:

str

study_accession#
Type:

str

accession#
Type:

str

run#
Type:

AnalysedRun | None

sample#
Type:

MGnifySample | None

assembly#
Type:

Assembly | None

pipeline_version#
Type:

None | PipelineVersions

read_run#

Metadata associated with the original read run(s) this analysis is based on, whether or not those reads were assembled.

Type:

list [AnalysedRun] | None

quality_control_summary#
Type:

MGnifyAnalysisWithAnnotationsQualityControlSummaryType0 | None

annotations#
Type:

MGnifyAnalysisWithAnnotationsAnnotations

downloads#
Type:

list [MGnifyAnalysisDownloadFile] | Unset

results_dir#

Directory path where analysis results are stored

Type:

None | str | Unset

metadata#

Additional metadata associated with the analysis

Type:

MGnifyAnalysisWithAnnotationsMetadataType0 | None | Unset

accession: str #
property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
annotations: MGnifyAnalysisWithAnnotationsAnnotations#
assembly: Assembly | None #
downloads: list [MGnifyAnalysisDownloadFile] | Unset#
experiment_type: str #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

metadata: MGnifyAnalysisWithAnnotationsMetadataType0 | None | Unset#
pipeline_version: None | PipelineVersions#
quality_control_summary: MGnifyAnalysisWithAnnotationsQualityControlSummaryType0 | None #
read_run: list [AnalysedRun] | None #
results_dir: None | str | Unset#
run: AnalysedRun | None #
sample: MGnifySample | None #
study_accession: str #
to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifyAnalysisWithAnnotationsAnnotations[source]#

Bases: object

property additional_keys: list [str ]#
additional_properties: dict [str , list [MGnifyAnalysisTypedAnnotation] | MGnifyAnalysisWithAnnotationsAnnotationsAdditionalPropertyType1]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifyAnalysisWithAnnotationsAnnotationsAdditionalPropertyType1[source]#

Bases: object

property additional_keys: list [str ]#
additional_properties: dict [str , list [MGnifyAnalysisTypedAnnotation] | None ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifyAnalysisWithAnnotationsMetadataType0[source]#

Bases: object

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifyAnalysisWithAnnotationsQualityControlSummaryType0[source]#

Bases: object

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifyDownloadFileIndexFile(index_type, path=<mgnipy.emgapi_v2_client.types.Unset object>, url=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
index_type#
Type:

MGnifyDownloadFileIndexFileIndexType

path#
Type:

str | Unset

url#

Full URL of the index file.

Type:

None | str | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

index_type: MGnifyDownloadFileIndexFileIndexType#
path: str | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

url: None | str | Unset#
class MGnifyDownloadFileIndexFileIndexType(*values)[source]#

Bases: str , Enum

CSI = 'csi'#
FAI = 'fai'#
GZI = 'gzi'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class MGnifyFunctionalAnalysisAnnotationType(*values)[source]#

Bases: str , Enum

PFAMS = 'pfams'#
TAXONOMIES_DADA2_PR2 = 'taxonomies__dada2_pr2'#
TAXONOMIES_DADA2_SILVA = 'taxonomies__dada2_silva'#
TAXONOMIES_ITS_ONE_DB = 'taxonomies__its_one_db'#
TAXONOMIES_LSU = 'taxonomies__lsu'#
TAXONOMIES_PR2 = 'taxonomies__pr2'#
TAXONOMIES_SSU = 'taxonomies__ssu'#
TAXONOMIES_UNITE = 'taxonomies__unite'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class MGnifyGenomeCatalogueDownloadFile(file_type, download_type, short_description, long_description, alias, download_group=<mgnipy.emgapi_v2_client.types.Unset object>, path=<mgnipy.emgapi_v2_client.types.Unset object>, file_size_bytes=<mgnipy.emgapi_v2_client.types.Unset object>, index_file=<mgnipy.emgapi_v2_client.types.Unset object>, parent_identifier=<mgnipy.emgapi_v2_client.types.Unset object>, url=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Download file representation for GenomeCatalogue objects.

Resolves a public URL using the catalogue’s result_directory, if available.

Attributes:

file_type (DownloadFileType): download_type (DownloadType): short_description (str): Brief description of the file long_description (str): Detailed description of the file alias (str): download_group (None | str | Unset): Group identifier for the download path (str | Unset): file_size_bytes (int | None | Unset): index_file (DownloadFileIndexFile | list[DownloadFileIndexFile] | None | Unset): parent_identifier (int | str | Unset): url (None | str | Unset):

Parameters:
property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
alias: str #
download_group: None | str | Unset#
download_type: DownloadType#
file_size_bytes: int | None | Unset#
file_type: DownloadFileType#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

index_file: DownloadFileIndexFile | list [DownloadFileIndexFile] | None | Unset#
long_description: str #
parent_identifier: int | str | Unset#
path: str | Unset#
short_description: str #
to_dict()[source]#
Return type:

dict [str , Any ]

url: None | str | Unset#
class MGnifyGenomeDownloadFile(file_type, download_type, short_description, long_description, alias, download_group=<mgnipy.emgapi_v2_client.types.Unset object>, path=<mgnipy.emgapi_v2_client.types.Unset object>, file_size_bytes=<mgnipy.emgapi_v2_client.types.Unset object>, index_file=<mgnipy.emgapi_v2_client.types.Unset object>, parent_identifier=<mgnipy.emgapi_v2_client.types.Unset object>, url=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
file_type#
Type:

DownloadFileType

download_type#
Type:

DownloadType

short_description#

Brief description of the file

Type:

str

long_description#

Detailed description of the file

Type:

str

alias#
Type:

str

download_group#

Group identifier for the download

Type:

None | str | Unset

path#
Type:

str | Unset

file_size_bytes#
Type:

int | None | Unset

index_file#
Type:

DownloadFileIndexFile | list [DownloadFileIndexFile] | None | Unset

parent_identifier#
Type:

int | str | Unset

url#
Type:

None | str | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
alias: str #
download_group: None | str | Unset#
download_type: DownloadType#
file_size_bytes: int | None | Unset#
file_type: DownloadFileType#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

index_file: DownloadFileIndexFile | list [DownloadFileIndexFile] | None | Unset#
long_description: str #
parent_identifier: int | str | Unset#
path: str | Unset#
short_description: str #
to_dict()[source]#
Return type:

dict [str , Any ]

url: None | str | Unset#
class MGnifyPublication(title, metadata, pubmed_id=<mgnipy.emgapi_v2_client.types.Unset object>, published_year=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
title#
Type:

str

metadata#
Type:

MGnifyPublicationMetadata

pubmed_id#
Type:

int | Unset

published_year#
Type:

int | None | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

metadata: MGnifyPublicationMetadata#
published_year: int | None | Unset#
pubmed_id: int | Unset#
title: str #
to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifyPublicationDetail(title, metadata, studies, pubmed_id=<mgnipy.emgapi_v2_client.types.Unset object>, published_year=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
title#
Type:

str

metadata#
Type:

MGnifyPublicationDetailMetadata

studies#
Type:

list [MGnifyStudy]

pubmed_id#
Type:

int | Unset

published_year#
Type:

int | None | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

metadata: MGnifyPublicationDetailMetadata#
published_year: int | None | Unset#
pubmed_id: int | Unset#
studies: list [MGnifyStudy]#
title: str #
to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifyPublicationDetailMetadata[source]#

Bases: object

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifyPublicationMetadata[source]#

Bases: object

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifySample(accession, ena_accessions, sample_title, biome, updated_at)[source]#

Bases: object

Parameters:
accession#
Type:

str

ena_accessions#
Type:

list [str ]

sample_title#
Type:

None | str

biome#
Type:

Biome | None

updated_at#
Type:

datetime.datetime

accession: str #
property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
biome: Biome | None #
ena_accessions: list [str ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

sample_title: None | str #
to_dict()[source]#
Return type:

dict [str , Any ]

updated_at: datetime.datetime #
class MGnifySampleDetail(accession, ena_accessions, sample_title, biome, updated_at, metadata, studies)[source]#

Bases: object

Parameters:
accession#
Type:

str

ena_accessions#
Type:

list [str ]

sample_title#
Type:

None | str

biome#
Type:

Biome | None

updated_at#
Type:

datetime.datetime

metadata#

Metadata associated with the sample, sourced from the ENA Sample record.

Type:

MGnifySampleDetailMetadata

studies#
Type:

list [MGnifyStudy]

accession: str #
property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
biome: Biome | None #
ena_accessions: list [str ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

metadata: MGnifySampleDetailMetadata#
sample_title: None | str #
studies: list [MGnifyStudy]#
to_dict()[source]#
Return type:

dict [str , Any ]

updated_at: datetime.datetime #
class MGnifySampleDetailMetadata[source]#

Bases: object

Metadata associated with the sample, sourced from the ENA Sample record.

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifySampleWithMetadata(accession, ena_accessions, sample_title, biome, updated_at, metadata)[source]#

Bases: object

Parameters:
accession#
Type:

str

ena_accessions#
Type:

list [str ]

sample_title#
Type:

None | str

biome#
Type:

Biome | None

updated_at#
Type:

datetime.datetime

metadata#

Metadata associated with the sample, sourced from the ENA Sample record.

Type:

MGnifySampleWithMetadataMetadata

accession: str #
property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
biome: Biome | None #
ena_accessions: list [str ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

metadata: MGnifySampleWithMetadataMetadata#
sample_title: None | str #
to_dict()[source]#
Return type:

dict [str , Any ]

updated_at: datetime.datetime #
class MGnifySampleWithMetadataMetadata[source]#

Bases: object

Metadata associated with the sample, sourced from the ENA Sample record.

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifyStudy(accession, ena_accessions, title, biome, updated_at, metadata)[source]#

Bases: object

Parameters:
accession#
Type:

str

ena_accessions#
Type:

list [str ]

title#
Type:

str

biome#
Type:

Biome | None

updated_at#
Type:

datetime.datetime

metadata#

Metadata associated with the study, a partial copy of the ENA Study record.

Type:

MGnifyStudyMetadata

accession: str #
property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
biome: Biome | None #
ena_accessions: list [str ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

metadata: MGnifyStudyMetadata#
title: str #
to_dict()[source]#
Return type:

dict [str , Any ]

updated_at: datetime.datetime #
class MGnifyStudyAccessionLookup(accession)[source]#

Bases: object

Parameters:

accession (str )

accession#

The MGnify study accession corresponding to the requested INSDC study/project accession.

Type:

str

accession: str #
property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifyStudyDetail(accession, ena_accessions, title, biome, updated_at, metadata, downloads, first_accession=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
accession#
Type:

str

ena_accessions#
Type:

list [str ]

title#
Type:

str

biome#
Type:

Biome | None

updated_at#
Type:

datetime.datetime

metadata#

Metadata associated with the study, a partial copy of the ENA Study record.

Type:

MGnifyStudyDetailMetadata

downloads#
Type:

list [MGnifyStudyDownloadFile]

first_accession#

Preferred ENA accession for the study (derived from ENA/INSDC accessions)

Type:

None | str | Unset

accession: str #
property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
biome: Biome | None #
downloads: list [MGnifyStudyDownloadFile]#
ena_accessions: list [str ]#
first_accession: None | str | Unset#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

metadata: MGnifyStudyDetailMetadata#
title: str #
to_dict()[source]#
Return type:

dict [str , Any ]

updated_at: datetime.datetime #
class MGnifyStudyDetailMetadata[source]#

Bases: object

Metadata associated with the study, a partial copy of the ENA Study record.

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class MGnifyStudyDownloadFile(file_type, download_type, short_description, long_description, alias, download_group=<mgnipy.emgapi_v2_client.types.Unset object>, path=<mgnipy.emgapi_v2_client.types.Unset object>, file_size_bytes=<mgnipy.emgapi_v2_client.types.Unset object>, index_file=<mgnipy.emgapi_v2_client.types.Unset object>, parent_identifier=<mgnipy.emgapi_v2_client.types.Unset object>, parent_is_private=<mgnipy.emgapi_v2_client.types.Unset object>, parent_results_dir=<mgnipy.emgapi_v2_client.types.Unset object>, index_files=<mgnipy.emgapi_v2_client.types.Unset object>, url=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
file_type#
Type:

DownloadFileType

download_type#
Type:

DownloadType

short_description#

Brief description of the file

Type:

str

long_description#

Detailed description of the file

Type:

str

alias#
Type:

str

download_group#

Group identifier for the download

Type:

None | str | Unset

path#
Type:

str | Unset

file_size_bytes#
Type:

int | None | Unset

index_file#
Type:

DownloadFileIndexFile | list [DownloadFileIndexFile] | None | Unset

parent_identifier#
Type:

int | str | Unset

parent_is_private#
Type:

bool | None | Unset

parent_results_dir#
Type:

None | str | Unset

index_files#
Type:

list [MGnifyDownloadFileIndexFile] | None | Unset

url#
Type:

None | str | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
alias: str #
download_group: None | str | Unset#
download_type: DownloadType#
file_size_bytes: int | None | Unset#
file_type: DownloadFileType#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

index_file: DownloadFileIndexFile | list [DownloadFileIndexFile] | None | Unset#
index_files: list [MGnifyDownloadFileIndexFile] | None | Unset#
long_description: str #
parent_identifier: int | str | Unset#
parent_is_private: bool | None | Unset#
parent_results_dir: None | str | Unset#
path: str | Unset#
short_description: str #
to_dict()[source]#
Return type:

dict [str , Any ]

url: None | str | Unset#
class MGnifyStudyMetadata[source]#

Bases: object

Metadata associated with the study, a partial copy of the ENA Study record.

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class NinjaPaginationResponseSchemaAdditionalContainedGenomeSchema(count, items)[source]#

Bases: object

Parameters:
count#
Type:

int

items#
Type:

list [AdditionalContainedGenomeSchema]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
count: int #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

items: list [AdditionalContainedGenomeSchema]#
to_dict()[source]#
Return type:

dict [str , Any ]

class NinjaPaginationResponseSchemaAnalysedRun(count, items)[source]#

Bases: object

Parameters:
count#
Type:

int

items#
Type:

list [AnalysedRun]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
count: int #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

items: list [AnalysedRun]#
to_dict()[source]#
Return type:

dict [str , Any ]

class NinjaPaginationResponseSchemaAssembly(count, items)[source]#

Bases: object

Parameters:
count#
Type:

int

items#
Type:

list [Assembly]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
count: int #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

items: list [Assembly]#
to_dict()[source]#
Return type:

dict [str , Any ]

class NinjaPaginationResponseSchemaAssemblyDetail(count, items)[source]#

Bases: object

Parameters:
count#
Type:

int

items#
Type:

list [AssemblyDetail]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
count: int #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

items: list [AssemblyDetail]#
to_dict()[source]#
Return type:

dict [str , Any ]

class NinjaPaginationResponseSchemaBiome(count, items)[source]#

Bases: object

Parameters:
count#
Type:

int

items#
Type:

list [Biome]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
count: int #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

items: list [Biome]#
to_dict()[source]#
Return type:

dict [str , Any ]

class NinjaPaginationResponseSchemaGenomeAssemblyLinkSchema(count, items)[source]#

Bases: object

Parameters:
count#
Type:

int

items#
Type:

list [GenomeAssemblyLinkSchema]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
count: int #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

items: list [GenomeAssemblyLinkSchema]#
to_dict()[source]#
Return type:

dict [str , Any ]

class NinjaPaginationResponseSchemaGenomeCatalogueList(count, items)[source]#

Bases: object

Parameters:
count#
Type:

int

items#
Type:

list [GenomeCatalogueList]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
count: int #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

items: list [GenomeCatalogueList]#
to_dict()[source]#
Return type:

dict [str , Any ]

class NinjaPaginationResponseSchemaGenomeList(count, items)[source]#

Bases: object

Parameters:
count#
Type:

int

items#
Type:

list [GenomeList]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
count: int #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

items: list [GenomeList]#
to_dict()[source]#
Return type:

dict [str , Any ]

class NinjaPaginationResponseSchemaMGnifyAnalysis(count, items)[source]#

Bases: object

Parameters:
count#
Type:

int

items#
Type:

list [MGnifyAnalysis]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
count: int #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

items: list [MGnifyAnalysis]#
to_dict()[source]#
Return type:

dict [str , Any ]

class NinjaPaginationResponseSchemaMGnifyAnalysisDetail(count, items)[source]#

Bases: object

Parameters:
count#
Type:

int

items#
Type:

list [MGnifyAnalysisDetail]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
count: int #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

items: list [MGnifyAnalysisDetail]#
to_dict()[source]#
Return type:

dict [str , Any ]

class NinjaPaginationResponseSchemaMGnifyAnalysisTypedAnnotation(count, items)[source]#

Bases: object

Parameters:
count#
Type:

int

items#
Type:

list [MGnifyAnalysisTypedAnnotation]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
count: int #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

items: list [MGnifyAnalysisTypedAnnotation]#
to_dict()[source]#
Return type:

dict [str , Any ]

class NinjaPaginationResponseSchemaMGnifyPublication(count, items)[source]#

Bases: object

Parameters:
count#
Type:

int

items#
Type:

list [MGnifyPublication]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
count: int #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

items: list [MGnifyPublication]#
to_dict()[source]#
Return type:

dict [str , Any ]

class NinjaPaginationResponseSchemaMGnifySample(count, items)[source]#

Bases: object

Parameters:
count#
Type:

int

items#
Type:

list [MGnifySample]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
count: int #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

items: list [MGnifySample]#
to_dict()[source]#
Return type:

dict [str , Any ]

class NinjaPaginationResponseSchemaMGnifySampleWithMetadata(count, items)[source]#

Bases: object

Parameters:
count#
Type:

int

items#
Type:

list [MGnifySampleWithMetadata]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
count: int #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

items: list [MGnifySampleWithMetadata]#
to_dict()[source]#
Return type:

dict [str , Any ]

class NinjaPaginationResponseSchemaMGnifyStudy(count, items)[source]#

Bases: object

Parameters:
count#
Type:

int

items#
Type:

list [MGnifyStudy]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
count: int #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

items: list [MGnifyStudy]#
to_dict()[source]#
Return type:

dict [str , Any ]

class NinjaPaginationResponseSchemaSuperStudy(count, items)[source]#

Bases: object

Parameters:
count#
Type:

int

items#
Type:

list [SuperStudy]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
count: int #
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

items: list [SuperStudy]#
to_dict()[source]#
Return type:

dict [str , Any ]

class OrderByFilterLiteralaccessionAccessionLengthLengthCompletenessCompletenessContaminationContaminationNumGenomesTotalNumGenomesTotal(order=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:

order (None | OrderByFilterLiteralaccessionAccessionLengthLengthCompletenessCompletenessContaminationContaminationNumGenomesTotalNumGenomesTotalOrderType0 | Unset)

order (None | OrderByFilterLiteralaccessionAccessionLengthLengthCompletenessCompletenessContaminationContaminati

onNumGenomesTotalNumGenomesTotalOrderType0 | Unset):

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

order: None | OrderByFilterLiteralaccessionAccessionLengthLengthCompletenessCompletenessContaminationContaminationNumGenomesTotalNumGenomesTotalOrderType0 | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class OrderByFilterLiteralaccessionAccessionLengthLengthCompletenessCompletenessContaminationContaminationNumGenomesTotalNumGenomesTotalOrderType0(*values)[source]#

Bases: str , Enum

ACCESSION = 'accession'#
COMPLETENESS = 'completeness'#
CONTAMINATION = 'contamination'#
LENGTH = 'length'#
NUM_GENOMES_TOTAL = 'num_genomes_total'#
VALUE_1 = '-accession'#
VALUE_10 = ''#
VALUE_3 = '-length'#
VALUE_5 = '-completeness'#
VALUE_7 = '-contamination'#
VALUE_9 = '-num_genomes_total'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class OrderByFilterLiteralaccessionAccessionUpdatedAtUpdatedAt(order=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:

order (None | OrderByFilterLiteralaccessionAccessionUpdatedAtUpdatedAtOrderType0 | Unset)

order#
Type:

None | OrderByFilterLiteralaccessionAccessionUpdatedAtUpdatedAtOrderType0 | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

order: None | OrderByFilterLiteralaccessionAccessionUpdatedAtUpdatedAtOrderType0 | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class OrderByFilterLiteralaccessionAccessionUpdatedAtUpdatedAtOrderType0(*values)[source]#

Bases: str , Enum

ACCESSION = 'accession'#
UPDATED_AT = 'updated_at'#
VALUE_1 = '-accession'#
VALUE_3 = '-updated_at'#
VALUE_4 = ''#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class OrderByFilterLiteralpublishedYearPublishedYear(order=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:

order (None | OrderByFilterLiteralpublishedYearPublishedYearOrderType0 | Unset)

order#
Type:

None | OrderByFilterLiteralpublishedYearPublishedYearOrderType0 | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

order: None | OrderByFilterLiteralpublishedYearPublishedYearOrderType0 | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class OrderByFilterLiteralpublishedYearPublishedYearOrderType0(*values)[source]#

Bases: str , Enum

PUBLISHED_YEAR = 'published_year'#
VALUE_1 = '-published_year'#
VALUE_2 = ''#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class OrderByFilterLiteralsampleTitleSampleTitleUpdatedAtUpdatedAt(order=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:

order (None | OrderByFilterLiteralsampleTitleSampleTitleUpdatedAtUpdatedAtOrderType0 | Unset)

order#
Type:

None | OrderByFilterLiteralsampleTitleSampleTitleUpdatedAtUpdatedAtOrderType0 | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

order: None | OrderByFilterLiteralsampleTitleSampleTitleUpdatedAtUpdatedAtOrderType0 | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class OrderByFilterLiteralsampleTitleSampleTitleUpdatedAtUpdatedAtOrderType0(*values)[source]#

Bases: str , Enum

SAMPLE_TITLE = 'sample_title'#
UPDATED_AT = 'updated_at'#
VALUE_1 = '-sample_title'#
VALUE_3 = '-updated_at'#
VALUE_4 = ''#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class PipelineVersions(*values)[source]#

Bases: str , Enum

V1 = 'V1'#
V2 = 'V2'#
V3 = 'V3'#
V4 = 'V4'#
V4_1 = 'V4.1'#
V5 = 'V5'#
V6 = 'V6'#
V6_1 = 'V6.1'#
capitalize()#

Return a capitalized version of the string.

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

casefold()#

Return a version of the string suitable for caseless comparisons.

center(width, fillchar=' ', /)#

Return a centered string of length width.

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

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(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()#

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(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()#

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(*args, **kwargs)#

Return a formatted version of the string, using substitutions from args and kwargs. The substitutions are identified by braces (‘{’ and ‘}’).

format_map(mapping, /)#

Return a formatted version of the string, using substitutions from mapping. The substitutions are identified by braces (‘{’ and ‘}’).

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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()#

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(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(width, fillchar=' ', /)#

Return a left-justified string of length width.

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

lower()#

Return a copy of the string converted to lowercase.

lstrip(chars=None, /)#

Return a copy of the string with leading whitespace removed.

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

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

partition(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(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(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(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()#

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()#

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(width, fillchar=' ', /)#

Return a right-justified string of length width.

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

rpartition(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(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(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(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(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()#

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(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()#

Convert uppercase characters to lowercase and lowercase characters to uppercase.

title()#

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(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()#

Return a copy of the string converted to uppercase.

zfill(width, /)#

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

The string is never truncated.

class PublicationAnnotations(sample_processing, other)[source]#

Bases: object

Parameters:
sample_processing#

List of sample processing annotations

Type:

list [EuropePmcAnnotationGroup]

other#

List of other annotations

Type:

list [EuropePmcAnnotationGroup]

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

other: list [EuropePmcAnnotationGroup]#
sample_processing: list [EuropePmcAnnotationGroup]#
to_dict()[source]#
Return type:

dict [str , Any ]

class PublicationListFilters(published_after=<mgnipy.emgapi_v2_client.types.Unset object>, published_before=<mgnipy.emgapi_v2_client.types.Unset object>, title=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
published_after#

Filter by minimum publication year

Type:

int | None | Unset

published_before#

Filter by maximum publication year

Type:

int | None | Unset

title#

Search within publication titles

Type:

None | str | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

published_after: int | None | Unset#
published_before: int | None | Unset#
title: None | str | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class RunListFilters(has_experiment_type=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:

has_experiment_type (ExperimentTypes | None | Unset)

has_experiment_type#

If set, will only show runs with the specified experiment type

Type:

ExperimentTypes | None | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

has_experiment_type: ExperimentTypes | None | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class SampleListFilters(biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, search=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
biome_lineage#

The lineage to match, including all descendant biomes

Type:

None | str | Unset

search#

Search within sample titles and accessions

Type:

None | str | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
biome_lineage: None | str | Unset#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

search: None | str | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class Schema[source]#

Bases: object

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

class StudyListFilters(biome_lineage=<mgnipy.emgapi_v2_client.types.Unset object>, has_analyses_from_pipeline=<mgnipy.emgapi_v2_client.types.Unset object>, search=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
biome_lineage#

The lineage to match, including all descendant biomes

Type:

None | str | Unset

has_analyses_from_pipeline#

If set, will only show studies with analyses from the specified MGnify pipeline version

Type:

None | PipelineVersions | Unset

search#

Search within study titles and accessions

Type:

None | str | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
biome_lineage: None | str | Unset#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

has_analyses_from_pipeline: None | PipelineVersions | Unset#
search: None | str | Unset#
to_dict()[source]#
Return type:

dict [str , Any ]

class SuperStudy(slug, title, description=<mgnipy.emgapi_v2_client.types.Unset object>, logo_url=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
slug#
Type:

str

title#
Type:

str

description#
Type:

None | str | Unset

logo_url#
Type:

None | str | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
description: None | str | Unset#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

logo_url: None | str | Unset#
slug: str #
title: str #
to_dict()[source]#
Return type:

dict [str , Any ]

class SuperStudyDetail(slug, title, flagship_studies, related_studies, genome_catalogues, description=<mgnipy.emgapi_v2_client.types.Unset object>, logo_url=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Bases: object

Parameters:
slug#
Type:

str

title#
Type:

str

flagship_studies#
Type:

list [MGnifyStudy]

related_studies#
Type:

list [MGnifyStudy]

genome_catalogues#
Type:

list [GenomeCatalogueList]

description#
Type:

None | str | Unset

logo_url#
Type:

None | str | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any]#
description: None | str | Unset#
flagship_studies: list [MGnifyStudy]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

genome_catalogues: list [GenomeCatalogueList]#
logo_url: None | str | Unset#
related_studies: list [MGnifyStudy]#
slug: str #
title: str #
to_dict()[source]#
Return type:

dict [str , Any ]

class TokenVerifyInputSchema(token)[source]#

Bases: object

Parameters:

token (str )

token#
Type:

str

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

token: str #
class WebinTokenRefreshRequest(token)[source]#

Bases: object

Parameters:

token (str )

token#
Type:

str

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

token: str #
class WebinTokenRequest(username, password)[source]#

Bases: object

Parameters:
username#
Type:

str

password#
Type:

str

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

password: str #
to_dict()[source]#
Return type:

dict [str , Any ]

username: str #
class WebinTokenResponse(token, token_type='sliding')[source]#

Bases: object

Parameters:
token#
Type:

str

token_type#

Default: ‘sliding’.

Type:

str | Unset

property additional_keys: list [str ]#
additional_properties: dict [str , Any ]#
classmethod from_dict(src_dict)[source]#
Parameters:

src_dict (Mapping [str , Any ])

Return type:

T

to_dict()[source]#
Return type:

dict [str , Any ]

token: str #
token_type: str | Unset#

Submodules#