HEROgold / confkit / 20166396683

98%

push

github

Display allowed values for Enum config options (#27)

* Initial plan

* Add __str__ methods to display allowed values for Enum types

Co-authored-by: HEROgold <21345384+HEROgold@users.noreply.github.com>

* Add comprehensive tests for enum allowed values feature

Co-authored-by: HEROgold <21345384+HEROgold@users.noreply.github.com>

* Fix Optional enum handling and add support for None values

Co-authored-by: HEROgold <21345384+HEROgold@users.noreply.github.com>

* Fix linting issues in enum tests

Co-authored-by: HEROgold <21345384+HEROgold@users.noreply.github.com>

* Improve comment stripping to handle values with # characters

Co-authored-by: HEROgold <21345384+HEROgold@users.noreply.github.com>

* Refactor enum code to eliminate duplication and simplify comment stripping

- Created _EnumBase class with shared functionality for all enum types
- Moved comment stripping logic to a single static method
- Simplified comment stripping to handle any # character (hex uses 0x prefix)
- Regenerated examples/config.ini with all examples to include enum allowed values

Co-authored-by: HEROgold <21345384+HEROgold@users.noreply.github.com>

* Add abstractmethod decorators and remove redundant Generic inheritance

- Removed redundant Generic[T] from _EnumBase (BaseDataType is already Generic)
- Added @abstractmethod decorators to _format_allowed_values and _get_value_str

Co-authored-by: HEROgold <21345384+HEROgold@users.noreply.github.com>

* include all example ini files after they're generated.

* Update documentation for enum allowed values feature

- Updated docs/examples/enums.md to showcase the new self-documenting feature with inline comments
- Added detailed explanation of how allowed values are displayed for different enum types
- Updated docs/reference/data_types.md with enum converter documentation showing the allowed values feature
- Added documentation build steps to README.md development workflow section
- Documented the pdoc + mkdocs build proce... (continued)

175 of 177 new or added lines in 2 files covered. (98.87%)

1665 of 1683 relevant lines covered (98.93%)

0.99 hits per line