v1.2.4 Removed descriptors.

Author: sg495

.gitignore

@@ -127,3 +127,4 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+.vscode/settings.json

.vscode/settings.json

@@ -1,4 +1,4 @@
 {
     "esbonio.sphinx.confDir": "${workspaceFolder}\\docs",
-    "workbench.colorTheme": "Default Dark+"
+    "workbench.colorTheme": "Default Dark Modern"
 }

README.rst

@@ -38,7 +38,7 @@ Typing-validation is a small library to perform runtime validation of Python obj
 Install
 -------
 
-You can install the latest release from `PyPI <https://pypi.org/project/multiformats/>`_ as follows:
+You can install the latest release from `PyPI <https://pypi.org/project/typing-validation/>`_ as follows:
 
 .. code-block::
 

docs/api-toc.rst

@@ -3,7 +3,6 @@
     :caption: API Documentation
 
     api/typing_validation
-    api/typing_validation.descriptor
     api/typing_validation.inspector
     api/typing_validation.validation
     api/typing_validation.validation_failure

docs/api/typing_validation.descriptor.rst

@@ -8,11 +8,12 @@ typing_validation.__all__
 
 The following members were explicitly reexported using ``__all__``:
 
-    - :py:class:`typing_validation.descriptor.Descriptor`
     - :py:class:`typing_validation.inspector.TypeInspector`
     - :py:class:`typing_validation.inspector.UnsupportedType`
     - :py:func:`typing_validation.validation.can_validate`
     - :py:func:`typing_validation.validation_failure.get_validation_failure`
     - :py:func:`typing_validation.validation_failure.latest_validation_failure`
     - :py:func:`typing_validation.validation.validate`
+    - :py:func:`typing_validation.validation.validated`
+    - :py:func:`typing_validation.validation.validated_iter`
     - :py:func:`typing_validation.validation.validation_aliases`

docs/api/typing_validation.rst

@@ -33,9 +33,9 @@
 # built documents.
 #
 # The full version, including alpha/beta/rc tags.
-release = "1.1.0"
+release = "1.2.4"
 # The short X.Y version.
-version = "1.1.0"
+version = "1.2.4"
 
 
 # -- General configuration ---------------------------------------------------

docs/conf.py

@@ -106,38 +106,4 @@ False
 >>> import sys
 >>> sys.tracebacklimit = 0
 
-Descriptors
------------
-
-The class :class:`~typing_validation.descriptor.Descriptor` can be used to create descriptors with the following features:
-
-- static type checking for the descriptor value;
-- runtime type checking;
-- optional runtime validation;
-- the ability to make the descriptor read-only.
-
-The valida
-
-.. code-block:: python
-
-    from collections.abc import Sequence
-    from typing_validation import Descriptor
-
-    class MyClass:
-
-        x = Descriptor(int, lambda _, x: x >= 0, readonly=True)
-        y = Descriptor(Sequence[int], lambda self, y: len(y) <= self.x)
-
-        def __init__(self, x: int, y: Sequence[int]):
-            self.x = x
-            self.y = y
-
-    myobj = MyClass(3, [0, 2, 5]) # OK
-    myobj.y = (0, 1)              # OK
-    myobj.y = [0, 2, 4, 6]        # ValueError (lenght of y is not <= 3)
-    myobj.x = 5                   # AttributeError (readonly descriptor)
-    myobj.y = 5                   # TypeError (type of y is not 'Sequence')
-    myobj.y = ["hi", "bye"]       # TypeError (type of y is not 'Sequence[int]')
-
-
 GitHub repo: https://github.com/hashberg-io/typing-validation

docs/getting-started.rst

@@ -2,16 +2,15 @@
     Runtime validation using type hints.
 """
 
-__version__ = "1.1.0"
+__version__ = "1.2.4"
 
 from .inspector import TypeInspector, UnsupportedType
 from .validation import validate, can_validate, validation_aliases, validated, validated_iter
 from .validation_failure import get_validation_failure, latest_validation_failure
-from .descriptor import Descriptor
 
 # re-export all encodings and functions.
 __all__ = [
     "validate", "can_validate", "validation_aliases", "validated", "validated_iter",
     "TypeInspector", "UnsupportedType",
-    "get_validation_failure", "latest_validation_failure", "Descriptor"
+    "get_validation_failure", "latest_validation_failure",
 ]