https://github.com/idlesign/pytest-datafixtures

Data fixtures for pytest made simple
https://github.com/idlesign/pytest-datafixtures

datafixture fixtures pytest pytest-plugin python python3

Last synced: 4 days ago
JSON representation

Data fixtures for pytest made simple

• Host: GitHub
• URL: https://github.com/idlesign/pytest-datafixtures
• Owner: idlesign
• License: bsd-3-clause
• Created: 2020-05-11T02:32:27.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-02-04T13:01:58.000Z (almost 3 years ago)
• Last Synced: 2024-10-29T23:23:32.590Z (14 days ago)
• Topics: datafixture, fixtures, pytest, pytest-plugin, python, python3
• Language: Python
• Homepage: https://github.com/idlesign/pytest-datafixtures
• Size: 12.7 KB
• Stars: 25
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG
  • Contributing: CONTRIBUTING
  • License: LICENSE

Awesome Lists containing this project

README

        
pytest-datafixtures

===================

https://github.com/idlesign/pytest-datafixtures

|release| |lic| |ci| |coverage|

.. |release| image:: https://img.shields.io/pypi/v/pytest-datafixtures.svg

    :target: https://pypi.python.org/pypi/pytest-datafixtures

.. |lic| image:: https://img.shields.io/pypi/l/pytest-datafixtures.svg

    :target: https://pypi.python.org/pypi/pytest-datafixtures

.. |ci| image:: https://img.shields.io/travis/idlesign/pytest-datafixtures/master.svg

    :target: https://travis-ci.org/idlesign/pytest-datafixtures

.. |coverage| image:: https://img.shields.io/coveralls/idlesign/pytest-datafixtures/master.svg

    :target: https://coveralls.io/r/idlesign/pytest-datafixtures

Description

-----------

*Data fixtures for pytest made simple*

Offers fixtures for your tests to simplify data fixtures access.

Makes use of Python's native ``Path`` objects.

Data fixtures (files) expected to be stored in ``datafixtures`` directory next to your test modules::

    tests

    |-- datafixtures

    |-- test_basic.py

    |

    |-- subdirectory

    |---- datafixtures

    |---- test_other.py

**Fixtures**

* ``datafix_dir`` - Path object for data fixtures directory from the current test module's directory.

* ``datafix`` - Path object for a file in data fixtures directory with the same name as the current test function.

* ``datafix_read`` - Returns text contents of a data fixture by name.

* ``datafix_readbin`` - Returns binary contents of a data fixture by name.

datafix_dir

~~~~~~~~~~~~~~~

Access data fixtures directory:

.. code-block:: python

    def test_me(datafix_dir):

        # datafix_dir returns a Path object.

        assert datafix_dir.exists()

        # Gather data fixtures filenames.

        files = list(f'{file.name}' for file in datafix_dir.iterdir())

        # Read some fixture as text.

        # The same as using `datafix_read` fixture (see below).

        filecontent = (datafix_dir / 'expected.html').read_text()

        # Or read binary.

        filecontent = (datafix_dir / 'dumped.bin').read_bytes()

datafix

~~~~~~~

Access a data fixture with test name:

.. code-block:: python

    def test_me(datafix):

        # Read datafixtures/test_me.txt file

        filecontents = datafix.with_suffix('.txt').read_text()

datafix_read

~~~~~~~~~~~~

Access text contents of a data fixture by name:

.. code-block:: python

    def test_datafix_read(datafix_read):

        # Read datafixtures/expected.html file

        filecontents = datafix_read('expected.html')

        # Read encoded and represent as an StringIO object.

        encoded_io = datafix_read('test_datafix.txt', encoding='cp1251', io=True)

datafix_readbin

~~~~~~~~~~~~~~~

Access binary contents of a data fixture by name:

.. code-block:: python

    def test_datafix_read(datafix_readbin):

        # Read datafixtures/dumped.bin file

        binary = datafix_readbin('dumped.bin')

        # Read binary and represent as an BytesIO object.

        bin_io = datafix_readbin('dumped.bin', io=True)

Requirements

------------

* Python 3.6+