Update for releasing 1.1.0 (#140)

* Update for releasing 1.1.0

Author: dhirupandey

.pre-commit-config.yaml

@@ -21,12 +21,12 @@ repos:
         - id: flake8
 
 -   repo: https://github.com/psf/black
-    rev: 24.4.0
+    rev: 24.4.2
     hooks:
         - id: black
 
 -   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.9.0
+    rev: v1.10.0
     hooks:
         - id: mypy
 

docs/api_reference.rst

@@ -1,5 +1,5 @@
 ..
-   Copyright (c) 2022, 2023, Oracle and/or its affiliates.
+   Copyright (c) 2022, 2024, Oracle and/or its affiliates.
    Licensed under the Universal Permissive License v 1.0 as shown at
    https://oss.oracle.com/licenses/upl.
 
@@ -11,6 +11,16 @@ Aggregators
 .. autoclass:: coherence.Aggregators
     :members:
 
+Comparator
+----------
+.. autoclass:: coherence.Comparator
+    :members:
+
+Extractors
+----------
+.. autoclass:: coherence.Extractors
+    :members:
+
 Filters
 -------
 .. autoclass:: coherence.Filters
@@ -83,8 +93,9 @@ Modules
    :maxdepth: 3
    :titlesonly:
 
-   api_reference/processor.rst
-   api_reference/filter.rst
+   api_reference/aggregator.rst
+   api_reference/comparator.rst
    api_reference/event.rst
    api_reference/extractor.rst
-   api_reference/aggregator.rst
+   api_reference/filter.rst
+   api_reference/processor.rst

docs/api_reference/comparator.rst

@@ -0,0 +1,25 @@
+..
+   Copyright (c) 2024, Oracle and/or its affiliates.
+   Licensed under the Universal Permissive License v 1.0 as shown at
+   https://oss.oracle.com/licenses/upl.
+
+====================
+coherence.comparator
+====================
+.. toctree::
+   :maxdepth: 4
+
+ExtractorComparator
+-------------------
+.. autoclass:: coherence.comparator.ExtractorComparator
+    :show-inheritance:
+
+InverseComparator
+-----------------
+.. autoclass:: coherence.comparator.InverseComparator
+    :show-inheritance:
+
+SafeComparator
+--------------
+.. autoclass:: coherence.comparator.SafeComparator
+    :show-inheritance:

docs/conf.py

@@ -1,5 +1,5 @@
 # ----------------------------------------------------------------------------------------------------------------------
-# Copyright (c) 2022, Oracle and/or its affiliates.
+# Copyright (c) 2022, 2024, Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at
 # https://oss.oracle.com/licenses/upl.
 #
@@ -23,7 +23,7 @@
 sys.path.insert(0, os.path.abspath("../src"))
 
 # The full version, including alpha/beta/rc tags
-release = "1.0.3"
+release = "1.1.0"
 
 # -- Project information -----------------------------------------------------
 

pyproject.toml

@@ -3,7 +3,7 @@
 # https://oss.oracle.com/licenses/upl.
 [tool.poetry]
 name = "coherence-client"
-version = "1.0.3"
+version = "1.1.0"
 description = """The Coherence Python Client allows Python applications to act as cache clients to a \
 Coherence Cluster using Google's gRPC framework as the network transport."""
 packages = [

setup.py

@@ -1,12 +1,12 @@
-# Copyright (c) 2022, 2023, Oracle and/or its affiliates.
+# Copyright (c) 2022, 2024, Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at
 # https://oss.oracle.com/licenses/upl.
 
 from distutils.core import setup
 
 setup(
     name="coherence-client",
-    version="1.0.3",
+    version="1.1.0",
     packages=["coherence"],
     url="https://github.com/oracle/coherence-py-client",
     license="UPL",

src/coherence/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2022 Oracle and/or its affiliates.
+# Copyright (c) 2022, 2024, Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at
 # https://oss.oracle.com/licenses/upl.
 
@@ -16,6 +16,7 @@
 from .client import Options as Options
 from .client import Session as Session
 from .client import TlsOptions as TlsOptions
+from .comparator import Comparator as Comparator
 from .extractor import Extractors as Extractors
 from .filter import Filters as Filters
 from .processor import Processors as Processors

src/coherence/client.py

@@ -465,12 +465,12 @@ def add_index(
         """
         Add an index to this map.
 
-        :param extractor: The :class: `coherence.extractor.ValueExtractor` object that is used to extract
+        :param extractor: The :class:`coherence.extractor.ValueExtractor` object that is used to extract
                    an indexable Object from a value stored in the
                    indexed Map. Must not be 'None'.
         :param ordered: true if the contents of the indexed information
                    should be ordered false otherwise.
-        :param comparator: The :class: `coherence.comparator.Comparator` object which imposes an ordering
+        :param comparator: The :class:`coherence.comparator.Comparator` object which imposes an ordering
                    on entries in the indexed map or None if the
                    entries' values natural ordering should be used.
         """
@@ -480,7 +480,7 @@ def remove_index(self, extractor: ValueExtractor[T, E]) -> None:
         """
         Removes an index on this `NamedMap`.
 
-        :param extractor: The :class: `coherence.extractor.ValueExtractor` object that is used to extract
+        :param extractor: The :class:`coherence.extractor.ValueExtractor` object that is used to extract
                   an indexable Object from a value stored in the
                   indexed Map. Must not be 'None'.
 

src/coherence/comparator.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2022, 2023, Oracle and/or its affiliates.
+# Copyright (c) 2022, 2024, Oracle and/or its affiliates.
 # Licensed under the Universal Permissive License v 1.0 as shown at
 # https://oss.oracle.com/licenses/upl.
 
@@ -12,26 +12,35 @@
 
 
 class Comparator(ABC):
+    """Comparator is used to control the ordering for collections of objects"""
+
     def __init__(self) -> None:
         super().__init__()
 
 
 @proxy("comparator.SafeComparator")
 class SafeComparator(Comparator):
+    """None-safe delegating comparator. None values are evaluated as "less then" any non None value."""
+
     def __init__(self, property_name: str) -> None:
         super().__init__()
         self.comparator = ExtractorComparator(property_name)
 
 
 @proxy("comparator.InverseComparator")
 class InverseComparator(Comparator):
+    """Comparator that reverses the result of another comparator."""
+
     def __init__(self, property_name: str) -> None:
         super().__init__()
         self.comparator = ExtractorComparator(property_name)
 
 
 @proxy("comparator.ExtractorComparator")
 class ExtractorComparator(Comparator):
+    """Comparator implementation that uses specified :class:`coherence.extractor.ValueExtractor` to
+    extract value(s) to be used for comparison."""
+
     def __init__(self, property_name: str) -> None:
         super().__init__()
         self.extractor = UniversalExtractor[Any](property_name)