Skip to content

HACKING.rst: add strpath gotcha to testing gotchas section #446

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
OddBloke merged 2 commits into from
Jun 22, 2020
Merged

HACKING.rst: add strpath gotcha to testing gotchas section #446

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d8f52b
HACKING.rst: add strpath gotcha to testing gotchas section
OddBloke Jun 19, 2020
ac2c849
Merge branch 'master' into doc
mitechie Jun 22, 2020
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
8 changes: 8 additions & 0 deletions HACKING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,14 @@ The following guidelines should be followed:
* ``tmpdir_factory``
* ``tmpdir``

* On xenial, the objects returned by the ``tmpdir`` fixture cannot be
used where paths are required; they are rejected as invalid paths.
You must instead use their ``.strpath`` attribute.

* For example, instead of
``util.write_file(tmpdir.join("some_file"), ...)``, you should
write ``util.write_file(tmpdir.join("some_file").strpath, ...)``.

* Variables/parameter names for ``Mock`` or ``MagicMock`` instances
should start with ``m_`` to clearly distinguish them from non-mock
variables
Expand Down