Data classes

fathomnet-py uses native Python dataclasses to model FathomNet entities.

---

class fathomnet.dto.ABoundingBoxDTO(id: int | None = None, uuid: str | None = None, userDefinedKey: str | None = None, concept: str | None = None, altConcept: str | None = None, image: fathomnet.dto.AImageDTO | None = None, groupOf: bool | None = None, height: int | None = None, occluded: bool | None = None, observer: str | None = None, truncated: bool | None = None, width: int | None = None, x: int | None = None, y: int | None = None, rejected: bool | None = None, verified: bool | None = None, verifier: str | None = None, verificationTimestamp: str | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None)

altConcept: str | None = None

concept: str | None = None

createdTimestamp: str | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

groupOf: bool | None = None

height: int | None = None

id: int | None = None

image: AImageDTO | None = None

lastUpdatedTimestamp: str | None = None

observer: str | None = None

occluded: bool | None = None

rejected: bool | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

truncated: bool | None = None

userDefinedKey: str | None = None

uuid: str | None = None

verificationTimestamp: str | None = None

verified: bool | None = None

verifier: str | None = None

width: int | None = None

x: int | None = None

y: int | None = None

class fathomnet.dto.AImageDTO(id: int | None = None, uuid: str | None = None, url: str | None = None, valid: bool | None = None, imagingType: str | None = None, depthMeters: float | None = None, height: int | None = None, lastValidation: str | None = None, latitude: float | None = None, longitude: float | None = None, altitude: float | None = None, salinity: float | None = None, temperatureCelsius: float | None = None, oxygenMlL: float | None = None, pressureDbar: float | None = None, mediaType: str | None = None, modified: str | None = None, sha256: str | None = None, contributorsEmail: str | None = None, tags: List[ForwardRef('ATagDTO')] | None = None, timestamp: str | None = None, width: int | None = None, boundingBoxes: List[ForwardRef('ABoundingBoxDTO')] | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None)

altitude: float | None = None

boundingBoxes: List[ABoundingBoxDTO] | None = None

contributorsEmail: str | None = None

createdTimestamp: str | None = None

depthMeters: float | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

height: int | None = None

id: int | None = None

imagingType: str | None = None

lastUpdatedTimestamp: str | None = None

lastValidation: str | None = None

latitude: float | None = None

longitude: float | None = None

mediaType: str | None = None

modified: str | None = None

oxygenMlL: float | None = None

pressureDbar: float | None = None

salinity: float | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

sha256: str | None = None

tags: List[ATagDTO] | None = None

temperatureCelsius: float | None = None

timestamp: str | None = None

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

to_pascal_voc(path: str | None = None, pretty_print: bool = False) → str

Convert to a Pascal VOC.

Parameters:

• path (Optional[str], optional) – Path to the image file, defaults to using the image URL if available

• pretty_print (bool, optional) – Set true to add indentation and newlines in XML, defaults to False

Raises:

ValueError – Raised if both the path and image URL are unspecified

Returns:

Pascal VOC encoded string

Return type:

str

url: str | None = None

uuid: str | None = None

valid: bool | None = None

width: int | None = None

class fathomnet.dto.ATagDTO(id: int | None = None, uuid: str | None = None, key: str | None = None, mediaType: str | None = None, value: str | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None, image: fathomnet.dto.AImageDTO | None = None)

createdTimestamp: str | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

id: int | None = None

image: AImageDTO | None = None

key: str | None = None

lastUpdatedTimestamp: str | None = None

mediaType: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

uuid: str | None = None

value: str | None = None

class fathomnet.dto.Activity(topic: fathomnet.dto.Topic | None = None, attributedTo: str | None = None, lastUpdated: str | None = None, content: str | None = None, data: dict | None = None)

attributedTo: str | None = None

content: str | None = None

data: dict | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

lastUpdated: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

topic: Topic | None = None

class fathomnet.dto.ApiKey(uuid: str | None = None, apiKey: str | None = None)

apiKey: str | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

uuid: str | None = None

class fathomnet.dto.AuthHeader(type: str | None = None, token: str | None = None)

property auth_dict

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

token: str | None = None

type: str | None = None

class fathomnet.dto.Authentication(attributes: object | None = None)

attributes: object | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

class fathomnet.dto.BDarwinCore(uuid: str | None = None, recordType: str | None = None, basisOfRecord: str | None = None, datasetID: str | None = None, recordLanguage: str | None = None, license: str | None = None, modified: str | None = None, ownerInstitutionCode: str | None = None, accessRights: str | None = None, bibliographicCitation: str | None = None, collectionCode: str | None = None, collectionID: str | None = None, dataGeneralizations: str | None = None, datasetName: str | None = None, dynamicProperties: str | None = None, informationWithheld: str | None = None, institutionCode: str | None = None, institutionID: str | None = None, recordReferences: str | None = None, rightsHolder: str | None = None)

accessRights: str | None = None

basisOfRecord: str | None = None

bibliographicCitation: str | None = None

collectionCode: str | None = None

collectionID: str | None = None

dataGeneralizations: str | None = None

datasetID: str | None = None

datasetName: str | None = None

dynamicProperties: str | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

informationWithheld: str | None = None

institutionCode: str | None = None

institutionID: str | None = None

license: str | None = None

modified: str | None = None

ownerInstitutionCode: str | None = None

recordLanguage: str | None = None

recordReferences: str | None = None

recordType: str | None = None

rightsHolder: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

uuid: str | None = None

class fathomnet.dto.BImageSetUploadDTO(uuid: str | None = None, localPath: str | None = None, remoteUri: str | None = None, sha256: str | None = None, format: ForwardRef('ImageSetUpload.UploadFormat') | None = None, contributorsEmail: str | None = None, status: ForwardRef('ImageSetUpload.Status') | None = None, statusUpdaterEmail: str | None = None, statusUpdateTimestamp: str | None = None, rejectionReason: str | None = None, rejectionDetails: str | None = None, darwinCore: fathomnet.dto.BDarwinCore | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None)

contributorsEmail: str | None = None

createdTimestamp: str | None = None

darwinCore: BDarwinCore | None = None

format: UploadFormat | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

lastUpdatedTimestamp: str | None = None

localPath: str | None = None

rejectionDetails: str | None = None

rejectionReason: str | None = None

remoteUri: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

sha256: str | None = None

status: Status | None = None

statusUpdateTimestamp: str | None = None

statusUpdaterEmail: str | None = None

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

uuid: str | None = None

class fathomnet.dto.Badge(name: str | None = None, since: str | None = None, data: dict | None = None)

data: dict | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

name: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

since: str | None = None

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

class fathomnet.dto.BoundingBox(uuid: str | None = None, id: int | None = None, userDefinedKey: str | None = None, concept: str | None = None, altConcept: str | None = None, image: ForwardRef('Image') | None = None, groupOf: bool | None = None, height: int | None = None, occluded: bool | None = None, observer: str | None = None, truncated: bool | None = None, width: int | None = None, x: int | None = None, y: int | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None, verified: bool | None = None, verifier: str | None = None, verificationTimestamp: str | None = None)

altConcept: str | None = None

concept: str | None = None

createdTimestamp: str | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

groupOf: bool | None = None

height: int | None = None

id: int | None = None

image: Image | None = None

lastUpdatedTimestamp: str | None = None

observer: str | None = None

occluded: bool | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

truncated: bool | None = None

userDefinedKey: str | None = None

uuid: str | None = None

verificationTimestamp: str | None = None

verified: bool | None = None

verifier: str | None = None

width: int | None = None

x: int | None = None

y: int | None = None

class fathomnet.dto.BoundingBoxComment(uuid: str | None = None, boundingBoxUuid: str | None = None, email: str | None = None, text: str | None = None, alternateConcept: str | None = None, flagged: bool | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None)

alternateConcept: str | None = None

boundingBoxUuid: str | None = None

createdTimestamp: str | None = None

email: str | None = None

flagged: bool | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

lastUpdatedTimestamp: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

text: str | None = None

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

uuid: str | None = None

class fathomnet.dto.BoundingBoxCommentContent(text: str | None = None, alternateConcept: str | None = None)

alternateConcept: str | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

text: str | None = None

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

class fathomnet.dto.BoundingBoxDTO(id: int | None = None, uuid: str | None = None, userDefinedKey: str | None = None, concept: str | None = None, altConcept: str | None = None, image: fathomnet.dto.AImageDTO | None = None, groupOf: bool | None = None, height: int | None = None, occluded: bool | None = None, observer: str | None = None, truncated: bool | None = None, width: int | None = None, x: int | None = None, y: int | None = None, rejected: bool | None = None, verified: bool | None = None, verifier: str | None = None, verificationTimestamp: str | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None, imageUuid: str | None = None)

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

imageUuid: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

class fathomnet.dto.ByConceptCount(concept: str | None = None, count: int | None = None)

concept: str | None = None

count: int | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

class fathomnet.dto.ByContributorCount(contributorsEmail: str | None = None, count: int | None = None)

contributorsEmail: str | None = None

count: int | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

class fathomnet.dto.Count(objectType: str | None = None, count: int | None = None)

count: int | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

objectType: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

class fathomnet.dto.DarwinCore(id: int | None = None, uuid: str | None = None, recordType: str | None = None, basisOfRecord: str | None = None, datasetID: str | None = None, recordLanguage: str | None = None, license: str | None = None, modified: str | None = None, ownerInstitutionCode: str | None = None, accessRights: str | None = None, bibliographicCitation: str | None = None, collectionCode: str | None = None, collectionID: str | None = None, dataGeneralizations: str | None = None, datasetName: str | None = None, dynamicProperties: str | None = None, informationWithheld: str | None = None, institutionCode: str | None = None, institutionID: str | None = None, recordReferences: str | None = None, rightsHolder: str | None = None, imageSetUpload: ForwardRef('ImageSetUpload') | None = None)

accessRights: str | None = None

basisOfRecord: str | None = None

bibliographicCitation: str | None = None

collectionCode: str | None = None

collectionID: str | None = None

dataGeneralizations: str | None = None

datasetID: str | None = None

datasetName: str | None = None

dynamicProperties: str | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

id: int | None = None

imageSetUpload: ImageSetUpload | None = None

informationWithheld: str | None = None

institutionCode: str | None = None

institutionID: str | None = None

license: str | None = None

modified: str | None = None

ownerInstitutionCode: str | None = None

recordLanguage: str | None = None

recordReferences: str | None = None

recordType: str | None = None

rightsHolder: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

uuid: str | None = None

class fathomnet.dto.FathomnetIdAdminMutation(disabled: bool | None = None, expertiseRank: str | None = None, roleData: str | None = None, organization: str | None = None)

disabled: bool | None = None

expertiseRank: str | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

organization: str | None = None

roleData: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

class fathomnet.dto.FathomnetIdMutation(jobTitle: str | None = None, organization: str | None = None, profile: str | None = None, displayName: str | None = None)

displayName: str | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

jobTitle: str | None = None

organization: str | None = None

profile: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

class fathomnet.dto.FathomnetIdentity(id: int | None = None, uuid: str | None = None, email: str | None = None, firebaseUid: str | None = None, roleData: str | None = None, organization: str | None = None, jobTitle: str | None = None, profile: str | None = None, apiKey: str | None = None, avatarUrl: str | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None, disabled: bool | None = None, expertiseRank: str | None = None, displayName: str | None = None, roles: List[ForwardRef('Roles')] | None = None, orcid: str | None = None, notificationFrequency: str | None = None)

apiKey: str | None = None

avatarUrl: str | None = None

createdTimestamp: str | None = None

disabled: bool | None = None

displayName: str | None = None

email: str | None = None

expertiseRank: str | None = None

firebaseUid: str | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

id: int | None = None

jobTitle: str | None = None

lastUpdatedTimestamp: str | None = None

notificationFrequency: str | None = None

orcid: str | None = None

organization: str | None = None

profile: str | None = None

roleData: str | None = None

roles: List[Roles] | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

uuid: str | None = None

class fathomnet.dto.FollowedTopic(topic: str | None = None, target: str | None = None, notification: bool | None = None, uuid: str | None = None, email: str | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None)

createdTimestamp: str | None = None

email: str | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

lastUpdatedTimestamp: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

uuid: str | None = None

class fathomnet.dto.GeoImage(uuid: str | None = None, url: str | None = None, latitude: float | None = None, longitude: float | None = None, depthMeters: float | None = None, contributorsEmail: str | None = None, timestamp: str | None = None, valid: bool | None = None, lastValidation: str | None = None)

contributorsEmail: str | None = None

depthMeters: float | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

lastValidation: str | None = None

latitude: float | None = None

longitude: float | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

timestamp: str | None = None

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

url: str | None = None

uuid: str | None = None

valid: bool | None = None

class fathomnet.dto.GeoImageConstraints(concept: str | None = None, taxaProviderName: str | None = None, contributorsEmail: str | None = None, startTimestamp: str | None = None, endTimestamp: str | None = None, imagingTypes: List[str] | None = None, includeUnverified: bool | None = None, includeVerified: bool | None = None, minLongitude: float | None = None, maxLongitude: float | None = None, minLatitude: float | None = None, maxLatitude: float | None = None, minDepth: float | None = None, maxDepth: float | None = None, ownerInstitutionCodes: List[str] | None = None, limit: int | None = None, offset: int | None = None)

concept: str | None = None

contributorsEmail: str | None = None

endTimestamp: str | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

imagingTypes: List[str] | None = None

includeUnverified: bool | None = None

includeVerified: bool | None = None

limit: int | None = None

maxDepth: float | None = None

maxLatitude: float | None = None

maxLongitude: float | None = None

minDepth: float | None = None

minLatitude: float | None = None

minLongitude: float | None = None

offset: int | None = None

ownerInstitutionCodes: List[str] | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

startTimestamp: str | None = None

taxaProviderName: str | None = None

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

class fathomnet.dto.GeoImageConstraintsCount(constraints: fathomnet.dto.GeoImageConstraints | None = None, count: int | None = None)

constraints: GeoImageConstraints | None = None

count: int | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

class fathomnet.dto.Image(id: int | None = None, uuid: str | None = None, url: str | None = None, valid: bool | None = None, imagingType: str | None = None, depthMeters: float | None = None, height: int | None = None, lastValidation: str | None = None, latitude: float | None = None, longitude: float | None = None, altitude: float | None = None, salinity: float | None = None, temperatureCelsius: float | None = None, oxygenMlL: float | None = None, pressureDbar: float | None = None, mediaType: str | None = None, modified: str | None = None, sha256: str | None = None, contributorsEmail: str | None = None, timestamp: str | None = None, width: int | None = None, tags: List[ForwardRef('Tag')] | None = None, boundingBoxes: List[fathomnet.dto.BoundingBox] | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None, imageSetUploads: List[ForwardRef('ImageSetUpload')] | None = None)

altitude: float | None = None

boundingBoxes: List[BoundingBox] | None = None

contributorsEmail: str | None = None

createdTimestamp: str | None = None

depthMeters: float | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

height: int | None = None

id: int | None = None

imageSetUploads: List[ImageSetUpload] | None = None

imagingType: str | None = None

lastUpdatedTimestamp: str | None = None

lastValidation: str | None = None

latitude: float | None = None

longitude: float | None = None

mediaType: str | None = None

modified: str | None = None

oxygenMlL: float | None = None

pressureDbar: float | None = None

salinity: float | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

sha256: str | None = None

tags: List[Tag] | None = None

temperatureCelsius: float | None = None

timestamp: str | None = None

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

url: str | None = None

uuid: str | None = None

valid: bool | None = None

width: int | None = None

class fathomnet.dto.ImageSetUpload(id: int | None = None, uuid: str | None = None, localPath: str | None = None, remoteUri: str | None = None, sha256: str | None = None, contributorsEmail: str | None = None, status: fathomnet.dto.ImageSetUpload.Status | None = None, rejectionReason: str | None = None, rejectionDetails: str | None = None, statusUpdaterEmail: str | None = None, statusUpdateTimestamp: str | None = None, format: fathomnet.dto.ImageSetUpload.UploadFormat | None = None, darwinCore: fathomnet.dto.DarwinCore | None = None, images: List[fathomnet.dto.Image] | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None)

class Status(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

ACCEPTED = 'ACCEPTED'

PENDING = 'PENDING'

REJECTED = 'REJECTED'

class UploadFormat(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

CSV = 'CSV'

UNSUPPORTED = 'UNSUPPORTED'

contributorsEmail: str | None = None

createdTimestamp: str | None = None

darwinCore: DarwinCore | None = None

format: UploadFormat | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

id: int | None = None

images: List[Image] | None = None

lastUpdatedTimestamp: str | None = None

localPath: str | None = None

rejectionDetails: str | None = None

rejectionReason: str | None = None

remoteUri: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

sha256: str | None = None

status: Status | None = None

statusUpdateTimestamp: str | None = None

statusUpdaterEmail: str | None = None

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

uuid: str | None = None

class fathomnet.dto.ImageSetUploadStats(imageSetUploadUuid: str | None = None, imageCount: int | None = None, boundingBoxCount: int | None = None, verifiedBoundingBoxCount: int | None = None)

boundingBoxCount: int | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

imageCount: int | None = None

imageSetUploadUuid: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

verifiedBoundingBoxCount: int | None = None

class fathomnet.dto.MarineRegion(id: int | None = None, MRGID: int | None = None, name: str | None = None, minLatitude: float | None = None, maxLatitude: float | None = None, minLongitude: float | None = None, maxLongitude: float | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None)

MRGID: int | None = None

createdTimestamp: str | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

id: int | None = None

lastUpdatedTimestamp: str | None = None

maxLatitude: float | None = None

maxLongitude: float | None = None

minLatitude: float | None = None

minLongitude: float | None = None

name: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

class fathomnet.dto.Message(message: str | None = None)

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

message: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

class fathomnet.dto.Pageable(number: int | None = None, size: int | None = None, offset: int | None = None, sort: fathomnet.dto.Sort | None = None, sorted: bool | None = None)

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

classmethod from_params(size: int | None = None, page: int | None = None, sort_keys: List[str] | None = None)

Make a Pageable instance from paging parameters.

number: int | None = None

offset: int | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

size: int | None = None

sort: Sort | None = None

sorted: bool | None = None

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

to_params() → List[tuple]

Make a list of paging parameters to be passed into a request.

class fathomnet.dto.Roles(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

ADMIN = 'ADMIN'

MODERATOR = 'MODERATOR'

READ = 'READ'

UNKNOWN = 'UNKNOWN'

UPDATE = 'UPDATE'

WRITE = 'WRITE'

class fathomnet.dto.Sort(sorted: bool | None = None, orderBy: List[fathomnet.dto.Sort.Order] | None = None)

class Order(ignoreCase: bool | None = None, direction: fathomnet.dto.Sort.Order.Direction | None = None, property: str | None = None, ascending: bool | None = None)

class Direction(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

ASC = 'ASC'

DESC = 'DESC'

ascending: bool | None = None

direction: Direction | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

ignoreCase: bool | None = None

property: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

orderBy: List[Order] | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

sorted: bool | None = None

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

class fathomnet.dto.Tag(uuid: str | None = None, id: int | None = None, key: str | None = None, mediaType: str | None = None, value: str | None = None, image: fathomnet.dto.Image | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None)

createdTimestamp: str | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

id: int | None = None

image: Image | None = None

key: str | None = None

lastUpdatedTimestamp: str | None = None

mediaType: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

uuid: str | None = None

value: str | None = None

class fathomnet.dto.TagDTO(id: int | None = None, uuid: str | None = None, key: str | None = None, mediaType: str | None = None, value: str | None = None, createdTimestamp: str | None = None, lastUpdatedTimestamp: str | None = None, image: fathomnet.dto.AImageDTO | None = None, imageUuid: str | None = None)

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

imageUuid: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

class fathomnet.dto.Taxa(name: str | None = None, rank: str | None = None)

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

name: str | None = None

rank: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

class fathomnet.dto.Topic(topic: str | None = None, target: str | None = None, notification: bool | None = None)

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

notification: bool | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

target: str | None = None

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

topic: str | None = None

class fathomnet.dto.WormsNames(aphiaId: int | None = None, name: str | None = None, acceptedName: str | None = None, alternateNames: List[str] | None = None)

acceptedName: str | None = None

alternateNames: List[str] | None = None

aphiaId: int | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

name: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str

class fathomnet.dto.WormsNode(name: str | None = None, rank: str | None = None, aphiaId: int | None = None, acceptedAphiaId: int | None = None, alternateNames: List[str] | None = None, children: List[ForwardRef('WormsNode')] | None = None)

acceptedAphiaId: int | None = None

alternateNames: List[str] | None = None

aphiaId: int | None = None

children: List[WormsNode] | None = None

classmethod from_dict(kvs: dict | list | str | int | float | bool | None, *, infer_missing=False) → A

classmethod from_json(s: str | bytes | bytearray, *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

name: str | None = None

rank: str | None = None

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, dict | list | str | int | float | bool | None]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: int | str | None = None, separators: Tuple[str, str] | None = None, default: Callable | None = None, sort_keys: bool = False, **kw) → str