Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

CI Docs Codecov Python Versions Python Wheel Code Style: black PyPI - License

What is Pytest Shell Utilities

“When in doubt, shell out”

—Thomas S. Hatch

This pytest plugin was extracted from pytest-salt-factories. If provides a basic fixture shell which basically uses subprocess.Popen to run commands against the running system on a shell while providing a nice assert’able return class.

Install

Installing pytest-shell-utilities is as simple as:

python -m pip install pytest-shell-utilities

And, that’s honestly it.

Usage

Once installed, you can now use the shell fixture to run some commands and assert against the outcome.

def test_assert_good_exitcode(shell):

    ret = shell.run("exit", "0")
    assert ret.returncode == 0

def test_assert_bad_exitcode(shell):

    ret = shell.run("exit", "1")
    assert ret.returncode == 1

If the command outputs parseable JSON, the shell fixture can attempt loading that output as JSON which allows for asserting against the JSON loaded object.

def test_against_json_output(shell):
   d = {"a", "a", "b": "b"}
   ret = shell.run("echo", json.dumps(d))
   assert ret.data == d

Documentation

The full documentation can be seen here.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest-shell-utilities-1.0.0rc6.tar.gz (92.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pytest_shell_utilities-1.0.0rc6-py3-none-any.whl (44.7 kB view details)

Uploaded Python 3

File details

Details for the file pytest-shell-utilities-1.0.0rc6.tar.gz.

File metadata

  • Download URL: pytest-shell-utilities-1.0.0rc6.tar.gz
  • Upload date:
  • Size: 92.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for pytest-shell-utilities-1.0.0rc6.tar.gz
Algorithm Hash digest
SHA256 ed548e320e19e0fa95cb82fc7279d7a4a246ef08028dbfe2dde392e112a113fd
MD5 64072103337872be03694f65d345d348
BLAKE2b-256 4e6636d4e7f6589d57f2c2c141286e11ea4656dd6d31710bd0ddb2474e787885

See more details on using hashes here.

File details

Details for the file pytest_shell_utilities-1.0.0rc6-py3-none-any.whl.

File metadata

  • Download URL: pytest_shell_utilities-1.0.0rc6-py3-none-any.whl
  • Upload date:
  • Size: 44.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for pytest_shell_utilities-1.0.0rc6-py3-none-any.whl
Algorithm Hash digest
SHA256 c01bea8ddbfbd354338a609ad777443dd7238a6006d83b3a87951bb1ed8062a2
MD5 afc2d3578f3d6220741b4352fb46bc80
BLAKE2b-256 4404ca061d3bd4eddc7437e44ebe9eaeff9ba574f50265352d6dd7dd86ff25c3

See more details on using hashes here.

Release history Release notifications | RSS feed

1.9.7

2 files

1.9.6

2 files

1.9.5

2 files

1.9.4

2 files

1.9.3

2 files

1.9.0

2 files

1.8.0

2 files

1.7.0

2 files

1.6.0

2 files

1.5.0

2 files

1.4.0

2 files

1.3.0

2 files

1.2.1

2 files

1.2.0

2 files

1.1.0

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

This release

1.0.0rc6 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page