pyvista-validation 0.1.0__tar.gz

pyvista_validation-0.1.0/.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: /
+  schedule:
+    interval: weekly
+  labels: [maintenance, dependencies]
+  open-pull-requests-limit: 20
+- package-ecosystem: github-actions
+  directory: /.github/workflows
+  schedule:
+    interval: weekly
+  labels: [maintenance, dependencies]
+  groups:
+    artifacts:
+      patterns: [actions/upload-artifact, actions/download-artifact]

pyvista_validation-0.1.0/.github/release.yml

@@ -0,0 +1,9 @@
+changelog:
+  exclude:
+    authors:
+    - dependabot
+    - dependabot[bot]
+    - pre-commit-ci
+    - pre-commit-ci[bot]
+    - github-actions
+    - github-actions[bot]

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

@@ -0,0 +1,168 @@
+name: CI
+
+# `pull_request` is deliberately unfiltered: filtering it by base branch would
+# skip every pull request in a stack that does not target main.
+on:
+  push:
+    branches: [main]
+    tags: [v*]
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1   # v7.0.1
+      with:
+        persist-credentials: false
+        fetch-depth: 0
+    - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d   # v10.0.1
+      with:
+        enable-cache: false
+    - run: uv sync --group dev
+    - run: uv run pre-commit run --all-files --show-diff-on-failure
+      env:
+          # This hook exists to stop *local* commits straight to main; it
+          # would always fail here since CI checks out that branch/tag directly.
+        SKIP: no-commit-to-branch
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.10', '3.11', '3.12', '3.13', '3.14']
+    steps:
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1   # v7.0.1
+      with:
+        persist-credentials: false
+        fetch-depth: 0
+    - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d   # v10.0.1
+      with:
+        enable-cache: false
+    - run: uv sync --group dev --extra all --python ${{ matrix.python-version }}
+    - run: uv run pytest tests/ --cov --cov-report=xml
+    - uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f   # v7.0.0
+      with:
+        files: ./coverage.xml
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+  test-minimal:
+      # numpy is the only hard dependency; this proves the VTK and SciPy code
+      # paths stay optional rather than quietly becoming required.
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.10', '3.14']
+    steps:
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1   # v7.0.1
+      with:
+        persist-credentials: false
+        fetch-depth: 0
+    - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d   # v10.0.1
+      with:
+        enable-cache: false
+    - run: uv sync --group dev --python ${{ matrix.python-version }}
+    - run: uv run python -c "import pyvista_validation, sys; assert not [m for m in sys.modules if m.startswith(('vtkmodules', 'scipy'))]"
+    - run: uv run pytest tests/ --no-cov
+
+  downstream:
+    name: Downstream PyVista
+    runs-on: ubuntu-latest
+    env:
+      VIRTUAL_ENV: ${{ github.workspace }}/.venv
+      PYVISTA_OFF_SCREEN: 'true'
+    steps:
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1   # v7.0.1
+      with:
+        persist-credentials: false
+        fetch-depth: 0
+    - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d   # v10.0.1
+      with:
+        enable-cache: false
+    - run: sudo apt-get update && sudo apt-get install --yes libgl1 libxrender1 xvfb
+    - name: Clone the PyVista main branch
+      run: git clone --depth=1 --branch main --single-branch https://github.com/pyvista/pyvista.git "${{ runner.temp }}/pyvista"
+    - name: Install PyVista and this package into one environment
+      run: |
+        uv venv
+        uv pip install --editable "${{ runner.temp }}/pyvista" --group test --directory "${{ runner.temp }}/pyvista"
+        uv pip install --editable '.[all]'
+    - name: Check the public API still matches PyVista's
+      run: .venv/bin/python tools/downstream_parity.py
+    - name: Run PyVista's validation suite against this package
+      working-directory: ${{ runner.temp }}/pyvista
+      env:
+        PYTHONPATH: ${{ github.workspace }}/tools
+      run: xvfb-run ${{ github.workspace }}/.venv/bin/python -m pytest tests/core/test_validation.py -p downstream_shim -v
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1   # v7.0.1
+      with:
+        persist-credentials: false
+        fetch-depth: 0
+    - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d   # v10.0.1
+      with:
+        enable-cache: false
+    - run: uv sync --group docs --extra all --python 3.14
+    - run: uv run --no-sync sphinx-build -W --keep-going -b html doc doc/_build/html
+    - uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b   # v4.0.0
+      with:
+        path: doc/_build/html/
+
+  deploy-docs:
+      # Publishes directly from the workflow artifact; no gh-pages branch.
+    needs: docs
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    steps:
+    - uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e   # v4.0.5
+      id: deployment
+
+  build:
+    needs: [pre-commit, test, test-minimal, downstream, docs]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1   # v7.0.1
+      with:
+        persist-credentials: false
+        fetch-depth: 0
+    - uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d   # v10.0.1
+      with:
+        enable-cache: false
+    - run: uv build
+    - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a   # v7.0.1
+      with:
+        name: dist
+        path: dist/
+
+  publish:
+    needs: build
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write
+    steps:
+    - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c   # v8.0.1
+      with:
+        name: dist
+        path: dist/
+    - uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33   # release/v1

pyvista_validation-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+.DS_Store
+.coverage
+.coverage.*
+.idea/
+.venv/
+build/
+dist/
+doc/_autosummary/
+doc/_build/
+*.egg-info/
+__pycache__/
+pyvista_validation/_version.py
+uv.lock

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

@@ -0,0 +1,38 @@
+ci:
+  autoupdate_commit_msg: 'chore: update pre-commit hooks'
+  autofix_prs: true
+  autoupdate_schedule: quarterly
+
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0
+  hooks:
+  - id: check-merge-conflict
+  - id: debug-statements
+  - id: no-commit-to-branch
+    args: [--branch, main]
+
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  rev: v0.16.0
+  hooks:
+  - id: ruff-check
+    args: [--fix, --show-fixes]
+  - id: ruff-format
+
+- repo: https://github.com/zizmorcore/zizmor-pre-commit
+  rev: v1.11.0
+  hooks:
+  - id: zizmor
+
+- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks
+  rev: v2.15.0
+  hooks:
+  - id: pretty-format-yaml
+    args: [--autofix, --indent, '2']
+
+- repo: https://github.com/ComPWA/taplo-pre-commit
+  rev: v0.9.3
+  hooks:
+  - id: taplo-format
+      # See options: https://taplo.tamasfe.dev/configuration/formatter-options.html
+    args: [--option, reorder_arrays=true, --option, reorder_keys=true, --option, align_comments=false]

pyvista_validation-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2026 The PyVista Developers
+
+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.

pyvista_validation-0.1.0/PKG-INFO

@@ -0,0 +1,222 @@
+Metadata-Version: 2.4
+Name: pyvista-validation
+Version: 0.1.0
+Summary: Validate and standardize array-like input.
+Author-email: The PyVista Developers <info@pyvista.org>
+License-Expression: MIT
+Project-URL: Documentation, https://validation.pyvista.org/
+Project-URL: Homepage, https://github.com/pyvista/pyvista-validation
+Keywords: array,numpy,validation
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+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
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.21.0
+Provides-Extra: all
+Requires-Dist: pyvista-validation[scipy,vtk]; extra == "all"
+Provides-Extra: scipy
+Requires-Dist: scipy; extra == "scipy"
+Provides-Extra: vtk
+Requires-Dist: vtk; extra == "vtk"
+Dynamic: license-file
+
+# pyvista-validation
+
+Validate and standardize array-like input.
+
+These are the input validation functions developed for
+[PyVista](https://github.com/pyvista/pyvista), extracted into a standalone package so any
+project can use them. NumPy is the only required dependency: PyVista is not needed, and
+VTK and SciPy are optional.
+
+The functions are useful when writing Python methods that accept flexible array-like
+input, wrapping VTK, or anywhere you want one standard representation out of many
+possible inputs.
+
+## Installation
+
+```bash
+pip install pyvista-validation
+```
+
+VTK and SciPy are only needed to validate their own object types, so they ship as extras:
+
+```bash
+pip install pyvista-validation[vtk]    # accept vtkMatrix3x3, vtkMatrix4x4, vtkTransform
+pip install pyvista-validation[scipy]  # accept scipy.spatial.transform.Rotation
+pip install pyvista-validation[all]    # both
+```
+
+Neither is imported unless you actually pass one of their objects in.
+
+## Two families of function
+
+A **`check`** function:
+
+* Performs a simple validation on a single input variable.
+* Raises an error if the check fails due to invalid input.
+* Does not modify input or return anything.
+
+A **`validate`** function:
+
+* Uses `check` functions to check the type and/or value of input arguments.
+* Applies optional constraints -- for example input or output must have a specific
+  length, shape, type, data-type, etc.
+* Accepts many different input types or values and standardizes the output as a single
+  representation with known properties.
+
+## Usage
+
+`validate` functions return a standard representation:
+
+```python
+>>> import numpy as np
+>>> from pyvista_validation import validate_array3
+>>> from pyvista_validation import validate_arrayNx3
+>>> from pyvista_validation import validate_data_range
+
+>>> validate_array3([1, 2, 3])
+array([1, 2, 3])
+
+>>> validate_arrayNx3([[1, 2, 3], [4, 5, 6]])
+array([[1, 2, 3],
+       [4, 5, 6]])
+
+>>> validate_data_range([0, 1])
+(0, 1)
+```
+
+A 3x3 input to `validate_transform4x4` is padded into a 4x4 matrix:
+
+```python
+>>> from pyvista_validation import validate_transform4x4
+
+>>> validate_transform4x4(np.eye(3))
+array([[1., 0., 0., 0.],
+       [0., 1., 0., 0.],
+       [0., 0., 1., 0.],
+       [0., 0., 0., 1.]])
+```
+
+`validate_array` is the general-purpose entry point that the others build on, and takes
+the constraints as keyword arguments:
+
+```python
+>>> from pyvista_validation import validate_array
+
+>>> validate_array(
+...     [1, 2, 3], must_have_shape=(3,), must_be_in_range=[0, 5], dtype_out=float
+... )
+array([1., 2., 3.])
+```
+
+`check` functions return nothing and raise on failure:
+
+```python
+>>> from pyvista_validation import check_range
+>>> from pyvista_validation import check_subdtype
+
+>>> check_range([1, 5], rng=[0, 3])
+Traceback (most recent call last):
+    ...
+ValueError: Array values must all be less than or equal to 3.
+
+>>> check_subdtype(np.array([1.0]), np.integer)
+Traceback (most recent call last):
+    ...
+TypeError: Input has incorrect dtype of 'float64'. The dtype must be a subtype of <class 'numpy.integer'>.
+```
+
+Error messages name the offending value and the constraint it violated:
+
+```python
+>>> validate_array3([1, 2])
+Traceback (most recent call last):
+    ...
+ValueError: Array has shape (2,) which is not allowed. Shape must be one of [(3,), (1, 3), (3, 1)].
+```
+
+Pass `name=` to any function to control how the input is described in that message.
+
+## Common use cases
+
+| To validate | Use |
+| --- | --- |
+| A 3-element vector | `validate_array3` |
+| An Nx3 point or vector array | `validate_arrayNx3` |
+| Point or cell IDs | `validate_arrayN_unsigned` |
+| A transformation matrix | `validate_transform4x4` |
+| A rotation matrix | `validate_rotation` |
+
+## API reference
+
+### `validate` functions
+
+| Function | Description |
+| --- | --- |
+| `validate_array` | Check and validate a numeric array meets specific requirements. |
+| `validate_array3` | Validate a numeric 1D array with 3 elements. |
+| `validate_arrayN` | Validate a numeric 1D array. |
+| `validate_arrayN_unsigned` | Validate a numeric 1D array of non-negative (unsigned) integers. |
+| `validate_arrayNx3` | Validate an array is numeric and has shape Nx3. |
+| `validate_axes` | Validate 3D axes vectors. |
+| `validate_data_range` | Validate a data range. |
+| `validate_dimensionality` | Validate a dimensionality. |
+| `validate_number` | Validate a real, finite number. |
+| `validate_rotation` | Validate a rotation as a 3x3 matrix. |
+| `validate_transform3x3` | Validate transform-like input as a 3x3 `ndarray`. |
+| `validate_transform4x4` | Validate transform-like input as a 4x4 `ndarray`. |
+
+### `check` functions
+
+| Function | Description |
+| --- | --- |
+| `check_contains` | Check if an item is in a container. |
+| `check_finite` | Check if an array has finite values, that is, no NaN or Inf values. |
+| `check_greater_than` | Check if an array's elements are all greater than some value. |
+| `check_instance` | Check if an object is an instance of the given type or types. |
+| `check_integer` | Check if an array has integer or integer-like float values. |
+| `check_iterable` | Check if an object is an instance of `Iterable`. |
+| `check_iterable_items` | Check if an iterable's items all have a specified type. |
+| `check_length` | Check if the length of an array meets specific requirements. |
+| `check_less_than` | Check if an array's elements are all less than some value. |
+| `check_ndim` | Check if an array has the specified number of dimensions. |
+| `check_nonnegative` | Check if an array's elements are all nonnegative. |
+| `check_number` | Check if an object is an instance of `Number`. |
+| `check_range` | Check if an array's values are all within a specific range. |
+| `check_real` | Check if an array has real numbers (float or integer type). |
+| `check_sequence` | Check if an object is an instance of `Sequence`. |
+| `check_shape` | Check if an array has the specified shape. |
+| `check_sorted` | Check if an array's values are sorted. |
+| `check_string` | Check if an object is an instance of `str`. |
+| `check_subdtype` | Check if an input's data-type is a subtype of another data-type or data-types. |
+| `check_type` | Check if an object is one of the given type or types. |
+
+Every function has a full docstring with parameters and examples.
+
+## Relationship to PyVista
+
+This code began as `pyvista.core._validation` and keeps its full commit history here.
+PyVista is a downstream consumer, and CI runs PyVista's own validation test suite against
+this package on every change.
+
+One PyVista-specific helper, `_validate_color_sequence`, was not moved: it is built on
+`pyvista.plotting`'s `Color` class and stays with PyVista.
+
+## License
+
+MIT

pyvista_validation-0.1.0/README.md

@@ -0,0 +1,186 @@
+# pyvista-validation
+
+Validate and standardize array-like input.
+
+These are the input validation functions developed for
+[PyVista](https://github.com/pyvista/pyvista), extracted into a standalone package so any
+project can use them. NumPy is the only required dependency: PyVista is not needed, and
+VTK and SciPy are optional.
+
+The functions are useful when writing Python methods that accept flexible array-like
+input, wrapping VTK, or anywhere you want one standard representation out of many
+possible inputs.
+
+## Installation
+
+```bash
+pip install pyvista-validation
+```
+
+VTK and SciPy are only needed to validate their own object types, so they ship as extras:
+
+```bash
+pip install pyvista-validation[vtk]    # accept vtkMatrix3x3, vtkMatrix4x4, vtkTransform
+pip install pyvista-validation[scipy]  # accept scipy.spatial.transform.Rotation
+pip install pyvista-validation[all]    # both
+```
+
+Neither is imported unless you actually pass one of their objects in.
+
+## Two families of function
+
+A **`check`** function:
+
+* Performs a simple validation on a single input variable.
+* Raises an error if the check fails due to invalid input.
+* Does not modify input or return anything.
+
+A **`validate`** function:
+
+* Uses `check` functions to check the type and/or value of input arguments.
+* Applies optional constraints -- for example input or output must have a specific
+  length, shape, type, data-type, etc.
+* Accepts many different input types or values and standardizes the output as a single
+  representation with known properties.
+
+## Usage
+
+`validate` functions return a standard representation:
+
+```python
+>>> import numpy as np
+>>> from pyvista_validation import validate_array3
+>>> from pyvista_validation import validate_arrayNx3
+>>> from pyvista_validation import validate_data_range
+
+>>> validate_array3([1, 2, 3])
+array([1, 2, 3])
+
+>>> validate_arrayNx3([[1, 2, 3], [4, 5, 6]])
+array([[1, 2, 3],
+       [4, 5, 6]])
+
+>>> validate_data_range([0, 1])
+(0, 1)
+```
+
+A 3x3 input to `validate_transform4x4` is padded into a 4x4 matrix:
+
+```python
+>>> from pyvista_validation import validate_transform4x4
+
+>>> validate_transform4x4(np.eye(3))
+array([[1., 0., 0., 0.],
+       [0., 1., 0., 0.],
+       [0., 0., 1., 0.],
+       [0., 0., 0., 1.]])
+```
+
+`validate_array` is the general-purpose entry point that the others build on, and takes
+the constraints as keyword arguments:
+
+```python
+>>> from pyvista_validation import validate_array
+
+>>> validate_array(
+...     [1, 2, 3], must_have_shape=(3,), must_be_in_range=[0, 5], dtype_out=float
+... )
+array([1., 2., 3.])
+```
+
+`check` functions return nothing and raise on failure:
+
+```python
+>>> from pyvista_validation import check_range
+>>> from pyvista_validation import check_subdtype
+
+>>> check_range([1, 5], rng=[0, 3])
+Traceback (most recent call last):
+    ...
+ValueError: Array values must all be less than or equal to 3.
+
+>>> check_subdtype(np.array([1.0]), np.integer)
+Traceback (most recent call last):
+    ...
+TypeError: Input has incorrect dtype of 'float64'. The dtype must be a subtype of <class 'numpy.integer'>.
+```
+
+Error messages name the offending value and the constraint it violated:
+
+```python
+>>> validate_array3([1, 2])
+Traceback (most recent call last):
+    ...
+ValueError: Array has shape (2,) which is not allowed. Shape must be one of [(3,), (1, 3), (3, 1)].
+```
+
+Pass `name=` to any function to control how the input is described in that message.
+
+## Common use cases
+
+| To validate | Use |
+| --- | --- |
+| A 3-element vector | `validate_array3` |
+| An Nx3 point or vector array | `validate_arrayNx3` |
+| Point or cell IDs | `validate_arrayN_unsigned` |
+| A transformation matrix | `validate_transform4x4` |
+| A rotation matrix | `validate_rotation` |
+
+## API reference
+
+### `validate` functions
+
+| Function | Description |
+| --- | --- |
+| `validate_array` | Check and validate a numeric array meets specific requirements. |
+| `validate_array3` | Validate a numeric 1D array with 3 elements. |
+| `validate_arrayN` | Validate a numeric 1D array. |
+| `validate_arrayN_unsigned` | Validate a numeric 1D array of non-negative (unsigned) integers. |
+| `validate_arrayNx3` | Validate an array is numeric and has shape Nx3. |
+| `validate_axes` | Validate 3D axes vectors. |
+| `validate_data_range` | Validate a data range. |
+| `validate_dimensionality` | Validate a dimensionality. |
+| `validate_number` | Validate a real, finite number. |
+| `validate_rotation` | Validate a rotation as a 3x3 matrix. |
+| `validate_transform3x3` | Validate transform-like input as a 3x3 `ndarray`. |
+| `validate_transform4x4` | Validate transform-like input as a 4x4 `ndarray`. |
+
+### `check` functions
+
+| Function | Description |
+| --- | --- |
+| `check_contains` | Check if an item is in a container. |
+| `check_finite` | Check if an array has finite values, that is, no NaN or Inf values. |
+| `check_greater_than` | Check if an array's elements are all greater than some value. |
+| `check_instance` | Check if an object is an instance of the given type or types. |
+| `check_integer` | Check if an array has integer or integer-like float values. |
+| `check_iterable` | Check if an object is an instance of `Iterable`. |
+| `check_iterable_items` | Check if an iterable's items all have a specified type. |
+| `check_length` | Check if the length of an array meets specific requirements. |
+| `check_less_than` | Check if an array's elements are all less than some value. |
+| `check_ndim` | Check if an array has the specified number of dimensions. |
+| `check_nonnegative` | Check if an array's elements are all nonnegative. |
+| `check_number` | Check if an object is an instance of `Number`. |
+| `check_range` | Check if an array's values are all within a specific range. |
+| `check_real` | Check if an array has real numbers (float or integer type). |
+| `check_sequence` | Check if an object is an instance of `Sequence`. |
+| `check_shape` | Check if an array has the specified shape. |
+| `check_sorted` | Check if an array's values are sorted. |
+| `check_string` | Check if an object is an instance of `str`. |
+| `check_subdtype` | Check if an input's data-type is a subtype of another data-type or data-types. |
+| `check_type` | Check if an object is one of the given type or types. |
+
+Every function has a full docstring with parameters and examples.
+
+## Relationship to PyVista
+
+This code began as `pyvista.core._validation` and keeps its full commit history here.
+PyVista is a downstream consumer, and CI runs PyVista's own validation test suite against
+this package on every change.
+
+One PyVista-specific helper, `_validate_color_sequence`, was not moved: it is built on
+`pyvista.plotting`'s `Color` class and stays with PyVista.
+
+## License
+
+MIT

pyvista_validation-0.1.0/doc/Makefile

@@ -0,0 +1,14 @@
+# Minimal makefile for Sphinx documentation
+
+SPHINXOPTS    ?= -W --keep-going
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)