Merge pull request #25 from yassun7010/rename_record_function

feat: change record_as_csv to record_to_csv.

Author: ya7010

README.md

@@ -109,14 +109,14 @@ Your Production Code
 import os
 
 import turu.sqlite3
-from turu.core.record import record_as_csv
+from turu.core.record import record_to_csv
 
 from your_package.data import RECORD_DIR
 from your_package.schema import Row
 
 
 def do_something(connection: turu.sqlite3.Connection):
-    with record_as_csv(
+    with record_to_csv(
         RECORD_DIR / "test.csv",
         connection.execute_map(Row, "select 1, 'a'"),
         enable=os.environ.get("ENABLE_RECORDING"),

docs/API_documentation/_core.md

@@ -1,5 +1,5 @@
 # turu.core
 
-::: turu.core.record.record_as_csv
+::: turu.core.record.record_to_csv
 
 ::: turu.core.record.CsvRecorderOptions

docs/data/turu_recording_and_testing.py

@@ -2,7 +2,7 @@
 
 import turu.sqlite3
 from pydantic import BaseModel
-from turu.core.record import record_as_csv
+from turu.core.record import record_to_csv
 
 
 class Row(BaseModel):
@@ -12,7 +12,7 @@ class Row(BaseModel):
 
 # Production code
 def do_something(connection: turu.sqlite3.Connection):
-    with record_as_csv(
+    with record_to_csv(
         "test.csv",
         connection.execute_map(Row, "select 1, 'a'"),
         enable=os.environ.get("ENABLE_RECORDING"),

docs/testing.md

@@ -41,7 +41,7 @@ def test_do_something():
 
 ## Recording & Testing
 
-In the production code, the actual rows can be recorded to a csv file using the `record_as_csv` method.
+In the production code, the actual rows can be recorded to a csv file using the `record_to_csv` method.
 
 Recording on/off can be controlled with the `enable` option (default is `True`).
 

turu-core/src/turu/core/record/__init__.py

@@ -13,11 +13,11 @@
 from turu.core.record.async_record_cursor import AsyncRecordCursor
 from turu.core.record.csv_recorder import CsvRecorder, CsvRecorderOptions
 from turu.core.record.record_cursor import RecordCursor
-from typing_extensions import Unpack
+from typing_extensions import Unpack, deprecated
 
 
 @overload
-def record_as_csv(
+def record_to_csv(
     record_filepath: Union[str, Path],
     cursor: turu.core.cursor.GenericCursor,
     *,
@@ -28,7 +28,7 @@ def record_as_csv(
 
 
 @overload
-def record_as_csv(
+def record_to_csv(
     record_filepath: Union[str, Path],
     cursor: turu.core.async_cursor.GenericAsyncCursor,
     *,
@@ -38,7 +38,7 @@ def record_as_csv(
     ...
 
 
-def record_as_csv(  # type: ignore
+def record_to_csv(  # type: ignore
     record_filepath: Union[str, Path],
     cursor: Union[
         turu.core.cursor.GenericCursor, turu.core.async_cursor.GenericAsyncCursor
@@ -57,20 +57,20 @@ def record_as_csv(  # type: ignore
     """
     if isinstance(cursor, turu.core.cursor.Cursor):
         return _GeneratorContextManager(
-            _record_as_csv, (record_filepath, cursor), dict(enable=enable, **options)
+            _record_to_csv, (record_filepath, cursor), dict(enable=enable, **options)
         )
 
     elif isinstance(cursor, turu.core.async_cursor.AsyncCursor):
         return _AsyncGeneratorContextManager(
-            _record_as_csv_async,
+            _record_to_csv_async,
             (record_filepath, cursor),
             dict(enable=enable, **options),
         )
 
     raise NotImplementedError(f"cursor type {type(cursor)} is not supported")
 
 
-def _record_as_csv(
+def _record_to_csv(
     record_filepath: Union[str, Path],
     cursor: turu.core.cursor.GenericCursor,
     *,
@@ -97,7 +97,7 @@ def _record_as_csv(
         cursor.close()
 
 
-async def _record_as_csv_async(
+async def _record_to_csv_async(
     record_filepath: Union[str, Path],
     cursor: turu.core.async_cursor.GenericAsyncCursor,
     *,
@@ -122,3 +122,40 @@ async def _record_as_csv_async(
 
     finally:
         await cursor.close()
+
+
+@overload
+def record_as_csv(
+    record_filepath: Union[str, Path],
+    cursor: turu.core.cursor.GenericCursor,
+    *,
+    enable: Union[str, bool, None] = True,
+    **options: Unpack[CsvRecorderOptions],
+) -> "_GeneratorContextManager[turu.core.cursor.GenericCursor]":
+    ...
+
+
+@overload
+def record_as_csv(
+    record_filepath: Union[str, Path],
+    cursor: turu.core.async_cursor.GenericAsyncCursor,
+    *,
+    enable: Union[str, bool, None] = True,
+    **options: Unpack[CsvRecorderOptions],
+) -> _AsyncGeneratorContextManager[turu.core.async_cursor.GenericAsyncCursor]:
+    ...
+
+
+@deprecated(
+    "This function is deprecated. Use `record_to_csv` instead.",
+)
+def record_as_csv(  # type: ignore
+    record_filepath: Union[str, Path],
+    cursor: Union[
+        turu.core.cursor.GenericCursor, turu.core.async_cursor.GenericAsyncCursor
+    ],
+    *,
+    enable: Union[str, bool, None] = True,
+    **options: Unpack[CsvRecorderOptions],
+):
+    return record_to_csv(record_filepath, cursor, enable=enable, **options)

turu-core/tests/turu/core/test_record.py

@@ -7,7 +7,7 @@
 import turu.core.mock
 from pydantic import BaseModel
 from turu.core.exception import TuruRowTypeNotSupportedError
-from turu.core.record import RecordCursor, record_as_csv
+from turu.core.record import RecordCursor, record_to_csv
 from typing_extensions import Never
 
 
@@ -17,30 +17,30 @@ class RowPydantic(BaseModel):
 
 
 class TestRecord:
-    def test_record_as_csv_execute_tuple(
+    def test_record_to_csv_execute_tuple(
         self, mock_connection: turu.core.mock.MockConnection
     ):
         expected = [(i, f"name{i}") for i in range(5)]
         mock_connection.inject_response(None, expected)
 
         with tempfile.NamedTemporaryFile() as file:
             with pytest.raises(TuruRowTypeNotSupportedError):
-                with record_as_csv(
+                with record_to_csv(
                     file.name,
                     mock_connection.execute("select 1 as ID, 'taro' as NAME"),
                 ) as cursor:
                     assert cursor.fetchall() == expected
 
             assert Path(file.name).read_text() == ""
 
-    def test_record_as_csv_execute_tuple_without_header(
+    def test_record_to_csv_execute_tuple_without_header(
         self, mock_connection: turu.core.mock.MockConnection
     ):
         expected = [(i, f"name{i}") for i in range(5)]
         mock_connection.inject_response(None, expected)
 
         with tempfile.NamedTemporaryFile() as file:
-            with record_as_csv(
+            with record_to_csv(
                 file.name,
                 mock_connection.execute("select 1, 'taro"),
                 header=False,
@@ -60,14 +60,14 @@ def test_record_as_csv_execute_tuple_without_header(
                 ).lstrip()
             )
 
-    def test_record_as_csv_execute_map(
+    def test_record_to_csv_execute_map(
         self, mock_connection: turu.core.mock.MockConnection
     ):
         expected = [RowPydantic(id=i, name=f"name{i}") for i in range(5)]
         mock_connection.inject_response(RowPydantic, expected)
 
         with tempfile.NamedTemporaryFile() as file:
-            with record_as_csv(
+            with record_to_csv(
                 file.name,
                 mock_connection.execute_map(RowPydantic, "select 1, 'name"),
             ) as cursor:
@@ -87,14 +87,14 @@ def test_record_as_csv_execute_map(
                 ).lstrip()
             )
 
-    def test_record_as_csv_execute_map_without_header_options(
+    def test_record_to_csv_execute_map_without_header_options(
         self, mock_connection: turu.core.mock.MockConnection
     ):
         expected = [RowPydantic(id=i, name=f"name{i}") for i in range(5)]
         mock_connection.inject_response(RowPydantic, expected)
 
         with tempfile.NamedTemporaryFile() as file:
-            with record_as_csv(
+            with record_to_csv(
                 file.name,
                 mock_connection.execute_map(RowPydantic, "select 1, 'name"),
                 header=False,
@@ -114,14 +114,14 @@ def test_record_as_csv_execute_map_without_header_options(
                 ).lstrip()
             )
 
-    def test_record_as_csv_execute_map_with_limit_options(
+    def test_record_to_csv_execute_map_with_limit_options(
         self, mock_connection: turu.core.mock.MockConnection
     ):
         expected = [RowPydantic(id=i, name=f"name{i}") for i in range(5)]
         mock_connection.inject_response(RowPydantic, expected)
 
         with tempfile.NamedTemporaryFile() as file:
-            with record_as_csv(
+            with record_to_csv(
                 file.name,
                 mock_connection.execute_map(RowPydantic, "select 1, 'name"),
                 limit=3,
@@ -141,7 +141,7 @@ def test_record_as_csv_execute_map_with_limit_options(
             )
 
     @pytest.mark.parametrize("enable", ["true", True])
-    def test_record_as_csv_execute_map_with_enable_options(
+    def test_record_to_csv_execute_map_with_enable_options(
         self,
         mock_connection: turu.core.mock.MockConnection,
         enable: Literal["true", True],
@@ -150,7 +150,7 @@ def test_record_as_csv_execute_map_with_enable_options(
         mock_connection.inject_response(RowPydantic, expected)
 
         with tempfile.NamedTemporaryFile() as file:
-            with record_as_csv(
+            with record_to_csv(
                 file.name,
                 mock_connection.execute_map(RowPydantic, "select 1, 'name"),
                 enable=enable,
@@ -173,7 +173,7 @@ def test_record_as_csv_execute_map_with_enable_options(
             )
 
     @pytest.mark.parametrize("enable", ["false", False, None])
-    def test_record_as_csv_execute_map_with_disable_options(
+    def test_record_to_csv_execute_map_with_disable_options(
         self,
         mock_connection: turu.core.mock.MockConnection,
         enable: Literal["false", False, None],
@@ -182,7 +182,7 @@ def test_record_as_csv_execute_map_with_disable_options(
         mock_connection.inject_response(RowPydantic, expected)
 
         with tempfile.NamedTemporaryFile() as file:
-            with record_as_csv(
+            with record_to_csv(
                 file.name,
                 mock_connection.execute_map(RowPydantic, "select 1, 'name"),
                 enable=enable,
@@ -191,7 +191,7 @@ def test_record_as_csv_execute_map_with_disable_options(
 
             assert Path(file.name).read_text() == ""
 
-    def test_record_as_csv_use_custom_method(self):
+    def test_record_to_csv_use_custom_method(self):
         class CustomCursor(turu.core.mock.MockCursor[Never, Any]):
             def custom_method(self, value: int) -> None:
                 pass
@@ -204,7 +204,7 @@ def custom_method(self, value: int) -> None:
                 pass
 
         with tempfile.NamedTemporaryFile() as file:
-            with record_as_csv(
+            with record_to_csv(
                 file.name,
                 CustomConnection().cursor(),
             ) as cursor: