write_rds#

write_rds(path, data, *, file_format='xdr', compression='gzip', encoding='utf-8', format_version=DEFAULT_FORMAT_VERSION, constructor_dict=DEFAULT_CLASS_MAP)[source]#

Write an RDS file.

This is a convenience function that wraps conversion and unparsing as it is the common use case.

Parameters:

  • path (os.PathLike[Any] | str) – File path to be written.

  • data (Any) – Python data object.

  • file_format (FileFormat) – File format.

  • compression (Compression) – Compression.

  • encoding (Encoding) – Encoding to be used for strings within data.

  • format_version (int) – File format version.

  • constructor_dict (ConstructorDict) – Dictionary mapping Python classes to functions converting them to R classes.

Return type:

None

See also

write_rda(): Similar function that writes an RDA or RDATA file.

Examples

Write a Python object to an RDS file.

>>> import rdata
>>>
>>> data = ["hello", 1, 2.2, 3.3+4.4j]
>>> rdata.write_rds("test.rds", data)