enumerific 1.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

@@ -1 +1 @@
-1.0.0
+1.0.1

{enumerific-1.0.0.dist-info → enumerific-1.0.1.dist-info}/METADATA

@@ -1,44 +1,32 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: enumerific
-Version: 1.0.0
+Version: 1.0.1
 Summary: Simplifies working with Python enums.
 Author: Daniel Sissman
-License: MIT License
-        
-        Copyright © 2024–2025 Daniel Sissman.
-        
-        Permission is hereby granted, free of charge, to any person obtaining a copy
-        of this software and associated documentation files (the "Software"), to deal
-        in the Software without restriction, including without limitation the rights
-        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-        copies of the Software, and to permit persons to whom the Software is
-        furnished to do so, subject to the following conditions:
-        
-        The above copyright notice and this permission notice shall be included in all
-        copies or substantial portions of the Software.
-        
-        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-        SOFTWARE.
-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
+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: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 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.9
+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
 
@@ -46,11 +34,15 @@ The `enumerific` library provides several useful extensions to the Python built-
 
 ### Requirements
 
-The Enumerific library has been tested with Python 3.9, 3.10, 3.11, 3.12 and 3.13 but may work with some earlier versions such as 3.8, but has not been tested against this version or any earlier. The library is not compatible with Python 2.* or earlier.
+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
 
-The Enumerific library is available from PyPi, so may be added to a project's dependencies via its `requirements.txt` file or similar by referencing the Enumerific library's name, `enumerific`, or the library may be installed directly into your local runtime environment using `pip install` by entering the following command, and following any prompts:
+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
 
@@ -58,10 +50,23 @@ The Enumerific library is available from PyPi, so may be added to a project's de
 
 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
 ```
-import enumerific
 
-class MyEnum(enumerific.Enum):
+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"
 
@@ -70,12 +75,11 @@ 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:
@@ -88,7 +92,7 @@ The benefits of being able to validate and reconcile various input values agains
 
 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):
@@ -98,7 +102,13 @@ class MyEnum(Enum):
 
 #### 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"
 
@@ -111,7 +121,13 @@ 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"
 
@@ -124,7 +140,13 @@ 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"
@@ -132,13 +154,21 @@ 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)
@@ -150,14 +180,14 @@ The Enumerific library includes a suite of comprehensive unit tests which ensure
 
 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
 ```
 
@@ -165,4 +195,4 @@ See the documentation for [PyTest](https://docs.pytest.org/en/latest/) regarding
 
 ### Copyright & License Information
 
-Copyright © 2024–2025 Daniel Sissman; Licensed under the MIT License.
+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-1.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-1.0.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-enumerific/__init__.py,sha256=GWEZBAT_ml4VXTQLjUKLnkQtf3AUljF0vokd8-cINk8,3227
-enumerific/version.txt,sha256=klIfw8vZZL3J9YSpkbif3apXVO0cyW1tQkRTOGacEwU,5
-enumerific-1.0.0.dist-info/LICENSE.md,sha256=j1XidOCGUhPx7CyXA31uC0XGKDRnvUcZpMp161qHI6g,1077
-enumerific-1.0.0.dist-info/METADATA,sha256=MHKN_mQRKEneFtNS5VAX4bJd33Z0NhRTKVzAUL9xb6M,8066
-enumerific-1.0.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-enumerific-1.0.0.dist-info/top_level.txt,sha256=hyemsMgPYZgSx71XHmFRF-gvc_2Y4rDAESR8e0hbYHU,11
-enumerific-1.0.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-enumerific-1.0.0.dist-info/RECORD,,