From 23c6365310d60ed86e16b25196ae4e41e71e8b3b Mon Sep 17 00:00:00 2001 From: Anton Burnashev Date: Thu, 13 Jun 2024 00:16:14 +0200 Subject: [PATCH] Add a docstring to the `IncrementalTransform` class (#1459) --- dlt/extract/incremental/transform.py | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/dlt/extract/incremental/transform.py b/dlt/extract/incremental/transform.py index d117b4f1d8..2fa2bb7163 100644 --- a/dlt/extract/incremental/transform.py +++ b/dlt/extract/incremental/transform.py @@ -34,6 +34,15 @@ class IncrementalTransform: + """A base class for handling extraction and stateful tracking + of incremental data from input data items. + + By default, the descendant classes are instantiated within the + `dlt.extract.incremental.Incremental` class. + + Subclasses must implement the `__call__` method which will be called + for each data item in the extracted data. + """ def __init__( self, resource_name: str, @@ -100,6 +109,7 @@ def deduplication_disabled(self) -> bool: class JsonIncremental(IncrementalTransform): + """Extracts incremental data from JSON data items.""" def find_cursor_value(self, row: TDataItem) -> Any: """Finds value in row at cursor defined by self.cursor_path.