MobileTeleSystems · dolfinus · Feb 15, 2024 · Feb 15, 2024
diff --git a/README.rst b/README.rst
@@ -27,13 +27,17 @@ What is ETL Entities?
 Collection of classes & decorators used for handling High Water Mark (HWM).
 
 Currently implemented:
+
+* HWM classes:
     * ``ColumnIntHWM``
     * ``ColumnDateHWM``
     * ``ColumnDateTimeHWM``
     * ``FileListHWM``
     * ``KeyValueIntHWM``
+
+* HWM Store classes:
+    * ``BaseHWMStore`` (base interface)
     * ``MemoryHWMStore``
-    * ``BaseHWMStore`` (interface for third-party HWM store implementations)
 
 .. installation
 

diff --git a/docs/changelog/next_release/79.breaking.rst b/docs/changelog/next_release/79.breaking.rst
@@ -0,0 +1 @@
+Rename ``HWMStoreClassRegistry.known_types`` to ``aliases``
diff --git a/docs/conf.py b/docs/conf.py
@@ -52,9 +52,7 @@
     "sphinx_toolbox.github",
     "sphinxcontrib.towncrier",  # provides `towncrier-draft-entries` directive
 ]
-numpydoc_show_class_members = True
-autosummary_generate_overwrite = False
-autosummary_generate = False
+numpydoc_show_class_members = False
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

diff --git a/docs/hwm/column/date_hwm.rst b/docs/hwm/column/date_hwm.rst
@@ -5,4 +5,4 @@ Column Date HWM
 
 .. autoclass:: ColumnDateHWM
     :members: name, set_value, dict, json, copy, deserialize
-    :special-members: __bool__, __add__, __sub__, __eq__, __lt__
+    :special-members: __add__, __sub__, __eq__, __lt__
diff --git a/docs/hwm/column/datetime_hwm.rst b/docs/hwm/column/datetime_hwm.rst
@@ -5,4 +5,4 @@ Column Datetime HWM
 
 .. autoclass:: ColumnDateTimeHWM
     :members: name, set_value, dict, json, copy, deserialize
-    :special-members: __bool__, __add__, __sub__, __eq__, __lt__
+    :special-members: __add__, __sub__, __eq__, __lt__
diff --git a/docs/hwm/column/index.rst b/docs/hwm/column/index.rst
@@ -6,7 +6,6 @@ Column HWM
 .. toctree::
     :maxdepth: 2
     :caption: HWM classes
-    :name: column_hwm_classes
 
     int_hwm
     date_hwm

diff --git a/docs/hwm/column/int_hwm.rst b/docs/hwm/column/int_hwm.rst
@@ -5,4 +5,4 @@ Column Integer HWM
 
 .. autoclass:: ColumnIntHWM
     :members: name, set_value, dict, json, copy, deserialize
-    :special-members: __bool__, __add__, __sub__, __eq__, __lt__
+    :special-members: __add__, __sub__, __eq__, __lt__
diff --git a/docs/hwm/file/file_list_hwm.rst b/docs/hwm/file/file_list_hwm.rst
@@ -5,4 +5,4 @@ File List HWM
 
 .. autoclass:: FileListHWM
     :members: name, set_value, dict, json, copy, covers, update
-    :special-members:  __add__, __sub__, __in__
+    :special-members:  __add__, __sub__
diff --git a/docs/hwm/file/index.rst b/docs/hwm/file/index.rst
@@ -6,7 +6,6 @@ File HWM
 .. toctree::
     :maxdepth: 2
     :caption: HWM classes
-    :name: file_hwm_classes
 
     file_list_hwm
 

diff --git a/docs/hwm/hwm_type_registry.rst b/docs/hwm/hwm_type_registry.rst
@@ -1,10 +1,8 @@
 HWM Type Registry
-=================================================================
-.. currentmodule:: etl_entities.hwm.hwm_type_registry
-
+=================
 
+.. currentmodule:: etl_entities.hwm.hwm_type_registry
 .. autoclass:: HWMTypeRegistry
     :members: get, get_key, add, parse
 
-
 .. automethod:: register_hwm_type
diff --git a/docs/hwm/index.rst b/docs/hwm/index.rst
diff --git a/docs/hwm/key_value/index.rst b/docs/hwm/key_value/index.rst
@@ -6,7 +6,6 @@ KeyValue HWM
 .. toctree::
     :maxdepth: 2
     :caption: HWM classes
-    :name: key_value_hwm_classes
 
     key_value_int_hwm
 

diff --git a/docs/hwm_store/base_hwm_store.rst b/docs/hwm_store/base_hwm_store.rst
@@ -1,7 +1,7 @@
 .. _base-hwm-store:
 
 Base HWM Store
-=================================================================
+==============
 
 .. currentmodule:: etl_entities.hwm_store.base_hwm_store
 

diff --git a/docs/hwm_store/detect_hwm_store.rst b/docs/hwm_store/detect_hwm_store.rst
@@ -1,7 +1,7 @@
 .. _detect-hwm-store:
 
 Detect HWM Store decorator
-=================================================================
+==========================
 
 .. currentmodule:: etl_entities.hwm_store.hwm_store_detect
 

diff --git a/docs/hwm_store/hwm_store_stack_manager.rst b/docs/hwm_store/hwm_store_stack_manager.rst
@@ -0,0 +1,9 @@
+.. _hwm-store-stack-manager:
+
+HWM Store stack manager
+=======================
+
+.. currentmodule:: etl_entities.hwm_store.hwm_store_stack_manager
+
+.. autoclass:: HWMStoreStackManager
+    :members: get_current
diff --git a/docs/hwm_store/index.rst b/docs/hwm_store/index.rst
@@ -1,24 +1,15 @@
 .. _hwm-store:
 
-HWM Store
-=========
+What is HWM Store
+=================
 
-.. toctree::
-    :maxdepth: 2
-    :caption: HWM store
+HWM objects are stored in HWM stores.
 
-    memory_hwm_store
-    detect_hwm_store
-
-.. toctree::
-    :maxdepth: 2
-    :caption: For developers
-
-    base_hwm_store
-    register_hwm_store_class
-
-:ref:`hwm` values are persisted in HWM stores.
+Known implementations:
+    * :obj:`MemoryHWMStore <etl_entities.hwm_store.memory_hwm_store.MemoryHWMStore>` (RAM)
+    * `YAMLHWMStore <https://onetl.readthedocs.io/en/stable/hwm_store/yaml_hwm_store.html>`_ (local file)
+    * `HorizonHWMStore <https://horizon-hwm-store.readthedocs.io/en/latest/horizon-hwm-store.html>`_ (external API)
 
 It is also possible to register your own HWN Store using :ref:`register-hwm-store-class`.
 
-You can select store based on config values using :ref:`detect-hwm-store`.
+You can select store based on dict config using :ref:`detect-hwm-store`.
diff --git a/docs/hwm_store/memory_hwm_store.rst b/docs/hwm_store/memory_hwm_store.rst
@@ -1,7 +1,7 @@
 .. _memory-hwm-store:
 
-In-memory HWM Store (ephemeral)
-=================================================================
+MemoryHWMStore
+==============
 
 .. currentmodule:: etl_entities.hwm_store.memory_hwm_store
 

diff --git a/docs/hwm_store/register_hwm_store_class.rst b/docs/hwm_store/register_hwm_store_class.rst
@@ -1,8 +1,12 @@
 .. _register-hwm-store-class:
 
-Register own HWM Store decorator
-=================================================================
+Register own HWM Store class
+============================
 
 .. currentmodule:: etl_entities.hwm_store.hwm_store_class_registry
-
 .. autodecorator:: register_hwm_store_class
+
+.. currentmodule:: etl_entities.hwm_store.hwm_store_class_registry
+
+.. autoclass:: HWMStoreClassRegistry
+    :members: get, add, set_default, aliases
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,7 +3,6 @@
 
 .. toctree::
     :maxdepth: 2
-    :caption: HWM lib
     :name: etl_entities
     :hidden:
 
@@ -14,14 +13,23 @@
     :caption: HWM
     :hidden:
 
-    hwm/index
+    hwm/column/index
+    hwm/file/index
+    hwm/key_value/index
+    hwm/hwm_type_registry
 
 .. toctree::
     :maxdepth: 2
-    :caption: HWM store
+    :caption: HWM Store
     :hidden:
 
     hwm_store/index
+    hwm_store/memory_hwm_store
+    hwm_store/base_hwm_store
+    hwm_store/register_hwm_store_class
+    hwm_store/hwm_store_stack_manager
+    hwm_store/detect_hwm_store
+
 
 .. toctree::
     :maxdepth: 2

diff --git a/docs/old_hwm/file_list_hwm.rst b/docs/old_hwm/file_list_hwm.rst
@@ -4,4 +4,4 @@ File List HWM
 
 .. autoclass:: FileListHWM
     :members: name, qualified_name, set_value, dict, json, copy, serialize, deserialize, covers, update
-    :special-members: __bool__, __len__, __abs__, __add__, __sub__, __in__, __iter__
+    :special-members: __bool__, __len__, __abs__, __add__, __sub__, __contains__, __iter__
diff --git a/docs/old_hwm/index.rst b/docs/old_hwm/index.rst
@@ -6,7 +6,6 @@ Old HWM classes
 .. toctree::
     :maxdepth: 2
     :caption: HWM classes
-    :name: hwm_classes
 
     int_hwm
     date_hwm

diff --git a/docs/plugins.rst b/docs/plugins.rst
@@ -76,7 +76,7 @@ How plugins are imported?
     from some_plugin.module.internals import my_function
 
 If specific module/class/function uses some registration capabilities of etl_entities,
-like :ref:`hook-decorator`, it will be executed during this import.
+it will be executed during this import.
 
 How to enable/disable plugins?
 ------------------------------

diff --git a/docs/process/index.rst b/docs/process/index.rst
@@ -6,7 +6,6 @@ Process classes
 .. toctree::
     :maxdepth: 2
     :caption: Process classes
-    :name: process_classes
 
     process
     process_stack_manager
diff --git a/docs/source/db/index.rst b/docs/source/db/index.rst
@@ -6,7 +6,6 @@ DB source classes
 .. toctree::
     :maxdepth: 2
     :caption: DB Source classes
-    :name: db_source_classes
 
     column
     table
diff --git a/docs/source/file/index.rst b/docs/source/file/index.rst
@@ -6,6 +6,5 @@ File source classes
 .. toctree::
     :maxdepth: 2
     :caption: File source classes
-    :name: file_source_classes
 
     remote_folder
diff --git a/docs/source/file/remote_folder.rst b/docs/source/file/remote_folder.rst
@@ -5,4 +5,4 @@ RemoteFolder
 
 .. autoclass:: RemoteFolder
     :members: name, qualified_name, copy, dict, json
-    :special-members: __str__, __abs__, __truediv__
+    :special-members: __str__, __truediv__
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,7 +6,6 @@ Source classes
 .. toctree::
     :maxdepth: 2
     :caption: Source classes
-    :name: source_classes
 
     db/index
     file/index
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Rename ``HWMStoreClassRegistry.known_types`` to ``aliases``