mgnipy.emgapi_v2_client.api.genomes.get_genome_annotations module

mgnipy.emgapi_v2_client.api.genomes.get_genome_annotations module#

async asyncio(accession, *, client, catalogue_id=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Get the annotations for a single MGnify Genome

Annotations are taxonomic and functional assignments for the genome.

Parameters:
Raises:
  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

GenomeWithAnnotations

Return type:

GenomeWithAnnotations | None

async asyncio_detailed(accession, *, client, catalogue_id=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Get the annotations for a single MGnify Genome

Annotations are taxonomic and functional assignments for the genome.

Parameters:
Raises:
  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[GenomeWithAnnotations]

Return type:

Response[GenomeWithAnnotations]

sync(accession, *, client, catalogue_id=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Get the annotations for a single MGnify Genome

Annotations are taxonomic and functional assignments for the genome.

Parameters:
Raises:
  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

GenomeWithAnnotations

Return type:

GenomeWithAnnotations | None

sync_detailed(accession, *, client, catalogue_id=<mgnipy.emgapi_v2_client.types.Unset object>)[source]#

Get the annotations for a single MGnify Genome

Annotations are taxonomic and functional assignments for the genome.

Parameters:
Raises:
  • errors.UnexpectedStatus – If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

  • httpx.TimeoutException – If the request takes longer than Client.timeout.

Returns:

Response[GenomeWithAnnotations]

Return type:

Response[GenomeWithAnnotations]