ProtoModel

pydantic model qcelemental.models.ProtoModel[source]

Show JSON schema
{
   "title": "ProtoModel",
   "type": "object",
   "properties": {},
   "additionalProperties": false
}

compare(other, **kwargs)[source]

Compares the current object to the provided object recursively.

Parameters
Returns

True if the objects match.

Return type

bool

dict(**kwargs)[source]

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Return type

Dict[str, Any]

json(**kwargs)[source]

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

classmethod parse_file(path, *, encoding=None)[source]

Parses a file into a Model object.

Parameters
  • path (Union[str, Path]) – The path to the file.

  • encoding (Optional[str]) – The type of the files, available types are: {‘json’, ‘msgpack’, ‘pickle’}. Attempts to automatically infer the file type from the file extension if None.

Returns

The requested model from a serialized format.

Return type

Model

classmethod parse_raw(data, *, encoding=None)[source]

Parses raw string or bytes into a Model object.

Parameters
  • data (Union[bytes, str]) – A serialized data blob to be deserialized into a Model.

  • encoding (Optional[str]) – The type of the serialized array, available types are: {‘json’, ‘json-ext’, ‘msgpack-ext’, ‘pickle’}

Returns

The requested model from a serialized format.

Return type

Model

serialize(encoding, *, include=None, exclude=None, exclude_unset=None, exclude_defaults=None, exclude_none=None)[source]

Generates a serialized representation of the model

Parameters
  • encoding (str) – The serialization type, available types are: {‘json’, ‘json-ext’, ‘msgpack-ext’}

  • include (Optional[Set[str]]) – Fields to be included in the serialization.

  • exclude (Optional[Set[str]]) – Fields to be excluded in the serialization.

  • exclude_unset (Optional[bool]) – If True, skips fields that have default values provided.

  • exclude_defaults (Optional[bool]) – If True, skips fields that have set or defaulted values equal to the default.

  • exclude_none (Optional[bool]) – If True, skips fields that have value None.

Returns

The serialized model.

Return type

Union[bytes, str]