Add constructor_dict to helper functions

rdata/_write.py

@@ -3,15 +3,18 @@
 
 from typing import TYPE_CHECKING
 
-from .conversion import convert_python_to_r_data
-from .conversion.to_r import DEFAULT_FORMAT_VERSION
+from .conversion import (
+    DEFAULT_CONSTRUCTOR_DICT,
+    DEFAULT_FORMAT_VERSION,
+    convert_python_to_r_data,
+)
 from .unparser import unparse_file
 
 if TYPE_CHECKING:
     import os
     from typing import Any
 
-    from .conversion.to_r import Encoding
+    from .conversion.to_r import ConstructorDict, Encoding
     from .unparser import Compression, FileFormat
 
 
@@ -23,6 +26,7 @@ def write_rds(
     compression: Compression = "gzip",
     encoding: Encoding = "utf-8",
     format_version: int = DEFAULT_FORMAT_VERSION,
+    constructor_dict: ConstructorDict = DEFAULT_CONSTRUCTOR_DICT,
 ) -> None:
     """
     Write an RDS file.
@@ -37,6 +41,7 @@ def write_rds(
         compression: Compression.
         encoding: Encoding to be used for strings within data.
         format_version: File format version.
+        constructor_dict: Dictionary mapping Python types to R classes.
 
     See Also:
         :func:`write_rda`: Similar function that writes an RDA or RDATA file.
@@ -53,6 +58,7 @@ def write_rds(
         data,
         encoding=encoding,
         format_version=format_version,
+        constructor_dict=constructor_dict,
     )
 
     unparse_file(
@@ -72,6 +78,7 @@ def write_rda(
     compression: Compression = "gzip",
     encoding: Encoding = "utf-8",
     format_version: int = DEFAULT_FORMAT_VERSION,
+    constructor_dict: ConstructorDict = DEFAULT_CONSTRUCTOR_DICT,
 ) -> None:
     """
     Write an RDA or RDATA file.
@@ -86,6 +93,7 @@ def write_rda(
         compression: Compression.
         encoding: Encoding to be used for strings within data.
         format_version: File format version.
+        constructor_dict: Dictionary mapping Python types to R classes.
 
     See Also:
         :func:`write_rds`: Similar function that writes an RDS file.
@@ -102,6 +110,7 @@ def write_rda(
         data,
         encoding=encoding,
         format_version=format_version,
+        constructor_dict=constructor_dict,
         file_type="rda",
     )
 

rdata/conversion/__init__.py

@@ -25,6 +25,8 @@
     ts_constructor as ts_constructor,
 )
 from .to_r import (
+    DEFAULT_CONSTRUCTOR_DICT as DEFAULT_CONSTRUCTOR_DICT,
+    DEFAULT_FORMAT_VERSION as DEFAULT_FORMAT_VERSION,
     ConverterFromPythonToR as ConverterFromPythonToR,
     convert_python_to_r_data as convert_python_to_r_data,
     convert_python_to_r_object as convert_python_to_r_object,

rdata/conversion/to_r.py

@@ -346,31 +346,30 @@ class ConverterFromPythonToR:
     Class converting Python objects to R objects.
 
     Attributes:
-        constructor_dict: Dictionary mapping Python types to R classes.
         encoding: Encoding to be used for strings within data.
         format_version: File format version.
         r_version_serialized: R version written as the creator of the object.
+        constructor_dict: Dictionary mapping Python types to R classes.
     """
-    def __init__(self,
-        constructor_dict: ConstructorDict = DEFAULT_CONSTRUCTOR_DICT,
-        *,
+    def __init__(self, *,
         encoding: Encoding = "utf-8",
         format_version: int = DEFAULT_FORMAT_VERSION,
         r_version_serialized: int = DEFAULT_R_VERSION_SERIALIZED,
+        constructor_dict: ConstructorDict = DEFAULT_CONSTRUCTOR_DICT,
     ) -> None:
         """
         Init class.
 
         Args:
-            constructor_dict: Dictionary mapping Python types to R classes.
             encoding: Encoding to be used for strings within data.
             format_version: File format version.
             r_version_serialized: R version written as the creator of the object.
+            constructor_dict: Dictionary mapping Python types to R classes.
         """
-        self.constructor_dict = constructor_dict
         self.encoding = encoding
         self.format_version = format_version
         self.r_version_serialized = r_version_serialized
+        self.constructor_dict = constructor_dict
         self._references: dict[str | None, tuple[int, RObject | None]] \
             = {None: (0, None)}
 
@@ -631,6 +630,7 @@ def convert_python_to_r_data(
     encoding: Encoding = "utf-8",
     format_version: int = DEFAULT_FORMAT_VERSION,
     r_version_serialized: int = DEFAULT_R_VERSION_SERIALIZED,
+    constructor_dict: ConstructorDict = DEFAULT_CONSTRUCTOR_DICT,
     file_type: FileType = "rds",
 ) -> RData:
     """
@@ -641,6 +641,7 @@ def convert_python_to_r_data(
         encoding: Encoding to be used for strings within data.
         format_version: File format version.
         r_version_serialized: R version written as the creator of the object.
+        constructor_dict: Dictionary mapping Python types to R classes.
         file_type: File type.
 
     Returns:
@@ -653,6 +654,7 @@ def convert_python_to_r_data(
         encoding=encoding,
         format_version=format_version,
         r_version_serialized=r_version_serialized,
+        constructor_dict=constructor_dict,
     ).convert_to_r_data(data, file_type=file_type)
 
 
@@ -662,6 +664,7 @@ def convert_python_to_r_object(
     encoding: Encoding = "utf-8",
     format_version: int = DEFAULT_FORMAT_VERSION,
     r_version_serialized: int = DEFAULT_R_VERSION_SERIALIZED,
+    constructor_dict: ConstructorDict = DEFAULT_CONSTRUCTOR_DICT,
 ) -> RObject:
     """
     Convert Python data to R object.
@@ -671,6 +674,7 @@ def convert_python_to_r_object(
         encoding: Encoding to be used for strings within data.
         format_version: File format version.
         r_version_serialized: R version written as the creator of the object.
+        constructor_dict: Dictionary mapping Python types to R classes.
 
     Returns:
         Corresponding RObject object.
@@ -682,4 +686,5 @@ def convert_python_to_r_object(
         encoding=encoding,
         format_version=format_version,
         r_version_serialized=r_version_serialized,
+        constructor_dict=constructor_dict,
     ).convert_to_r_object(data)