Merge pull request #86 from barseghyanartur/dev

Fixes in docs. Fixes in pdf_file and docx_file. (#85)

CHANGELOG.rst

@@ -16,6 +16,13 @@ are used for versioning (schema follows below):
   0.3.4 to 0.4).
 - All backwards incompatible changes are mentioned in this document.
 
+0.6.9
+-----
+2024-05-10
+
+- Minor fixes in ``pdf_file`` and ``docx_file`` providers.
+- Minor fixes in docs.
+
 0.6.8
 -----
 2024-05-06

README.rst

@@ -222,12 +222,13 @@ As files on the file system
     FAKER.gif_file()  # str
     FAKER.txt_file()  # str
 
-Factories
----------
+Factories/dynamic fixtures
+--------------------------
 This is how you could define factories for `Django`_'s built-in ``Group``
 and ``User`` models.
 
 .. code-block:: python
+    :name: test_factories
 
     from django.contrib.auth.models import Group, User
     from fake import (

conftest.py

@@ -0,0 +1,51 @@
+"""
+Configuration hooks for `pytest`. Normally this wouldn't be necessary,
+but since `pytest-rst` is used, we want to clean-up files generated by
+running documentation tests. Therefore, this hook, which simply
+calls the `clean_up` method of the `FILE_REGISTRY` instance.
+"""
+import pytest
+from fake import FILE_REGISTRY
+
+__author__ = "Artur Barseghyan <artur.barseghyan@gmail.com>"
+__copyright__ = "2023-2024 Artur Barseghyan"
+__license__ = "MIT"
+__all__ = (
+    "pytest_runtest_setup",
+    "pytest_runtest_teardown",
+)
+
+
+def pytest_collection_modifyitems(session, config, items):
+    """Modify test items during collection."""
+    for item in items:
+        try:
+            from pytest_rst import RSTTestItem
+
+            if isinstance(item, RSTTestItem):
+                # Dynamically add marker to RSTTestItem tests
+                item.add_marker(pytest.mark.django_db(transaction=True))
+        except ImportError:
+            pass
+
+
+def pytest_runtest_setup(item):
+    """Setup before test runs."""
+    try:
+        from pytest_rst import RSTTestItem
+
+        if isinstance(item, RSTTestItem):
+            pass
+    except ImportError:
+        pass
+
+
+def pytest_runtest_teardown(item, nextitem):
+    """Clean up after test ends."""
+    try:
+        from pytest_rst import RSTTestItem
+
+        if isinstance(item, RSTTestItem):
+            FILE_REGISTRY.clean_up()
+    except ImportError:
+        pass