splurge-dsv 2025.2.0__py3-none-any.whl → 2025.2.1__py3-none-any.whl

splurge_dsv/__init__.py

@@ -60,7 +60,7 @@ from splurge_dsv.path_validator import PathValidator
 from splurge_dsv.string_tokenizer import StringTokenizer
 from splurge_dsv.text_file_helper import TextFileHelper
 
-__version__ = "2025.2.0"
+__version__ = "2025.2.1"
 __author__ = "Jim Schilling"
 __license__ = "MIT"
 

splurge_dsv/cli.py

@@ -161,7 +161,7 @@ def run_cli() -> int:
             chunk_count = 0
             total_rows = 0
 
-            for chunk in dsv.parse_stream(file_path):
+            for chunk in dsv.parse_file_stream(file_path):
                 chunk_count += 1
                 total_rows += len(chunk)
                 if args.output_format == "json":

splurge_dsv/dsv.py

@@ -17,6 +17,7 @@ Copyright (c) 2025 Jim Schilling
 """
 
 # Standard library imports
+import warnings
 from collections.abc import Iterator
 from dataclasses import dataclass, fields
 from os import PathLike
@@ -230,7 +231,7 @@ class Dsv:
             skip_footer_rows=self.config.skip_footer_rows,
         )
 
-    def parse_stream(self, file_path: PathLike[str] | str) -> Iterator[list[list[str]]]:
+    def parse_file_stream(self, file_path: PathLike[str] | str) -> Iterator[list[list[str]]]:
         """Stream-parse a DSV file, yielding chunks of parsed rows.
 
         The method yields lists of parsed rows (each row itself is a list of
@@ -243,7 +244,7 @@ class Dsv:
         Yields:
             Lists of parsed rows, each list containing up to ``chunk_size`` rows.
         """
-        return DsvHelper.parse_stream(
+        return DsvHelper.parse_file_stream(
             file_path,
             delimiter=self.config.delimiter,
             strip=self.config.strip,
@@ -254,3 +255,26 @@ class Dsv:
             skip_footer_rows=self.config.skip_footer_rows,
             chunk_size=self.config.chunk_size,
         )
+
+    def parse_stream(self, file_path: PathLike[str] | str) -> Iterator[list[list[str]]]:
+        """Stream-parse a DSV file, yielding chunks of parsed rows.
+
+        The method yields lists of parsed rows (each row itself is a list of
+        strings). Chunk sizing is controlled by the bound configuration's
+        ``chunk_size`` value.
+
+        Args:
+            file_path: Path to the file to parse.
+
+        Yields:
+            Lists of parsed rows, each list containing up to ``chunk_size`` rows.
+
+        Deprecated: Use `parse_file_stream` instead. This method will be removed in a future release.
+        """
+        # Emit a DeprecationWarning to signal removal in a future release
+        warnings.warn(
+            "Dsv.parse_stream() is deprecated and will be removed in a future release; use Dsv.parse_file_stream() instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return Dsv.parse_file_stream(self, file_path)

splurge_dsv/dsv_helper.py

@@ -9,6 +9,7 @@ This module is licensed under the MIT License.
 """
 
 # Standard library imports
+import warnings
 from collections.abc import Iterator
 from os import PathLike
 
@@ -199,7 +200,7 @@ class DsvHelper:
         return cls.parses(chunk, delimiter=delimiter, strip=strip, bookend=bookend, bookend_strip=bookend_strip)
 
     @classmethod
-    def parse_stream(
+    def parse_file_stream(
         cls,
         file_path: PathLike[str] | str,
         *,
@@ -213,7 +214,7 @@ class DsvHelper:
         chunk_size: int = DEFAULT_CHUNK_SIZE,
     ) -> Iterator[list[list[str]]]:
         """
-        Stream-parse a DSV file in chunks of lines.
+        Stream-parse a DSV file into chunks of lines.
 
         Args:
             file_path (PathLike[str] | str): The path to the file to parse.
@@ -255,3 +256,51 @@ class DsvHelper:
                 chunk_size=chunk_size,
             )
         )
+
+    @classmethod
+    def parse_stream(
+        cls,
+        file_path: PathLike[str] | str,
+        *,
+        delimiter: str,
+        strip: bool = DEFAULT_STRIP,
+        bookend: str | None = None,
+        bookend_strip: bool = DEFAULT_BOOKEND_STRIP,
+        encoding: str = DEFAULT_ENCODING,
+        skip_header_rows: int = DEFAULT_SKIP_HEADER_ROWS,
+        skip_footer_rows: int = DEFAULT_SKIP_FOOTER_ROWS,
+        chunk_size: int = DEFAULT_CHUNK_SIZE,
+    ) -> Iterator[list[list[str]]]:
+        """
+        Stream-parse a DSV file, yielding chunks of parsed rows.
+
+        The method yields lists of parsed rows (each row itself is a list of
+        strings). Chunk sizing is controlled by the bound configuration's
+        ``chunk_size`` value.
+
+        Args:
+            file_path: Path to the file to parse.
+
+        Yields:
+            Lists of parsed rows, each list containing up to ``chunk_size`` rows.
+
+        Deprecated: Use `parse_file_stream` instead. This method will be removed in a future release.
+        """
+        # Emit a DeprecationWarning to signal removal in a future release
+        warnings.warn(
+            "DsvHelper.parse_stream() is deprecated and will be removed in a future release; use DsvHelper.parse_file_stream() instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
+        return cls.parse_file_stream(
+            file_path,
+            delimiter=delimiter,
+            strip=strip,
+            bookend=bookend,
+            bookend_strip=bookend_strip,
+            encoding=encoding,
+            skip_header_rows=skip_header_rows,
+            skip_footer_rows=skip_footer_rows,
+            chunk_size=chunk_size,
+        )

{splurge_dsv-2025.2.0.dist-info → splurge_dsv-2025.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splurge-dsv
-Version: 2025.2.0
+Version: 2025.2.1
 Summary: A utility library for working with DSV (Delimited String Values) files
 Author: Jim Schilling
 License-Expression: MIT

{splurge_dsv-2025.2.0.dist-info → splurge_dsv-2025.2.1.dist-info}/RECORD

@@ -1,17 +1,17 @@
-splurge_dsv/__init__.py,sha256=cLZbXey-8aogRkpE2easqfaaJdkHCqv3M_KZlrDo3WU,3337
+splurge_dsv/__init__.py,sha256=5TfARRtn0dMytGL4TnlEOWBon3HJiwN8MKEdHMItPZI,3337
 splurge_dsv/__main__.py,sha256=6dpfX_96hEpOqxv5X4bK73xX86YTgK0Adad1uTWSABM,426
-splurge_dsv/cli.py,sha256=xdPL7dSdWGDUsG2-FbsIgRnbYuQRN-grLlx8iJ-HxZc,7600
-splurge_dsv/dsv.py,sha256=6P0Ujma_8xED-HsTywLaTQYD_Wxo7J8xU25RdE-5I38,8859
-splurge_dsv/dsv_helper.py,sha256=lAEquK2WDOB3yS1ynxmOcg_pn9Q3njHJgFs_wyCOi_k,10293
+splurge_dsv/cli.py,sha256=qm7ZwgkUjMW5ASj14kWFyXrXY2T-MGhiCFHh8XUHi38,7605
+splurge_dsv/dsv.py,sha256=5wDtHDk8Iio2SAIPO7Ce01dGhzH3fv12by8hQcPkJVI,9873
+splurge_dsv/dsv_helper.py,sha256=ppFVZ4LNSepWbVJtYMQvsZGmMBDr6nbP4yKZettWczk,12060
 splurge_dsv/exceptions.py,sha256=hefUTjk3ULca5TdXoKe5L-cME7SU1RFcWVHxNpZ_w-Y,5274
 splurge_dsv/path_validator.py,sha256=r08PkuMdL0eBY_iao00_irBMdT6ORJ2-cNK5AUssEKs,10681
 splurge_dsv/safe_text_file_reader.py,sha256=9GCOGCTDDP5FJD0u2wZ107SQNEIj9Rm1zN6shYiKq7g,6659
 splurge_dsv/safe_text_file_writer.py,sha256=zQIsDZ6jRN_ZWwLX4dpUZI35iudxzuv1Gjv7K1vSFJk,4562
 splurge_dsv/string_tokenizer.py,sha256=jFgkqeGx5PnmKAvu7sn3xxHcQklZTZUy8x_eo5e6TWI,4497
 splurge_dsv/text_file_helper.py,sha256=2SxbYtZtpMtHQ-5g1aQzgvQobBrlQH4EsrhBY5t3Xx4,10362
-splurge_dsv-2025.2.0.dist-info/licenses/LICENSE,sha256=fPgtg-tIFHinQvJH0arRfv50AuxikD5eHw6rrPy2A5w,1091
-splurge_dsv-2025.2.0.dist-info/METADATA,sha256=n8wCT3oOj_-60a4Et6AvbQ708tdM-pi3DL0lSlBsYuo,8518
-splurge_dsv-2025.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-splurge_dsv-2025.2.0.dist-info/entry_points.txt,sha256=QmGyc3qHYtY61uanRxNOXw-waSJ01qypSCI8Kb3zgsU,56
-splurge_dsv-2025.2.0.dist-info/top_level.txt,sha256=D6Si3FTfpRYqH7kzM7tSQAyaKbbraO6UPLpcqcY4XXM,12
-splurge_dsv-2025.2.0.dist-info/RECORD,,
+splurge_dsv-2025.2.1.dist-info/licenses/LICENSE,sha256=fPgtg-tIFHinQvJH0arRfv50AuxikD5eHw6rrPy2A5w,1091
+splurge_dsv-2025.2.1.dist-info/METADATA,sha256=V1gWLbEKupAzTYWWvgx1UviuOtkjEhAYuPQ6pwOsDYM,8518
+splurge_dsv-2025.2.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+splurge_dsv-2025.2.1.dist-info/entry_points.txt,sha256=QmGyc3qHYtY61uanRxNOXw-waSJ01qypSCI8Kb3zgsU,56
+splurge_dsv-2025.2.1.dist-info/top_level.txt,sha256=D6Si3FTfpRYqH7kzM7tSQAyaKbbraO6UPLpcqcY4XXM,12
+splurge_dsv-2025.2.1.dist-info/RECORD,,