Merge ea899eb into cfa0c96

datafiles/settings.py

@@ -9,3 +9,5 @@
 MINIMIZE_LIST_DIFFS = True
 
 YAML_LIBRARY = 'ruamel.yaml'
+
+WRITE_DELAY = 0.0  # seconds

datafiles/utils.py

@@ -1,6 +1,7 @@
 """Internal helper functions."""
 
 import dataclasses
+import time
 from contextlib import suppress
 from functools import lru_cache
 from pathlib import Path
@@ -10,6 +11,7 @@
 
 import log
 
+from . import settings
 from .types import Missing
 
 
@@ -114,6 +116,7 @@ def write(filename_or_path: Union[str, Path], text: str, *, display=False) -> No
 
     path.parent.mkdir(parents=True, exist_ok=True)
     path.write_text(text)
+    time.sleep(settings.WRITE_DELAY)  # ensure the file modification time changes
 
 
 def read(filename: str, *, display=False) -> str:

docs/settings.md

@@ -80,3 +80,15 @@ This setting controls the underlying YAML library used to read and write files.
 
 - `'ruamel.yaml'` (default)
 - `'PyYAML'`
+
+# `WRITE_DELAY`
+
+One some file systems, the modification time of a file ([`st_mtime`](https://docs.python.org/3/library/os.html#os.stat_result.st_mtime)) is unchanged if a file is read immediately after writing. This may cause intermittent issues if your use case involves rapidly changing files.
+
+To compensate for this, a short delay can be inserted after `datafiles` writes to the file system:
+
+```python
+import datafiles
+
+datafiles.settings.WRITE_DELAY = 0.01  # seconds
+```

pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 
 name = "datafiles"
-version = "0.12b3"
+version = "0.12b4"
 description = "File-based ORM for dataclasses."
 
 license = "MIT"
@@ -66,7 +66,7 @@ isort = "=5.5.1"
 
 # Linters
 mypy = "~0.790"
-pylint = { git = "https://github.com/PyCQA/pylint", branch = "master" }
+pylint = "~2.6.0"
 pydocstyle = "*"
 
 # Testing

pytest.ini

@@ -15,9 +15,6 @@ cache_dir = .cache
 log_level = DEBUG
 log_format = %(relpath)s:%(lineno)-4d %(levelname)5s: %(message)s
 
-markers =
-    flaky
-
 [pytest-watch]
 
 ignore =.cache,htmlcov,tml

tests/conftest.py

@@ -1,4 +1,3 @@
-import os
 from pathlib import Path
 from shutil import rmtree
 
@@ -9,9 +8,7 @@
 
 
 settings.HIDE_TRACEBACK_IN_HOOKS = False
-
-
-xfail_on_ci = pytest.mark.xfail(bool(os.getenv('CI')), reason="Flaky on CI")
+settings.WRITE_DELAY = 0.1
 
 
 def pytest_configure(config):
@@ -20,13 +17,6 @@ def pytest_configure(config):
     log.init()  # TODO: determine why the 'relpath' filter wasn't added automatically
 
 
-def pytest_collection_modifyitems(items):
-    for item in items:
-        for marker in item.iter_markers():
-            if marker.name == 'flaky':
-                item.add_marker(xfail_on_ci)
-
-
 @pytest.fixture(autouse=True)
 def create_tmp():
     path = Path('tmp')

tests/test_automatic_attributes.py

@@ -1,8 +1,6 @@
 # pylint: disable=unused-variable
 
 
-import pytest
-
 from datafiles import datafile
 from datafiles.utils import logbreak
 
@@ -13,7 +11,6 @@ class Sample:
 
 
 def describe_auto_attr():
-    @pytest.mark.flaky
     def with_builtin(expect):
         sample = Sample('abc')
 
@@ -28,7 +25,6 @@ def with_builtin(expect):
         logbreak("Getting attribute")
         expect(sample.count) == 4
 
-    @pytest.mark.flaky
     def with_empty_list(expect):
         sample = Sample('abc')
 
@@ -44,7 +40,6 @@ def with_empty_list(expect):
         logbreak("Getting attribute")
         expect(sample.empty_items) == [4.2, "abc"]
 
-    @pytest.mark.flaky
     def with_homogeneous_list(expect):
         sample = Sample('abc')
 
@@ -59,7 +54,6 @@ def with_homogeneous_list(expect):
         logbreak("Getting attribute")
         expect(sample.same_items) == [1, 2, 3]
 
-    @pytest.mark.flaky
     def with_heterogeneous_list(expect):
         sample = Sample('abc')
 
@@ -74,7 +68,6 @@ def with_heterogeneous_list(expect):
         logbreak("Getting attribute")
         expect(sample.mixed_items) == [1, "abc", 3.2]
 
-    @pytest.mark.flaky
     def with_dict(expect):
         sample = Sample('abc')
 

tests/test_custom_converters.py

@@ -2,8 +2,6 @@
 
 from datetime import datetime
 
-import pytest
-
 from datafiles import Missing, converters, datafile
 
 
@@ -31,7 +29,6 @@ def to_python_value(cls, deserialized_data, **_kwargs):
         return datetime.fromisoformat(deserialized_data)
 
 
-@pytest.mark.flaky
 def test_extension(expect):
     @datafile("../tmp/sample.yml")
     class Timestamp:
@@ -47,7 +44,6 @@ class Timestamp:
     expect(ts.dt.day) == 11
 
 
-@pytest.mark.flaky
 def test_extension_with_default(expect):
     @datafile("../tmp/sample.yml")
     class Timestamp:
@@ -63,7 +59,6 @@ class Timestamp:
     expect(ts.dt.day) == 11
 
 
-@pytest.mark.flaky
 def test_registration(expect):
 
     converters.register(datetime, DateTimeConverter)
@@ -82,7 +77,6 @@ class Timestamp:
     expect(ts.dt.day) == 22
 
 
-@pytest.mark.flaky
 def test_registration_with_default(expect):
 
     converters.register(datetime, DateTimeConverter)

tests/test_custom_converters_future.py

@@ -11,7 +11,6 @@
 from .test_custom_converters import MyDateTime
 
 
-@pytest.mark.flaky
 def test_extension(expect):
     @datafile("../tmp/sample.yml")
     class MyObject:

tests/test_extended_converters.py

@@ -38,7 +38,6 @@ def with_float_to_integer(sample, expect):
             """
         )
 
-    @pytest.mark.flaky
     def with_integer_to_float(sample, expect):
         write(
             'tmp/sample.yml',
@@ -73,7 +72,6 @@ def with_single_line(sample, expect):
             """
         )
 
-    @pytest.mark.flaky
     def with_multiple_lines(sample, expect):
         sample.text = '\n'.join(f'Line {i+1}' for i in range(3))
 

tests/test_loading.py

@@ -245,7 +245,6 @@ def with_extra_attributes(sample, expect):
         expect(sample.nested.score) == 3.4
         expect(hasattr(sample.nested, 'extra')).is_(False)
 
-    @pytest.mark.flaky
     def with_multiple_levels(expect):
         @dataclass
         class Bottom:

tests/test_patched_methods.py

@@ -5,8 +5,6 @@
 from dataclasses import dataclass, field
 from typing import Dict, List
 
-import pytest
-
 from datafiles import datafile
 from datafiles.utils import dedent, logbreak, read, write
 
@@ -32,7 +30,6 @@ class SampleWithNesting:
 
 
 def describe_automatic_load():
-    @pytest.mark.flaky
     def with_getattribute(expect):
         sample = Sample()
 
@@ -48,7 +45,6 @@ def with_getattribute(expect):
 
 
 def describe_automatic_save():
-    @pytest.mark.flaky
     def with_setattr(expect):
         sample = Sample()
 
@@ -186,7 +182,6 @@ def with_update(expect):
 
 
 def describe_automatic_load_before_save():
-    @pytest.mark.flaky
     def with_setattr(expect):
         sample = Sample()