pytest-data-loader 0.1.0__tar.gz

pytest_data_loader-0.1.0/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    target-branch: "main"
+    open-pull-requests-limit: 10

pytest_data_loader-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,55 @@
+name: release
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+  build:
+    name: Build package
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - name: Build and Check Package
+      uses: hynek/build-and-inspect-python-package@v2
+
+  publish-to-testpypi:
+    name: Publish to TestPyPI
+    needs: [ build ]
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/project/pytest-data-loader/
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: Packages
+          path: dist/
+      - name: Publish package to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    needs: [ publish-to-testpypi ]
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/pytest-data-loader/
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: Packages
+          path: dist/
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pytest_data_loader-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,73 @@
+name: test
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          cache-dependency-glob: "**/pyproject.toml"
+      - name: Install dependencies
+        run: |
+          uv pip install --system .[lint]
+      - name: Run pre-commit
+        shell: bash
+        run: |
+          pre-commit run --all-files --show-diff-on-failure
+
+  package:
+    needs: [lint]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Build and Check Package
+        uses: hynek/build-and-inspect-python-package@v2
+
+  test:
+    needs: [package]
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        os: ["ubuntu-latest", "windows-latest"]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Download Package
+      uses: actions/download-artifact@v4
+      with:
+        name: Packages
+        path: dist
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        enable-cache: true
+        cache-dependency-glob: "**/pyproject.toml"
+    - name: Install tox
+      run: |
+        uv pip install --system tox tox-uv
+    - name: Test
+      shell: bash
+      run: |
+        tox -e py --installpkg `find dist/*.tar.gz`

pytest_data_loader-0.1.0/.gitignore

@@ -0,0 +1,165 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+.DS_Store
+
+# Unofficial tests
+tests/**/_*/**

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

@@ -0,0 +1,29 @@
+repos:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v5.0.0
+  hooks:
+    - id: check-toml
+    - id: check-yaml
+      args:
+        - --unsafe
+    - id: end-of-file-fixer
+      exclude: ^tests/(.*/)?data/
+- repo: local
+  hooks:
+    - id: ruff
+      name: ruff
+      entry: ruff check
+      language: system
+      args:
+        - --fix
+      types: [ python ]
+    - id: ruff-format
+      name: ruff-format
+      entry: ruff format
+      language: system
+      types: [ python ]
+    - id: mypy
+      name: mypy
+      entry: mypy src
+      pass_filenames: false
+      language: system

pytest_data_loader-0.1.0/PKG-INFO

@@ -0,0 +1,252 @@
+Metadata-Version: 2.4
+Name: pytest-data-loader
+Version: 0.1.0
+Summary: Pytest plugin for loading test data for data-driven testing (DDT)
+Author: Yugo Kato
+Project-URL: Homepage, https://github.com/yugokato/pytest-data-loader
+Keywords: pytest,data-driven testing,DDT
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3 :: Only
+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 :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: pytest<9,>=7.0.0
+Requires-Dist: pluggy>=1.2.0
+Provides-Extra: lint
+Requires-Dist: mypy<2,>=1.15.0; extra == "lint"
+Requires-Dist: pre-commit<5,>=3.0.0; extra == "lint"
+Requires-Dist: ruff<0.15.0,>=0.14.0; extra == "lint"
+Provides-Extra: test
+Requires-Dist: pytest-mock<4,>=3.0.0; extra == "test"
+Requires-Dist: pytest-smoke; extra == "test"
+Requires-Dist: pytest-xdist[psutil]<4,>=2.3.0; extra == "test"
+Provides-Extra: dev
+Requires-Dist: tox<5,>=4.0.0; extra == "dev"
+Requires-Dist: tox-uv<2,>=1.0.0; extra == "dev"
+Requires-Dist: pytest-data-loader[lint,test]; extra == "dev"
+
+pytest-data-loader
+======================
+
+[![PyPI](https://img.shields.io/pypi/v/pytest-data-loader)](https://pypi.org/project/pytest-data-loader/)
+[![Supported Python
+versions](https://img.shields.io/pypi/pyversions/pytest-data-loader.svg)](https://pypi.org/project/pytest-data-loader/)
+[![test](https://github.com/yugokato/pytest-data-loader/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/yugokato/pytest-data-loader/actions/workflows/test.yml?query=branch%3Amain)
+[![Code style ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://docs.astral.sh/ruff/)
+
+`pytest-data-loader` is a `pytest` plugin for loading test data from files to facilitate data-driven testing.  
+In addition to loading data from a single file, it supports dynamic test parametrization by splitting file data into 
+parts or by loading multiple files from a directory.
+
+
+## Installation
+
+```bash
+pip install pytest-data-loader
+```
+
+
+
+## Quick Start
+
+```python
+from pytest_data_loader import load
+
+# Loads and injects data from data/example.json as the "data" fixture
+# example.json: {"foo": 1, "bar": 2}
+@load("data", "example.json")
+def test_example(data):
+    assert "foo" in data
+```
+
+
+
+## Usage
+
+The plugin provides three data loaders — `@load`, `@parametrize`, and `@parametrize_dir` — available as decorators for 
+loading test data. As a common design, each loader takes two positional arguments: 
+
+- `fixture_names`: Name(s) of the fixture(s) that will be made available to the test function. It supports either one
+                   (receiving file data) or two (receiving file path and file data) fixture names
+- `relative_path`: File or directory path relative to one of the base "data" loader directories to load test data 
+                   from. The plugin will search for the closest "data" directory from the test file's directory and up 
+                   towards the Pytest root directory
+
+Additionally, each loader supports different optional keyword arguments to customize how the data is loaded. See the 
+"Loader Options" section for details.
+
+
+
+## Examples:
+
+Given you have the following project structure:
+```
+.(pytest rootdir)
+├── data/
+│   ├── data1.json
+│   ├── data2.txt
+│   └── images/
+│       ├── image1.gif
+│       ├── image2.jpg
+│       └── image3.png
+├── tests1/
+│   ├── data/
+│   │   ├── data1.txt
+│   │   └── data2.txt
+│   └── test_something_else.py
+└── test_something.py
+```
+The plugin searches for a `data` directory relative to the test file to locate data files.
+
+### 1. Load file data (`@load`)
+`@load` is a file loader that loads the file content and passes it to the test function.
+
+```python
+from pytest_data_loader import load
+
+
+@load("data", "data1.json")
+def test_something1(data):
+    """
+    This test loads the content of data/data1.json. The parsed JSON data is accessible through the specified 
+    fixture argument, `data` in this example.
+    """
+    ...
+
+@load(("file_path", "data"), "data2.txt")
+def test_something2(file_path, data):
+    """
+    This test loads the content of data/data2.txt. The file path and file content are accessible through the 
+    specified fixture arguments, `file_path` and `data` in this example.
+    """
+```
+
+> [!NOTE]
+> If both `./test_something.py` and `./tests1/test_something_else.py` happen to have the above same loader definitions, 
+> the first test function will load `./data/data1.json` for both test files, and the second test function will load 
+> `data2.txt` from each test file's **nearest** `data` directory. This ensures that each test file loads data from its 
+> nearest data directory.  
+> This behavior applies to all loaders.
+
+
+### 2. Parametrize file data (`@parametrize`)
+`@parametrize` is a file loader that dynamically parametrizes the decorated test function by splitting the loaded file 
+content into logical parts. The test function will then receive the part data as loaded data for the current test.
+
+```python
+from pytest_data_loader import parametrize
+
+
+@parametrize("data", "data1.json")
+def test_something1(data):
+    """
+    This test will be dynamically parametrized with each key–value pair in a JSON object or each item in a JSON array, 
+    depending on the data stored in data1.json.
+    The parametrized data is accessible through the specified fixture argument, `data` in this example.
+    """
+    ...
+
+@parametrize(("file_path", "data"), "data2.txt")
+def test_something2(file_path, data):
+    """
+    This test will be dynamically parametrized with each text line from data2.txt. 
+    The file path and each parametrized text line are accessible through the specified fixture arguments, 
+    `file_path` and `data` in this example.
+    """
+    ...
+```
+> [!TIP]
+> - By default, the plugin will apply the following logic for splitting file content: 
+>   - Text file: Each line in a file
+>   - JSON file:
+>     - object: Each key–value pair in the object
+>     - array: Each item in the array
+>     - other types (string, number, boolean, null): The whole content as a single chunk
+>   - Binary file: Unsupported. Requires specifying a custom split logic as the `parametrizer_func` loader option 
+> - You can apply your own logic by specifying the `parametrizer_func` loader option
+
+
+### 3. Parametrize files in a directory (`@parametrize_dir`)
+
+`@parametrize_dir` is a file loader that dynamically parametrizes the decorated test function with the contents of the 
+files stored in the specified directory. The test function will then receive the content of each file as loaded data 
+for the current test.
+
+```python
+from pytest_data_loader import parametrize_dir
+
+
+@parametrize_dir("data", "images")
+def test_something(data):
+    """
+    This test will be dynamically parametrized with each image file in the `images` directory.
+    """
+    ...
+```
+> [!NOTE]
+> File names starting with a dot (.) are considered hidden files regardless of your platform. 
+> These files are automatically excluded from the parametrization.  
+
+
+
+## Lazy Loading
+
+Lazy loading is enabled by default for all loaders to improve performance, especially with large datasets. During the 
+test collection phase, Pytest receives a lazy object as a test parameter instead of the actual data. The data is 
+resolved only when it is needed during test setup.    
+If you need to disable this behavior for a specific test for some reason, you can specify the `lazy_loading=False` 
+option on the loader.
+
+> [!NOTE]
+> Lazy loading in the `@parametrize` loader works slightly differently from other loaders. Since Pytest needs to know 
+> the total number of parameters in advance, the plugin may still need to load the file data once and split during test 
+> collection phase, depending on the file type and the specified loader options. But once it's done, those part data 
+> will not be kept as parameter values and will be loaded lazily later.
+
+
+
+## Loader Options
+
+Each loader supports different optional parameters you can use to change how your data is loaded.
+### @load
+- `lazy_loading`: Enable or disable lazy loading
+- `force_binary`: Force the file to be read in binary mode
+- `onload_func`: A function to transform or preprocess loaded data before passing it to the test function
+- `id`: An ID for the loaded data. The file name is used if not specified
+
+### @parametrize
+- `lazy_loading`: Enable or disable lazy loading
+- `onload_func`: A function to adjust the shape of the loaded data before splitting into parts
+- `parametrizer_func`: A function to customize how the loaded data should be split
+- `filter_func`: A function to filter the split data parts. Only matching parts are included as test parameters
+- `process_func`: A function to adjust the shape of each split data before passing it to the test function
+- `id_func`: A function to generate a parameter ID for each test parameter, supported only when lazy_loading is `False`
+
+### @parametrize_dir
+- `lazy_loading`: Enable or disable lazy loading
+- `force_binary`: Force each file to be read in binary mode
+- `filter_func`: A function to filter file paths. Only the contents of matching file paths are included as the test 
+parameters
+- `process_func`: A function to adjust the shape of each loaded file's data before passing it to the test function
+
+
+
+## INI Options
+
+### `data_loader_dir_name`
+A base directory name to load test data from. The file or directory path specified to a loader is considered a 
+relative path to one of these base directories in the directory tree.  
+Plugin default: `data`
+
+### `data_loader_strip_trailing_whitespace`
+Automatically remove trailing whitespace characters when loading text data.  
+Plugin default: `true`