enumerific 0.0.0__py3-none-any.whl → 1.0.1__py3-none-any.whl

enumerific/logging.py

@@ -0,0 +1,5 @@
+import logging
+
+logger = logging.getLogger(__name__)
+
+logging.basicConfig(level=logging.WARNING)

enumerific/standard.py

@@ -0,0 +1,85 @@
+from __future__ import annotations
+
+from enum import Enum
+
+from enumerific.logging import logger
+
+from enumerific.exceptions import EnumValueError
+
+
+logger = logger.getChild(__name__)
+
+
+class Enum(Enum):
+    """An extended Enum class that provides support for validating an Enum value and
+    accepting either enumeration class properties as enumeration values or their string
+    names or values, and providing straightforward access to the enumeration values an
+    Enum class holds."""
+
+    @classmethod
+    def validate(cls, value: Enum | str | int | object) -> bool:
+        """Determine if an enum value name or enum value is valid or not"""
+
+        try:
+            return cls.reconcile(value=value, default=None) is not None
+        except EnumValueError as exception:
+            return False
+
+    @classmethod
+    def reconcile(
+        cls,
+        value: Enum | str | int | object,
+        default: Enum = None,
+        raises: bool = False,
+    ) -> Enum | None:
+        """Reconcile enum values and enum names to their corresponding enum option, as
+        well as allowing valid enum options to be returned unmodified; if the provided
+        enum option, enum value or enum name cannot be reconciled and if a default value
+        has been provided, the default value will be returned instead and a warning
+        message will be logged, otherwise an EnumValueError exception will be raised."""
+
+        if isinstance(value, str):
+            for prop, enumeration in cls.__members__.items():
+                if enumeration.name.casefold() == value.casefold():
+                    return enumeration
+                elif (
+                    isinstance(enumeration.value, str)
+                    and enumeration.value.casefold() == value.casefold()
+                ):
+                    return enumeration
+        elif isinstance(value, int) and not isinstance(value, bool):
+            for prop, enumeration in cls.__members__.items():
+                if isinstance(enumeration.value, int) and enumeration.value == value:
+                    return enumeration
+        elif isinstance(value, bool):
+            for prop, enumeration in cls.__members__.items():
+                if enumeration.value is value:
+                    return enumeration
+        elif isinstance(value, cls):
+            if value in cls:
+                return value
+        elif not value is None:
+            for prop, enumeration in cls.__members__.items():
+                if enumeration.value == value:
+                    return enumeration
+
+        if value is not None:
+            if raises is True:
+                raise EnumValueError(
+                    "The provided value, %r, is invalid and does not correspond with this enumeration's options!"
+                    % (value)
+                )
+            else:
+                logger.debug(
+                    "The provided value, %r, is invalid, but a default, %r, has been provided, and will be returned instead!",
+                    value,
+                    default,
+                )
+
+        return default
+
+    @classmethod
+    def options(cls) -> list[Enum]:
+        """Provide straightforward access to the list of enumeration options"""
+
+        return cls.__members__.values()

enumerific/version.txt

@@ -0,0 +1 @@
+1.0.1

enumerific-1.0.1.dist-info/METADATA

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: enumerific
+Version: 1.0.1
+Summary: Simplifies working with Python enums.
+Author: Daniel Sissman
+License-Expression: MIT
+Project-URL: documentation, https://github.com/bluebinary/enumerific/blob/main/README.md
+Project-URL: changelog, https://github.com/bluebinary/enumerific/blob/main/CHANGELOG.md
+Project-URL: repository, https://github.com/bluebinary/enumerific
+Project-URL: issues, https://github.com/bluebinary/enumerific/issues
+Project-URL: homepage, https://github.com/bluebinary/enumerific
+Keywords: enum,enumeration,enumerations
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Provides-Extra: development
+Requires-Dist: black==24.10.*; extra == "development"
+Requires-Dist: pytest==8.3.*; extra == "development"
+Requires-Dist: pytest-codeblocks==0.17.0; extra == "development"
+Provides-Extra: distribution
+Requires-Dist: build; extra == "distribution"
+Requires-Dist: twine; extra == "distribution"
+Requires-Dist: wheel; extra == "distribution"
+Dynamic: license-file
+
+# Enumerific Enums
+
+The `enumerific` library provides several useful extensions to the Python built-in `enums` library.
+
+### Requirements
+
+The Enumerific library has been tested with Python 3.10, 3.11, 3.12 and 3.13, and is not
+compatible with Python 3.9 or earlier.
+
+### Installation
+
+Enumerific is available from the PyPI, so may be added to a project's dependencies via
+its `requirements.txt` file or similar by referencing the library's name, `enumerific`,
+or the library may be installed directly into your local runtime environment using `pip`
+by entering the following command, and following any prompts:
+
+	$ pip install enumerific
+
+### Usage
+
+To use the Enumerific library, simply import the library and use it like you would the built-in `enum` library as a drop-in replacement:
+
+```python
+from enumerific import Enum
+
+class MyEnum(Enum):
+  Option1 = "ABC"
+  Option2 = "DEF"
+
+val = MyEnum.Option1
+```
+
+Alternatively, to make use of the extra functionality for the standard library's `Enum`
+class, import the `Enum` class from the Enumerific library:
+
+```python
+from enumerific import Enum
+
+class MyEnum(Enum):
+  Option1 = "ABC"
+  Option2 = "DEF"
+
+val = MyEnum.Option1
+```
+
+You can also import the `Enum` class directly from the `enumerific` library and use it directly:
+
+```python
+from enumerific import Enum
+
+class MyEnum(Enum):
+  Option1 = "ABC"
+```
+
+The Enumerific library's own `Enum` class is a subclass of the built-in `enum.Enum` class, so all of the built-in functionality of `enum.Enum` is available, as well as several additional class methods:
+
+* `reconcile(value: object, default: Enum = None, raises: bool = False) -> Enum` – The `reconcile` method allows for an enumeration's value or an enumeration option's name to be reconciled against a matching enumeration option. If the provided value can be matched against one of the enumeration's available options, that option will be returned, otherwise there are two possible behaviours: if the `raises` keyword argument has been set to or left as `False` (its default), the value assigned to the `default` keyword argument will be returned, which may be `None` if no default value has been specified; if the `raises` argument has been set to `True` an `EnumValueError` exception will be raised as an alert that the provided value could not be matched. One can also provide an enumeration option as the input value to the `reconcile` method, and these will be validated and returned as-is.
+* `validate(value: object) -> bool` – The `validate` method takes the same range of input values as the `reconcile` method, and returns `True` when the provided value can be reconciled against an enumeration option, or `False` otherwise.
+* `options() -> list[Enum]` – The `options` method provides easy access to the list of the enumeration's available options.
+
+The benefits of being able to validate and reconcile various input values against an enumeration, include allowing for a controlled vocabulary of options to be checked against, and the ability to convert enumeration values into their corresponding enumeration option. This can be especially useful when working with input data where you need to convert those values to their corresponding enumeration options, and to be able to do so without maintaining boilerplate code to perform the matching and assignment.
+
+Some examples of use include the following code samples, where each make use of the example `MyEnum` class, defined as follows:
+
+```python
+from enumerific import Enum
+
+class MyEnum(Enum):
+  Option1 = "ABC"
+  Option2 = "DEF"
+```
+
+#### Example 1: Reconciling a Value
+
+```python
+from enumerific import Enum
+
+class MyEnum(Enum):
+  Option1 = "ABC"
+  Option2 = "DEF"
+
+# Given a string value in this case
+value = "ABC"
+
+# Reconcile it to the associated enumeration option
+value = MyEnum.reconcile(value)
+
+assert value == MyEnum.Option1  # asserts successfully
+assert value is MyEnum.Option1  # asserts successfully as enums are singletons
+```
+
+#### Example 2: Reconciling an Enumeration Option Name
+
+```python
+from enumerific import Enum
+
+class MyEnum(Enum):
+  Option1 = "ABC"
+  Option2 = "DEF"
+
+# Given a string value in this case
+value = "Option1"
+
+# Reconcile it to the associated enumeration option
+value = MyEnum.reconcile(value)
+
+assert value == MyEnum.Option1  # asserts successfully
+assert value is MyEnum.Option1  # asserts successfully as enums are singletons
+```
+
+#### Example 3: Validating a Value
+
+```python
+from enumerific import Enum
+
+class MyEnum(Enum):
+  Option1 = "ABC"
+  Option2 = "DEF"
+
+# The value can be an enumeration option's name, its value, or the enumeration option
+value = "Option1"
+value = "ABC"
+value = MyEnum.Option1
+
+if MyEnum.validate(value) is True:
+    # do something if the value could be validated
+    pass
+else:
+    # do something else if the value could not be validated
+    pass
+```
+
+#### Example 4: Iterating Over Enumeration Options
+
+```python
+from enumerific import Enum
+
+class MyEnum(Enum):
+  Option1 = "ABC"
+  Option2 = "DEF"
+
+for option in MyEnum.options():
+    # do something with each option
+    print(option.name, option.value)
+```
+
+### Unit Tests
+
+The Enumerific library includes a suite of comprehensive unit tests which ensure that the library functionality operates as expected. The unit tests were developed with and are run via `pytest`.
+
+To ensure that the unit tests are run within a predictable runtime environment where all of the necessary dependencies are available, a [Docker](https://www.docker.com) image is created within which the tests are run. To run the unit tests, ensure Docker and Docker Compose is [installed](https://docs.docker.com/engine/install/), and perform the following commands, which will build the Docker image via `docker compose build` and then run the tests via `docker compose run` – the output of running the tests will be displayed:
+
+```shell
+$ docker compose build
+$ docker compose run tests
+```
+
+To run the unit tests with optional command line arguments being passed to `pytest`, append the relevant arguments to the `docker compose run tests` command, as follows, for example passing `-vv` to enable verbose output:
+
+```shell
+$ docker compose run tests -vv
+```
+
+See the documentation for [PyTest](https://docs.pytest.org/en/latest/) regarding available optional command line arguments.
+
+### Copyright & License Information
+
+Copyright © 2024–2025 Daniel Sissman; licensed under the MIT License.

enumerific-1.0.1.dist-info/RECORD

@@ -0,0 +1,12 @@
+enumerific/__init__.py,sha256=YUGW74YNx4ZNtjmtRAJS8zTjn9z0zM1QCAa985kTAjk,419
+enumerific/exceptions.py,sha256=u0-efY2ufY__DZPs56L_SblvhnFZjUb2AcMjL_AxtKw,293
+enumerific/extensible.py,sha256=QCud2izNd5EEvjJWM2GO_U7QHiuDDkGU-5M7s3igpaY,68493
+enumerific/logging.py,sha256=zz1Phnot1BFWMoxwvZ0FlZDsiYZZYhz-_S4IzgPYc40,97
+enumerific/standard.py,sha256=xQhhwlcYZ6-8DmgscbV38g2Ol5Z8_vvBwonz-Ww0I40,3254
+enumerific/version.txt,sha256=1R5uyUBYVUqEVYpbQC7m71_fVFXjXJAv7aYc2odSlDo,5
+enumerific-1.0.1.dist-info/licenses/LICENSE.md,sha256=j1XidOCGUhPx7CyXA31uC0XGKDRnvUcZpMp161qHI6g,1077
+enumerific-1.0.1.dist-info/METADATA,sha256=_fsZpLq6PjDyaBNRMToy8bOJqCbgwAOF3j6oBoHde3Q,7721
+enumerific-1.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+enumerific-1.0.1.dist-info/top_level.txt,sha256=hyemsMgPYZgSx71XHmFRF-gvc_2Y4rDAESR8e0hbYHU,11
+enumerific-1.0.1.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+enumerific-1.0.1.dist-info/RECORD,,

{enumerific-0.0.0.dist-info → enumerific-1.0.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

enumerific-0.0.0.dist-info/METADATA

@@ -1,4 +0,0 @@
-Metadata-Version: 2.2
-Name: enumerific
-Version: 0.0.0
-License-File: LICENSE.md

enumerific-0.0.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-enumerific/__init__.py,sha256=GWEZBAT_ml4VXTQLjUKLnkQtf3AUljF0vokd8-cINk8,3227
-enumerific-0.0.0.dist-info/LICENSE.md,sha256=j1XidOCGUhPx7CyXA31uC0XGKDRnvUcZpMp161qHI6g,1077
-enumerific-0.0.0.dist-info/METADATA,sha256=xTLu0rdVXG3rz6ct3SytxKUsA4ZJaRbgyyDOSguvEKs,79
-enumerific-0.0.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-enumerific-0.0.0.dist-info/top_level.txt,sha256=hyemsMgPYZgSx71XHmFRF-gvc_2Y4rDAESR8e0hbYHU,11
-enumerific-0.0.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-enumerific-0.0.0.dist-info/RECORD,,