Skip to content

Make PathFormatStore doctest hermetic (no /tmp walk) #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thorwhalen merged 2 commits into from
Oct 13, 2026
Merged

Make PathFormatStore doctest hermetic (no /tmp walk) #99

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8bb6606
Make PathFormatStore doctest hermetic (fresh mkdtemp roots, no /tmp w…
thorwhalen Oct 13, 2026
f59aead
PathFormatStore doctest: write second store's files to its own dir; c…
thorwhalen Oct 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 11 additions & 20 deletions py2store/stores/local_store.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,26 +46,15 @@ class PathFormatStore(PathFormatPersister, Persister):
"""
Local file store using templated relative paths.

>>> from tempfile import gettempdir
>>> import os
>>> import tempfile
>>>
>>> def write_to_key(fullpath_of_relative_path, relative_path, content): # a function to write content in files
... with open(fullpath_of_relative_path(relative_path), 'w') as fp:
... fp.write(content)
>>>
>>> # Preparation: Make a temporary rootdir and write two files in it
>>> rootdir = os.path.join(gettempdir(), 'path_format_store_test' + os.sep)
>>> if not os.path.isdir(rootdir):
... os.mkdir(rootdir)
>>> # recreate directory (remove existing files, delete directory, and re-create it)
>>> for f in os.listdir(rootdir):
... fullpath = os.path.join(rootdir, f)
... if os.path.isfile(fullpath):
... os.remove(os.path.join(rootdir, f))
>>> if os.path.isdir(rootdir):
... os.rmdir(rootdir)
>>> if not os.path.isdir(rootdir):
... os.mkdir(rootdir)
>>> # Preparation: Make a fresh temporary rootdir (private to this doctest)
>>> rootdir = tempfile.mkdtemp() + os.sep
>>>
>>> filepath_of = lambda p: os.path.join(rootdir, p) # a function to get a fullpath from a relative one
>>> # and make two files in this new dir, with some content
Expand Down Expand Up @@ -111,18 +100,20 @@ class PathFormatStore(PathFormatPersister, Persister):
>>> # but if we make an obj source to only take files whose extension is '.txt'...
>>> s = PathFormatStore(path_format=rootdir + '{}.txt')
>>>
>>> rootdir_2 = os.path.join(gettempdir(), 'obj_source_test_2') # get another rootdir
>>> if not os.path.isdir(rootdir_2):
... os.mkdir(rootdir_2)
>>> rootdir_2 = tempfile.mkdtemp() + os.sep # get another (fresh) rootdir
>>> filepath_of_2 = lambda p: os.path.join(rootdir_2, p)
>>> # and make two files in this new dir, with some content
>>> write_to_key(filepath_of, 'this.txt', 'this')
>>> write_to_key(filepath_of, 'that.txt', 'blah')
>>> write_to_key(filepath_of, 'the_other.txt', 'bloo')
>>> write_to_key(filepath_of_2, 'this.txt', 'this')
>>> write_to_key(filepath_of_2, 'that.txt', 'blah')
>>> write_to_key(filepath_of_2, 'the_other.txt', 'bloo')
>>>
>>> ss = PathFormatStore(path_format=rootdir_2 + '{}.txt')
>>>
>>> assert s != ss # though pointing to identical content, o and oo are not equal since the paths are not equal!
>>>
>>> import shutil
>>> for d in (rootdir, rootdir_2): # clean up the temporary dirs
... shutil.rmtree(d)
"""

pass
Expand Down
Loading