Skip to main content

shellsafe

Run shell commands safely using Python 3.14 template strings. Values can never turn into commands.

from shellsafe import run

message = get_user_input()          # "fix; rm -rf ~"
run(t"git commit -m {message}")
# argv: ["git", "commit", "-m", "fix; rm -rf ~"]
# one command; the scary text is just an argument

Why this package exists

Python 3.14 added template strings (PEP 750). Now Python keeps your fixed text and your values separate at the language level.

Shell commands are the first place people want to use this. That is because f-strings inside shell commands have caused real security bugs for ten years:

subprocess.run(f"git commit -m {message}", shell=True)
# if message = "fix; rm -rf ~"  ->  two commands run. The second one is bad.

Python planned to solve this officially (PEP 787), but that PEP was deferred to at least Python 3.15. So today there is no standard way to run shell commands safely with templates. This package fills that gap.

Install

pip install shellsafe

Needs Python 3.14 or newer.

How to use

Run a command. Your values always stay one argument each. run() never invokes a shell, so injection is impossible on any platform:

from shellsafe import run

run(t"mkdir {path}")
run(t"docker build -t {tag} .", check=True, timeout=300)

Get the output as text:

from shellsafe import capture

res = capture(t"grep {pattern} {file}")
print(res.stdout, res.returncode)

Need pipes? Works on Linux and macOS. Your values are quoted safely first:

from shellsafe import shx

shx(t"cat {file} | wc -l")

Want to see exactly what will run?

from shellsafe import plan

print(plan(t"git commit -m {message}"))
# argv: ["git","commit","-m","fix; rm -rf ~"]

Safety rules

Case What happens
Any value you pass becomes one argument, exactly as given
Value used as the program name error: program names must be written as fixed text
Shell features on Windows error: we cannot make Windows safe this way, so we say no
RAW() misuse error: one value only, used as-is, no nesting

RAW(...) marks content you have already made safe by hand. It is loud and easy to find in code review, so trust is never hidden.

Find old dangerous patterns

Already have code using f-strings in shell commands? The scanner finds them:

shellsafe audit src/

It detects f-strings passed to os.system, subprocess.run(shell=True), and other shell executors. Get machine-readable output:

shellsafe audit src/ --json

Filter by severity:

shellsafe audit src/ --severity warning

Limits

  • Shell features (pipes, redirections) work on Linux and macOS only. Windows supports plain commands only.
  • run() refuses templates that contain shell metacharacters. Use shx() for those.
  • Byte values are rejected. Decode them first.
  • We keep your command safe to build and run. Testing what your command does is still your job.

Needs

  • Python 3.14 or newer
  • Linux, macOS, Windows (pipes work on Linux and macOS only)

More

License: MIT

Download files

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

Source Distribution

shellsafe-0.3.1.tar.gz (20.1 kB view details)

Uploaded Source

Built Distribution

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

shellsafe-0.3.1-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

Details for the file shellsafe-0.3.1.tar.gz.

File metadata

  • Download URL: shellsafe-0.3.1.tar.gz
  • Upload date:
  • Size: 20.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for shellsafe-0.3.1.tar.gz
Algorithm Hash digest
SHA256 90739d8039d24ca5430a03228f86776cb9b35d4dc6d13b29bfb4060114ec0b5d
MD5 d880742607bec481e4c617d6cb678643
BLAKE2b-256 d7412d53c2727a7eed2c63a42098e1e69ff8b9426db0acad74f08a837939fa75

See more details on using hashes here.

Provenance

The following attestation bundles were made for shellsafe-0.3.1.tar.gz:

Publisher: release.yml on rahulXs/shellsafe

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file shellsafe-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: shellsafe-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 14.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for shellsafe-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 91b27ceab9c920657582e8fa07700895f597f5fa7965f1f189f3e1649a213bcc
MD5 db690260f4cd57774d9977cb9a5582ad
BLAKE2b-256 e9e31cde406756a417a7500d286efde55bf4a2683f63f3335ec583bac409a7b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for shellsafe-0.3.1-py3-none-any.whl:

Publisher: release.yml on rahulXs/shellsafe

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.3.2

2 files

This release

0.3.1 This release

2 files

0.3.0

2 files

0.2.0

2 files

0.1.1

2 files

0.1.0

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