splurge-dsv 2025.2.0__tar.gz → 2025.2.1__tar.gz

{splurge_dsv-2025.2.0/splurge_dsv.egg-info → splurge_dsv-2025.2.1}/PKG-INFO

@@ -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 → splurge_dsv-2025.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "splurge-dsv"
-version = "2025.2.0"
+version = "2025.2.1"
 description = "A utility library for working with DSV (Delimited String Values) files"
 readme = "README.md"
 requires-python = ">=3.10"

{splurge_dsv-2025.2.0 → splurge_dsv-2025.2.1}/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-2025.2.0 → splurge_dsv-2025.2.1}/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-2025.2.0 → splurge_dsv-2025.2.1}/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-2025.2.0 → splurge_dsv-2025.2.1}/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 → splurge_dsv-2025.2.1/splurge_dsv.egg-info}/PKG-INFO

@@ -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