enumplus 1.0.0__tar.gz → 1.2.0__tar.gz

{enumplus-1.0.0 → enumplus-1.2.0}/.github/ISSUE_TEMPLATE/bug_report.md

@@ -31,7 +31,7 @@ A clear and concise description of what actually happened.
 ## Environment
 
 - Python version: [e.g. 3.12.1]
-- enumplus version: [e.g. 0.1.0]
+- enumplus version: [e.g. 1.1.0]
 - OS: [e.g. Ubuntu 22.04, Windows 11, macOS 14]
 
 ## Additional context

enumplus-1.2.0/.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+name: CI
+
+on:
+  push:
+    branches: ["main", "master"]
+  pull_request:
+    branches: ["main", "master"]
+
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Lint with ruff
+        run: ruff check enumplus/ tests/
+
+      - name: Type check with mypy
+        run: mypy --strict enumplus/ tests/
+
+      - name: Run tests
+        run: pytest --tb=short
+
+  build:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Build package
+        run: |
+          python -m pip install --upgrade pip build
+          python -m build
+
+      - name: Verify wheel contents
+        run: |
+          python -m zipfile -l dist/*.whl
+          python -c "import zipfile, sys; z=zipfile.ZipFile([f for f in __import__('glob').glob('dist/*.whl')][0]); assert 'enumplus/py.typed' in z.namelist(), 'py.typed missing from wheel'"

enumplus-1.2.0/.github/workflows/release.yml

@@ -0,0 +1,176 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: write
+  id-token: write
+
+concurrency:
+  group: release-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+
+      - name: Lint with ruff
+        run: ruff check enumplus/ tests/
+
+      - name: Type check with mypy
+        run: mypy --strict enumplus/ tests/
+
+      - name: Run tests
+        run: pytest --tb=short
+
+  build:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  github-release:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Generate changelog
+        id: changelog
+        run: |
+          PREVIOUS_TAG=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null || echo "")
+          if [ -z "$PREVIOUS_TAG" ]; then
+            RANGE=""
+          else
+            RANGE="${PREVIOUS_TAG}..HEAD"
+          fi
+
+          # Group commits by conventional commit type
+          FEATURES=$(git log --pretty=format:"- %s" ${RANGE} --grep="^feat" --grep="^add" --grep="^support" -i | grep -v "release:" || true)
+          FIXES=$(git log --pretty=format:"- %s" ${RANGE} --grep="^fix" --grep="^patch" -i || true)
+          REFACTOR=$(git log --pretty=format:"- %s" ${RANGE} --grep="^refactor" --grep="^clean" -i || true)
+          DOCS=$(git log --pretty=format:"- %s" ${RANGE} --grep="^docs" --grep="^readme" -i || true)
+          TESTS=$(git log --pretty=format:"- %s" ${RANGE} --grep="^test" -i || true)
+          CHORE=$(git log --pretty=format:"- %s" ${RANGE} --grep="^chore" --grep="^ci" --grep="^build" -i || true)
+          RELEASE=$(git log --pretty=format:"- %s" ${RANGE} --grep="^release" -i || true)
+
+          {
+            echo "body<<EOF"
+            if [ -n "$FEATURES" ]; then
+              echo "### Features"
+              echo ""
+              echo "$FEATURES"
+              echo ""
+            fi
+            if [ -n "$FIXES" ]; then
+              echo "### Bug Fixes"
+              echo ""
+              echo "$FIXES"
+              echo ""
+            fi
+            if [ -n "$REFACTOR" ]; then
+              echo "### Refactoring"
+              echo ""
+              echo "$REFACTOR"
+              echo ""
+            fi
+            if [ -n "$DOCS" ]; then
+              echo "### Documentation"
+              echo ""
+              echo "$DOCS"
+              echo ""
+            fi
+            if [ -n "$TESTS" ]; then
+              echo "### Tests"
+              echo ""
+              echo "$TESTS"
+              echo ""
+            fi
+            if [ -n "$CHORE" ]; then
+              echo "### Chores"
+              echo ""
+              echo "$CHORE"
+              echo ""
+            fi
+            echo "---"
+            echo ""
+            echo "**PyPI**: https://pypi.org/project/enumplus/"
+            if [ -n "$PREVIOUS_TAG" ]; then
+              echo "**Full Changelog**: https://github.com/${{ github.repository }}/compare/${PREVIOUS_TAG}...${{ github.ref_name }}"
+            else
+              echo "**Commits**: https://github.com/${{ github.repository }}/commits/${{ github.ref_name }}"
+            fi
+            echo "EOF"
+          } >> "$GITHUB_OUTPUT"
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ github.ref_name }}
+          name: ${{ github.ref_name }}
+          body: ${{ steps.changelog.outputs.body }}
+          files: dist/*
+          draft: false
+          prerelease: false
+
+  publish-pypi:
+    needs: [build, github-release]
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

{enumplus-1.0.0 → enumplus-1.2.0}/.gitignore

@@ -37,3 +37,6 @@ htmlcov/
 # OS
 .DS_Store
 Thumbs.db
+
+# Temporary
+.git_commit_msg.txt

enumplus-1.2.0/AGENTS.md

@@ -0,0 +1,73 @@
+# Agent Notes for enumplus
+
+## Project purpose
+
+`enumplus` is a zero-dependency Python library that extends `enum.Enum` with:
+
+- Per-member display labels (`label`)
+- Arbitrary per-member metadata, accessible as attributes
+- `(value, metadata)` tuple unpacking at class definition
+- `choices()`, `from_value()`, `from_name()`, `filter()`, `get()`, `map()`
+- JSON serialization (`to_json`, `from_json`, `SerializableEncoder`)
+- Declaration-order comparison (`OrderedEnum`)
+- Optional Pydantic v2 integration (install with `pip install "enumplus[pydantic]"`)
+
+Requires Python `>=3.11`.
+
+## Important implementation details
+
+- The metaclass in `enumplus/enum.py` uses a custom `_EnumPlusDict` namespace.
+  This is required to:
+  - Unpack `(value, {metadata})` tuples before stdlib enum machinery sees them.
+  - Keep class config keys such as `serialize_by_name` from becoming enum members
+    or affecting `auto()` generation.
+  - Support `auto()` following a metadata tuple on Python 3.11–3.14.
+- `Enum.__eq__` and `EnumMeta.__contains__` use `_safe_equal`, which coerces
+  `a == b` to a `bool` without raising on shape/length mismatches (e.g. NumPy
+  arrays, unhashable container values).
+- `Enum.__hash__` uses `hash(self.value)` when possible and falls back to
+  `id(self)` for unhashable values, so enum members with list/dict values are
+  still usable as dict keys.
+- `serialize.py` `from_json` validates that input is a `str` and that the
+  parsed JSON is a `dict` (`TypeError` otherwise). Invalid JSON strings raise
+  `ValueError`.
+- `py.typed` is included in the wheel so the package is a PEP 561 typed package.
+
+## Build and verification commands
+
+```bash
+python -m ruff check enumplus/ tests/
+python -m mypy --strict enumplus/ tests/
+python -m pytest --tb=short
+python -m build
+```
+
+After building, verify the wheel contains `py.typed`:
+
+```bash
+python -m zipfile -l dist/*.whl
+```
+
+## Cross-version testing
+
+CI tests Python 3.11, 3.12, 3.13, and 3.14. Locally, the following versions have
+been verified:
+
+- Python 3.11.2
+- Python 3.12.4
+- Python 3.14.5
+
+Run a different version with the Windows launcher, e.g.:
+
+```bash
+py -3.11 -m pip install -e ".[dev]"
+py -3.11 -m pytest --tb=short
+py -3.11 -m mypy --strict enumplus/ tests/
+```
+
+## Known constraints
+
+- The git remote is `MathiasPaulenko/enumpy`, while the package name and PyPI
+  project are `enumplus`. Package URLs in `pyproject.toml` point to the actual
+  remote repository; update if the repository is renamed.
+- `ref/` is intentionally ignored (local reference material). Do not commit it.

enumplus-1.2.0/CHANGELOG.md

@@ -0,0 +1,76 @@
+# Changelog
+
+All notable changes to this project are documented in this file.
+
+The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.2.0] - 2026-08-23
+
+### Fixed
+
+- `serialize_by_name` is now correctly inherited by subclass enums instead of being silently reset to `False`.
+
+### Changed
+
+- Improved README with table of contents, requirements section, and dynamic CI badge.
+- Added `pydantic` optional dependency extra for Pydantic v2 integration.
+- Added concurrency groups to CI and release workflows to cancel superseded runs.
+- Updated issue templates with correct version examples.
+- Updated CONTRIBUTING with cross-version testing instructions and repository name clarification.
+
+## [1.1.0] - 2025-01-15
+
+### Added
+
+- Case-insensitive lookup via `case_insensitive=True` on `from_value()` and `from_name()`.
+- `serialize_by_name` class config for Pydantic v2 validation and serialization by member name.
+- `to_dict()` method for serializing an enum to a nested dictionary.
+- `get()` method for dict-style lookup with a default.
+- `map()` method for mapping each member to a value.
+- `keys()` method as an alias of `names()`.
+- `get_initial()` and `get_final()` for declaration-order access.
+- Callable labels for i18n / translatable labels.
+- `@dataclass_transform()` on the metaclass for type-checker metadata attribute support.
+- `py.typed` marker for PEP 561 typed-package support.
+- Python 3.14 support and CI coverage.
+
+### Fixed
+
+- `auto()` now works correctly after metadata tuples on Python 3.11–3.14.
+- Class config (`serialize_by_name`) no longer registers as an enum member or corrupts `auto()` state.
+- `__eq__`, `__hash__`, `__contains__`, `from_value`, `is_valid`, and `filter` are now safe for unhashable values and non-boolean comparison results.
+- `from_json` validates input type and JSON shape (`TypeError` for wrong type, `ValueError` for invalid JSON).
+- `from_name` raises `TypeError` for non-string input instead of `KeyError`.
+- `to_dict()` and `to_json()` no longer invoke non-label callable metadata values.
+- Removed redundant import in `SerializableEncoder`.
+
+### Changed
+
+- Improved package metadata: classifiers, project URLs, and dev dependency lower bounds.
+- Release workflow uses `${{ github.repository }}` for dynamic changelog URLs.
+- CONTRIBUTING and SUPPORT docs updated with correct commands.
+
+## [1.0.0] - 2024-12-01
+
+### Added
+
+- `Enum` base class as a drop-in replacement for `enum.Enum`.
+- `OrderedEnum` with declaration-order comparison operators.
+- Per-member labels with automatic `name.title()` fallback.
+- Per-member metadata via `(value, dict)` tuple syntax.
+- Metadata attribute access via `__getattr__`.
+- `choices()`, `from_value()`, `from_name()`, `is_valid()`, `validate()`.
+- `values()`, `names()`, `labels()`.
+- `filter()` by metadata key-value pairs.
+- `to_json()` / `from_json()` serialization.
+- `SerializableEncoder` for `json.dumps`.
+- Pydantic v2 integration via `__get_pydantic_core_schema__`.
+- Full test suite, CI, and release workflows.
+
+[Unreleased]: https://github.com/MathiasPaulenko/enumpy/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/MathiasPaulenko/enumpy/releases/tag/v1.2.0
+[1.1.0]: https://github.com/MathiasPaulenko/enumpy/releases/tag/v1.1.0
+[1.0.0]: https://github.com/MathiasPaulenko/enumpy/releases/tag/v1.0.0

{enumplus-1.0.0 → enumplus-1.2.0}/CONTRIBUTING.md

@@ -17,6 +17,8 @@ Thank you for your interest in contributing to enumplus! This document describes
    pip install -e ".[dev]"
    ```
 
+> **Note:** The git repository is named `enumpy`, while the package name is `enumplus`. This is expected — the repository name predates the package rename.
+
 ## Development Workflow
 
 1. Create a branch for your feature or bugfix:
@@ -26,9 +28,9 @@ Thank you for your interest in contributing to enumplus! This document describes
 2. Make your changes, keeping code style consistent with the existing codebase.
 3. Run the checks before committing:
    ```bash
-   ruff check enumplus tests
-   mypy enumplus
-   pytest
+   ruff check enumplus/ tests/
+   mypy --strict enumplus/ tests/
+   pytest --tb=short
    ```
 4. Commit using [conventional commits](https://www.conventionalcommits.org/):
    ```bash
@@ -51,12 +53,23 @@ Thank you for your interest in contributing to enumplus! This document describes
 - Run the full suite with `pytest`.
 - Do not weaken or delete existing tests without explicit justification.
 
+## Cross-Version Testing
+
+CI tests Python 3.11, 3.12, 3.13, and 3.14. To test locally against multiple Python versions, use the Python launcher (Windows) or `pyenv` (macOS/Linux):
+
+```bash
+py -3.11 -m pip install -e ".[dev]"
+py -3.11 -m pytest --tb=short
+py -3.11 -m mypy --strict enumplus/ tests/
+```
+
 ## Pull Request Guidelines
 
 - Keep PRs focused and small.
 - Reference any related issues (e.g., `Closes #123`).
 - Ensure all CI checks pass before requesting review.
 - Update documentation (`README.md`) if your change affects the public API.
+- Add a `CHANGELOG.md` entry under the `[Unreleased]` section.
 
 ## Reporting Issues