enumerific 0.0.0__tar.gz → 1.0.1__tar.gz

enumerific-1.0.1/PKG-INFO

@@ -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-0.0.0 → enumerific-1.0.1}/README.md

@@ -4,11 +4,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
 
@@ -16,10 +20,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"
 
@@ -28,12 +45,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:
@@ -46,7 +62,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):
@@ -56,7 +72,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"
 
@@ -69,7 +91,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"
 
@@ -82,7 +110,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"
@@ -90,13 +124,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)
@@ -108,14 +150,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
 ```
 
@@ -123,4 +165,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/pyproject.toml

@@ -0,0 +1,66 @@
+[project]
+name = "enumerific"
+description = "Simplifies working with Python enums."
+readme = {file = "README.md", content-type = "text/markdown"}
+keywords = ["enum", "enumeration", "enumerations"]
+authors = [{name = "Daniel Sissman"}]
+license = "MIT"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+requires-python = ">=3.10"
+dynamic = [
+  "version",
+  "dependencies",
+  "optional-dependencies",
+]
+
+[project.urls]
+documentation = "https://github.com/bluebinary/enumerific/blob/main/README.md"
+changelog = "https://github.com/bluebinary/enumerific/blob/main/CHANGELOG.md"
+repository = "https://github.com/bluebinary/enumerific"
+issues = "https://github.com/bluebinary/enumerific/issues"
+homepage = "https://github.com/bluebinary/enumerific"
+
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.dynamic]
+version = {file = "source/enumerific/version.txt"}
+dependencies = {file = "requirements.txt"}
+
+[tool.setuptools.dynamic.optional-dependencies]
+development = {file = "requirements.development.txt"}
+distribution = {file = "requirements.distribution.txt"}
+
+[tool.setuptools]
+zip-safe = true
+include-package-data = true
+
+[tool.setuptools.packages]
+find = {where = ["source"]}
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "-ra -q"
+testpaths = [
+    "tests"
+]
+
+[tool.black]
+line-length = 88
+target-version = ['py310']
+include = '\.pyi?$'
+extend-exclude = '''
+/(
+  # The following are specific to Black, you probably don't want those.
+  | blib2to3
+  | tests/data
+  | profiling
+)/
+'''

enumerific-1.0.1/requirements.development.txt

@@ -0,0 +1,4 @@
+# Enumerific Library: Development & Test Dependencies
+black==24.10.*
+pytest==8.3.*
+pytest-codeblocks==0.17.0

enumerific-1.0.1/requirements.distribution.txt

@@ -0,0 +1,4 @@
+# Enumerific Library: Build & Deployment Dependencies
+build
+twine
+wheel

enumerific-1.0.1/requirements.txt

@@ -0,0 +1 @@
+# Enumerific Library: Runtime Dependencies

enumerific-1.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

enumerific-1.0.1/source/enumerific/__init__.py

@@ -0,0 +1,23 @@
+from enum import *
+
+from .logging import logger
+
+from .exceptions import EnumValueError
+
+from .extensible import (
+    Enumeration,
+    EnumerationType,
+    EnumerationInteger,
+    EnumerationString,
+    EnumerationFloat,
+    EnumerationComplex,
+    EnumerationBytes,
+    EnumerationTuple,
+    EnumerationSet,
+    EnumerationList,
+    EnumerationDictionary,
+    EnumerationFlag,
+    auto,
+)
+
+from .standard import Enum

enumerific-1.0.1/source/enumerific/exceptions.py

@@ -0,0 +1,18 @@
+class EnumValueError(ValueError):
+    pass
+
+
+class EnumerationError(RuntimeError):
+    pass
+
+
+class EnumerationOptionError(AttributeError, EnumerationError):
+    pass
+
+
+class EnumerationSubclassingError(EnumerationError):
+    pass
+
+
+class EnumerationNonUniqueError(EnumerationError):
+    pass