inline-snapshot-numpy 0.1.0__tar.gz

inline_snapshot_numpy-0.1.0/.copier-answers.yml

@@ -0,0 +1,27 @@
+# Changes here will be overwritten by Copier
+_commit: v0.4.3
+_src_path: https://github.com/15r10nk/project-template.git
+author_email: 15r10nk@polarbit.de
+author_name: Frank Hoffmann
+discord_id: ''
+discord_invite_id: ''
+full_coverage: true
+github_user: 15r10nk
+insider_only: false
+module_name: inline_snapshot_numpy
+project_description: NumPy integration for inline-snapshot
+project_main: false
+project_name: inline-snapshot-numpy
+pypy_versions:
+- pypy3.11
+python_versions:
+- '3.9'
+- '3.10'
+- '3.11'
+- '3.12'
+- '3.13'
+- '3.14'
+- '3.15'
+show_project_logo: false
+test_lowest_deps: true
+use_mkdocs: false

inline_snapshot_numpy-0.1.0/.copier-enforce.json

@@ -0,0 +1,5 @@
+[
+  ".copier-enforce.json",
+  ".github/workflows/ci.yml",
+  ".github/workflows/release-pr.yml"
+]

inline_snapshot_numpy-0.1.0/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: 15r10nk

inline_snapshot_numpy-0.1.0/.github/actions/setup/action.yml

@@ -0,0 +1,22 @@
+name: General Setup
+description: checkout & setup python
+inputs:
+  python-version:  # id of input
+    description: the python version to use
+    required: false
+
+    default: '3.13'
+
+runs:
+  using: composite
+  steps:
+  - name: Install uv
+    uses: astral-sh/setup-uv@v5
+    with:
+      python-version: ${{inputs.python-version}}
+
+  - name: Set up Python
+    uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
+    with:
+      python-version: ${{inputs.python-version}}
+      allow-prereleases: true

inline_snapshot_numpy-0.1.0/.github/pull_request_template.md

@@ -0,0 +1,22 @@
+
+## Description
+<!--
+Please provide a clear and concise description of what this pull request does.
+Create an issue first if you want to make bigger changes.
+-->
+
+## Related Issue(s)
+<!--
+- Closes #123 (replace with relevant issue number(s), if applicable)
+- Related to #456
+-->
+
+## Checklist
+- [ ] I have tested my changes thoroughly (you can download the test coverage with `hatch run cov:github`).
+- [ ] I have added/updated relevant documentation.
+- [ ] I have added tests for new functionality (if applicable).
+- [ ] I have reviewed my own code for errors.
+- [ ] I have added a changelog entry with `hatch run changelog:entry`
+- I used:
+    - [ ] semantic commits (`feat:` will cause a major and `fix:` a minor version bump)
+    - [ ] or my commits can be squashed during merge

inline_snapshot_numpy-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,236 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+
+  detect_release:
+
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+    outputs:
+      is_release: ${{steps.release.outputs.is_release}}
+      tag: ${{steps.release.outputs.tag}}
+
+    steps:
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+
+    - name: Detect merged release pull request
+      id: release
+      env:
+        GH_TOKEN: ${{github.token}}
+      run: |
+        version="$(python -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')"
+        release_branch="$(
+          gh api "repos/$GITHUB_REPOSITORY/commits/$GITHUB_SHA/pulls" \
+            --jq '[.[] | select(.merged_at != null and .base.ref == "main" and (.head.ref | startswith("release/v")))][0].head.ref // ""'
+        )"
+        if test "$release_branch" = "release/v$version"; then
+          echo "is_release=true" >> "$GITHUB_OUTPUT"
+          echo "tag=v$version" >> "$GITHUB_OUTPUT"
+        else
+          echo "is_release=false" >> "$GITHUB_OUTPUT"
+        fi
+
+
+  test:
+
+    runs-on: ${{matrix.os}}
+
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', '3.14', '3.15', pypy3.11]
+
+        os: [ubuntu-latest, windows-latest, macos-15]
+        lowest_resolution: [false]
+        is_insider:
+        - ${{contains(github.repository, '-insiders/')}}
+
+        exclude:
+        - is_insider: true
+          os: windows-latest
+        - is_insider: true
+          os: macos-15
+
+
+        - os: macos-15
+          python-version: '3.10'
+        - os: windows-latest
+          python-version: '3.10'
+
+        - os: macos-15
+          python-version: '3.11'
+        - os: windows-latest
+          python-version: '3.11'
+
+        - os: macos-15
+          python-version: '3.12'
+        - os: windows-latest
+          python-version: '3.12'
+
+        - os: macos-15
+          python-version: '3.13'
+        - os: windows-latest
+          python-version: '3.13'
+
+        - os: macos-15
+          python-version: '3.14'
+        - os: windows-latest
+          python-version: '3.14'
+
+        - os: macos-15
+          python-version: pypy3.11
+        - os: windows-latest
+          python-version: pypy3.11
+
+        include:
+        - os: ubuntu-latest
+          python-version: '3.9'
+          lowest_resolution: true
+        - os: ubuntu-latest
+          python-version: '3.15'
+          lowest_resolution: true
+
+
+    env:
+      TOP: ${{github.workspace}}
+      COVERAGE_PROCESS_START: ${{github.workspace}}/pyproject.toml
+    steps:
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+    - uses: ./.github/actions/setup
+      with:
+        python-version: ${{matrix.python-version}}
+
+    - name: Resolve lowest direct dependencies
+      if: matrix.lowest_resolution
+      run: |
+        uv lock --upgrade --resolution lowest-direct
+        uv sync --locked --resolution lowest-direct
+        uv pip install "coverage[toml]" coverage-enable-subprocess pytest pytest-xdist
+
+    - name: Test locked dependencies
+      if: ${{ !matrix.lowest_resolution }}
+      run: uv run --locked --with "coverage[toml]" --with coverage-enable-subprocess --with pytest --with pytest-xdist -m ${{ matrix.os == 'ubuntu-latest' && 'coverage run -m' || '' }} pytest -n=auto -vv
+
+    - name: Test lowest direct dependencies
+      if: matrix.lowest_resolution
+      run: uv run --no-sync -m coverage run -m pytest -n=auto -vv
+
+    - run: |
+        uv run ${{ matrix.lowest_resolution && '--no-sync' || '--with "coverage[toml]"' }} -m coverage combine
+        mv .coverage .coverage.${{ matrix.python-version }}-${{matrix.os}}-${{strategy.job-index}}
+      if: matrix.os == 'ubuntu-latest'
+
+    - name: Upload coverage data
+      uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
+      if: matrix.os == 'ubuntu-latest'
+      with:
+        name: coverage-data-${{github.run_id}}-${{ matrix.python-version }}-${{matrix.os}}-${{strategy.job-index}}
+        path: .coverage.*
+        include-hidden-files: true
+        if-no-files-found: ignore
+
+  mypy:
+    name: Type check (${{matrix.python-version}})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', '3.14', '3.15']
+
+
+    steps:
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+    - uses: ./.github/actions/setup
+      with:
+        python-version: ${{matrix.python-version}}
+    - run: uv run --locked --with mypy mypy src tests
+
+  coverage:
+    name: Combine & check coverage
+    env:
+      TOP: ${{github.workspace}}
+    if: always()
+    needs: test
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+    - uses: ./.github/actions/setup
+
+    - uses: actions/download-artifact@cc203385981b70ca67e1cc392babf9cc229d5806 # v4.1.9
+      with:
+        pattern: coverage-data-${{github.run_id}}-*
+        merge-multiple: true
+
+    - name: Combine coverage & fail if it's <100%
+      run: |
+        uv run --with "coverage[toml]" coverage combine
+        uv run --with "coverage[toml]" coverage html --skip-covered --skip-empty
+
+        # Report and write to summary.
+        uv run --with "coverage[toml]" coverage report --format=markdown >> "$GITHUB_STEP_SUMMARY"
+
+        # Report again and fail if under 100%.
+        uv run --with "coverage[toml]" coverage report --fail-under=100
+
+
+    - name: Upload HTML report if check failed
+      uses: actions/upload-artifact@4cec3d8aa04e39d1a68397de0c4cd6fb9dce8ec1 # v4.6.1
+      with:
+        name: html-report
+        path: htmlcov
+      if: ${{ failure() }}
+
+
+  publish:
+    name: Publish new release
+    needs: [detect_release, test, mypy, coverage]
+    if: needs.detect_release.outputs.is_release == 'true' && !contains(github.repository, '-insiders/')
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+    - name: Checkout tested commit
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      with:
+        fetch-depth: 0
+        token: ${{secrets.PAT_WEEKLY_UPDATE}}
+
+    - uses: ./.github/actions/setup
+      with:
+        python-version: '3.12'
+
+    - name: Build distributions
+      run: uvx hatch build
+
+    - name: Tag tested commit
+      env:
+        TAG: ${{needs.detect_release.outputs.tag}}
+      run: |
+        git config user.name github-actions[bot]
+        git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+        if git rev-parse "$TAG" >/dev/null 2>&1; then
+          test "$(git rev-list -n 1 "$TAG")" = "$GITHUB_SHA"
+        else
+          git tag --annotate "$TAG" --message "Release $TAG"
+          git push origin "$TAG"
+        fi
+
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@76f52bc884231f62b9a034ebfe128415bbaabdfc # v1.12.4
+      with:
+        skip-existing: true
+
+    - name: Create GitHub release
+      env:
+        GITHUB_TOKEN: ${{github.token}}
+      run: uv run --locked scriv github-release --repo "$GITHUB_REPOSITORY"

inline_snapshot_numpy-0.1.0/.github/workflows/release-pr.yml

@@ -0,0 +1,53 @@
+name: Create release pull request
+
+on:
+  workflow_dispatch:
+
+concurrency:
+  group: release-pull-request
+  cancel-in-progress: false
+
+jobs:
+  release-pr:
+    if: "!contains(github.repository, '-insiders/')"
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+
+    steps:
+    - name: Checkout main
+      uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      with:
+        fetch-depth: 0
+
+    - name: Set up uv
+      uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+      with:
+        python-version: '3.13'
+
+    - name: Prepare release
+      id: release
+      run: |
+        version="$(uv run --locked cz bump --get-next --yes)"
+        uv run --locked scriv collect --version "$version" --no-edit
+        uv run --locked cz bump "$version" --yes --version-files-only
+        uv lock
+        echo "version=$version" >> "$GITHUB_OUTPUT"
+
+    - name: Run pre-commit
+      run: uvx pre-commit run --all-files || uvx pre-commit run --all-files
+
+    - name: Create pull request
+      uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8.1.1
+      with:
+        token: ${{secrets.PAT_WEEKLY_UPDATE}}
+        branch: release/v${{steps.release.outputs.version}}
+        commit-message: 'chore: release v${{steps.release.outputs.version}}'
+        title: 'chore: release v${{steps.release.outputs.version}}'
+        body: |
+          Prepare release v${{steps.release.outputs.version}}.
+
+          This pull request was generated from the changelog fragments and
+          Conventional Commits on `main`.
+        delete-branch: true

inline_snapshot_numpy-0.1.0/.github/workflows/weekly.yml

@@ -0,0 +1,45 @@
+name: Weekly Cog Update
+
+on:
+  schedule:
+  - cron: 0 8 * * 5      # Every Friday at 08:00 UTC
+  workflow_dispatch:
+
+jobs:
+  weekly-update:
+    permissions:
+      contents: write
+      pull-requests: write
+
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      with:
+        fetch-depth: 0
+
+    - name: Set up Python
+      uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
+      with:
+        python-version: '3.12'
+
+    - name: Set up uv
+      uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
+
+    - name: Run cog update
+      run: |
+        git ls-files -z -- '*.py' '*.md' | xargs -0 -r uv run --group cog cog -r
+        uvx gha-update
+        uvx pre-commit run --all-files || uvx pre-commit run --all-files
+
+    - name: Create Pull Request
+      uses: peter-evans/create-pull-request@5f6978faf089d4d20b00c7766989d076bb2fc7f1 # v8.1.1
+      with:
+        token: ${{github.token}}
+        branch-token: ${{secrets.PAT_WEEKLY_UPDATE}}
+        commit-message: 'chore: weekly cog update'
+        title: 'chore: weekly update'
+        body: Automated weekly update via scheduled workflow.
+        branch: chore/weekly-update
+        delete-branch: true
+        reviewers: 15r10nk

inline_snapshot_numpy-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+__pycache__/
+.coverage*
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.venv/
+dist/
+htmlcov/

inline_snapshot_numpy-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,103 @@
+ci:
+  autofix_pr: false
+  autoupdate_commit_msg: 'style: pre-commit autoupdate'
+  autofix_commit_msg: 'style: pre-commit fixed styling'
+  autoupdate_schedule: monthly
+
+repos:
+
+- repo: https://github.com/15r10nk/project-template
+  rev: v0.4.3
+  hooks:
+  - id: copier-enforce
+
+
+- hooks:
+  - id: check-ast
+  - id: check-merge-conflict
+  - id: trailing-whitespace
+  - id: mixed-line-ending
+  - id: fix-byte-order-marker
+  - id: check-case-conflict
+  - id: check-json
+  - id: end-of-file-fixer
+  repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0
+- hooks:
+  - args:
+    - --in-place
+    - --expand-star-imports
+    - --remove-all-unused-imports
+    - --ignore-init-module-imports
+    id: autoflake
+  repo: https://github.com/myint/autoflake
+  rev: v2.3.1
+
+- repo: https://github.com/asottile/setup-cfg-fmt
+  rev: v2.8.0
+  hooks:
+  - id: setup-cfg-fmt
+
+- repo: https://github.com/pycqa/isort
+  rev: 6.0.1
+  hooks:
+  - id: isort
+    name: isort (python)
+    args: [--profile, black]
+
+- hooks:
+  - args:
+    - --py38-plus
+    id: pyupgrade
+  repo: https://github.com/asottile/pyupgrade
+  rev: v3.21.2
+- hooks:
+  - id: black
+  repo: https://github.com/psf/black
+  rev: 25.1.0
+- hooks:
+  - id: blacken-docs
+    args: [-l80]
+  repo: https://github.com/adamchainz/blacken-docs
+  rev: 1.19.1
+
+
+- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+  rev: v2.15.0
+  hooks:
+  - id: pretty-format-yaml
+    args: [--autofix, --indent, '2']
+
+- hooks:
+  - id: commitizen
+    stages:
+    - commit-msg
+  repo: https://github.com/commitizen-tools/commitizen
+  rev: v4.8.3
+
+
+# - repo: https://github.com/PyCQA/docformatter
+#   rev: v1.7.5
+#   hooks:
+#   - id: docformatter
+
+- repo: https://github.com/abravalheri/validate-pyproject
+  rev: v0.24.1
+  hooks:
+  - id: validate-pyproject
+
+- repo: https://github.com/henryiii/validate-pyproject-schema-store
+  rev: 2025.04.28
+  hooks:
+  - id: validate-pyproject
+
+
+- repo: https://github.com/rhysd/actionlint
+  rev: v1.7.7
+  hooks:
+  - id: actionlint
+
+- repo: https://github.com/crate-ci/typos
+  rev: v1.47.0
+  hooks:
+  - id: typos

inline_snapshot_numpy-0.1.0/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+<!-- scriv-insert-here -->

inline_snapshot_numpy-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing
+Contributions are welcome.
+Please create an issue before writing a pull request so we can discuss what needs to be changed.
+
+# Testing
+The code can be tested with [hatch](https://hatch.pypa.io/latest/)
+
+* `hatch run cov:test` can be used to test all supported python versions and to check for coverage.
+* `hatch run +py=3.10 all:test -- --sw` runs pytest for python 3.10 with the `--sw` argument.
+
+
+# Coverage
+This project has a hard coverage requirement of 100%.
+The goal here is to find different edge cases which might have bugs.
+
+However, it is possible to exclude some code from the coverage.
+
+Code can be marked with `pragma: no cover`, if it can not be tested for some reason.
+This makes it easy to spot uncovered code in the source.
+
+Impossible conditions can be handled with `assert False`.
+``` python
+if some_condition:
+    ...
+if some_other_condition:
+    ...
+else:
+    assert False, "unreachable because ..."
+```
+This serves also as an additional check during runtime.
+
+
+# Commits
+Please use [pre-commit](https://pre-commit.com/) for your commits.
+
+# Changelog
+Add a changelog fragment for user-visible changes with
+`uv run scriv create --add --edit`. The fragments are collected automatically
+when the release pull request is created.

inline_snapshot_numpy-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Frank Hoffmann
+
+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.

inline_snapshot_numpy-0.1.0/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.5
+Name: inline-snapshot-numpy
+Version: 0.1.0
+Summary: NumPy integration for inline-snapshot
+Project-URL: Documentation, https://github.com/15r10nk/inline-snapshot-numpy#readme
+Project-URL: Issues, https://github.com/15r10nk/inline-snapshot-numpy/issues
+Project-URL: Source, https://github.com/15r10nk/inline-snapshot-numpy
+Author-email: Frank Hoffmann <15r10nk@polarbit.de>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+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
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.9
+Requires-Dist: inline-snapshot>=0.36.1
+Requires-Dist: numpy>=1.20; python_version < '3.15'
+Requires-Dist: numpy>=2.5.4; python_version >= '3.15'
+Description-Content-Type: text/markdown
+
+# inline-snapshot-numpy
+
+[NumPy](https://numpy.org/) integration for
+[inline-snapshot](https://github.com/15r10nk/inline-snapshot).
+
+## Installation
+
+```bash
+pip install inline-snapshot-numpy
+```
+
+## Usage
+
+The package provides snapshot-aware versions of NumPy's array assertions:
+
+```python
+from inline_snapshot_numpy import assert_array_equal
+from numpy import array
+
+
+def test_array():
+    actual = array([[1, 2], [3, 4]])
+    assert_array_equal(actual)
+```
+
+Create the missing snapshot with:
+
+```bash
+pytest --inline-snapshot=create
+```
+
+The test will become:
+
+```python
+def test_array():
+    actual = array([[1, 2], [3, 4]])
+    assert_array_equal(actual, desired=array([[1, 2], [3, 4]]))
+```
+
+The following helpers are available: `assert_array_equal`, `assert_allclose`,
+`assert_array_almost_equal`, `assert_array_almost_equal_nulp`,
+and `assert_array_max_ulp`.
+
+The expected array is managed through `snapshot_arg()`, so no explicit
+`snapshot()` call or import is needed. You can still pass an explicit
+`snapshot(...)` for compatibility.
+
+Alternatively, call `setup()` from `conftest.py` to patch the corresponding
+functions in `numpy.testing`:
+
+```python
+from inline_snapshot_numpy import setup
+
+setup()
+```
+
+## License
+
+Distributed under the terms of the MIT license.