mgnipy.emgapi_v2_client.api.samples.get_mgnify_sample module

mgnipy.emgapi_v2_client.api.samples.get_mgnify_sample module#

async mgnipy.emgapi_v2_client.api.samples.get_mgnify_sample.asyncio(accession, *, client)[source]#

Get the detail of a single sample analysed by MGnify

MGnify samples inherit directly from samples (or BioSamples) in ENA.

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:

MGnifySampleDetail

Return type:

MGnifySampleDetail | None

async mgnipy.emgapi_v2_client.api.samples.get_mgnify_sample.asyncio_detailed(accession, *, client)[source]#

Get the detail of a single sample analysed by MGnify

MGnify samples inherit directly from samples (or BioSamples) in ENA.

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[MGnifySampleDetail]

Return type:

Response[MGnifySampleDetail]

mgnipy.emgapi_v2_client.api.samples.get_mgnify_sample.sync(accession, *, client)[source]#

Get the detail of a single sample analysed by MGnify

MGnify samples inherit directly from samples (or BioSamples) in ENA.

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:

MGnifySampleDetail

Return type:

MGnifySampleDetail | None

mgnipy.emgapi_v2_client.api.samples.get_mgnify_sample.sync_detailed(accession, *, client)[source]#

Get the detail of a single sample analysed by MGnify

MGnify samples inherit directly from samples (or BioSamples) in ENA.

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[MGnifySampleDetail]

Return type:

Response[MGnifySampleDetail]