pytestify
A tool to automatically change unittest to pytest. Similar to unittest2pytest, but with a few more features and written using AST and tokenize, rather than lib2to3.
Big thanks to pyupgrade, which this project has learned from.
Installation
pip install pytestify
Usage
pytestify path/to/file.py
or
pytestify path/to/folder/
Optional arguments
Please read over all changes that pytestify makes. It's a new package, so there are bound to be issues.
Implemented features
Test class names
Remove TestCase parent class, and make sure tests start with Test. We are keeping the test classes themselves, but you can remove them manually.
class TestThing(unittest.TestCase): # class TestThing:
class TestThing(TestCase, ClassB): # class TestThing(ClassB):
class ThingTest(unittest.TestCase): # class TestThing:
class Thing(unittest.TestCase): # class TestThing:
Setup / teardowns
def setUp(self): # def setup_method(self):
def tearDown(self): # def teardown_method(self):
def setUpClass(self): # def setup_class(self):
def tearDownClass(self): # def teardown_class(self):
Asserts
Rewrite unittest assert methods using the assert keyword.
# asserting one thing
self.assertTrue(a) # assert a
self.assertFalse (a) # assert not a
self.assertIsNone(a) # assert a is None
self.assertIsNotNone(a) # assert a is not None
# asserting two things
self.assertEqual(a, b) # assert a == b
self.assertNotEqual(a, b) # assert a != b
self.assertIs(a, b) # assert a is b
self.assertIsNot(a, b) # assert a is not b
self.assertIn(a, b) # assert a in b
self.assertNotIn(a, b) # assert a not in b
self.assertListEqual(a, b) # assert a == b
self.assertDictEqual(a, b) # assert a == b
self.assertSetEqual(a, b) # assert a == b
self.assertGreater(a, b) # assert a > b
self.assertLess(a, b) # assert a < b
self.assertGreaterEqual(a, b) # assert a >= b
self.assertLessEqual(a, b) # assert a <= b
self.assertRegex(a, b) # assert a.search(b)
self.assertNotRegex(a, b) # assert not a.search(b)
self.assertAlmostEqual(a, b)
# assert a == pytest.approx(b)
self.assertAlmostEqual(a, b, places=2)
# assert a == pytest.approx(b, abs=0.01)
self.assertAlmostEquals(a, b, delta=2)
# assert a == pytest.approx(b, abs=2)
# improves the assert if reasonable
self.assertEqual(a, None) # assert a is None
self.assertEqual(a, True) # assert a is True
# error messages
self.assertTrue(a, msg='oh no!') # assert a, 'oh no!'
Multi-line asserts
Since assert (a == b, 'err') is equivalent to asserting a tuple, and thus is always True.
self.assertEqual( # assert a == \
a, # b
b,
)
self.assertEqual( # assert a == \
a, # b, \
b, # 'oh no!'
msg='oh no!'
)
camelCase to snake_case
Disable this behavior with --keep-method-casing
def testThing(self): # def test_thing(self):
def testHTTPThing(self): # def test_httpthing(self):
assertCountEqual
The assertCountEqual rewrite is risky, so opt-in with pytest path/to/file --with-count-equal.
self.assertItemsEqual(a, b) # assert sorted(a) == sorted(b)
self.assertCountEqual(a, b) # assert sorted(a) == sorted(b)
Note that pytest has no version of either of these methods. See this thread for more information. You can also use unittest's implementation.
Exceptions
self.assertRaises(OSError) # pytest.raises(OSError)
self.assertWarns(OSError) # pytest.warns(OSError)
with self.assertRaises(OSError) as e: # with pytest.raises(OSError) as e
with self.assertWarns(OSError) as e: # with pytest.warns(OSError) as e
Skipping / Expecting failure
# decorated
@unittest.skip('some reason') # @pytest.mark.skip('some reason')
@unittest.skipIf(some_bool) # @pytest.mark.skipif(some_bool)
@unittest.skipUnless(some_bool) # @pytest.mark.skipif(not some_bool)
@unittest.expectedFailure # @pytest.mark.xfail
# not decorated
unittest.skip('some reason') # pytest.skip('some reason')
unittest.skipTest('some reason') # pytest.skip('some reason')
unittest.fail('some reason') # pytest.fail('some reason')
Metadata
Release files for pytestify 1.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pytestify-1.5.0.tar.gz | 13.3 kB | Without provenance | Details for pytestify-1.5.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pytestify-1.5.0-py3-none-any.whl | Python 3 | none | any | Details for pytestify-1.5.0-py3-none-any.whl |
Total release size: 27.8 kB
Release files / pytestify-1.5.0.tar.gz
| Download URL | pytestify-1.5.0.tar.gz |
|---|---|
| Size | 13.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7a144c30f3a353875e3c63724f3f5eb562946dcb7b9619b6fcd004f4973985a8
|
|
BLAKE2b-256 checksum How to use checksums |
412e0a76b242e7c67a542c86657d01d7088faf6faaaab99b7184603b51e5c482
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.3
|
Release files / pytestify-1.5.0-py3-none-any.whl
| Download URL | pytestify-1.5.0-py3-none-any.whl |
|---|---|
| Size | 14.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
acee4a3c40f4c7b3ce40007097d9e01088ae42dbbfbe254428e97033073aa119
|
|
BLAKE2b-256 checksum How to use checksums |
f795a9b23475f6086febba0ffd4b1560ede1fd98d3b8f219216bea479bd16e99
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.3
|
Security for pytestify 1.5.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.