Make safe input handling effortless: validated prompts, composable validators, and honest security helpers.
Project description
VCoder
Make safe input handling effortless.
VCoder is a zero-dependency Python library for validated input prompts, composable validators, and honest security helpers. It does not claim to magically sanitize all input or to "prevent injection". Instead, it makes the safe path the easy path.
from vcoder import vc
name = vc.text("Name: ")
age = vc.int("Age: ", min=0, max=120)
email = vc.email("Email: ")
password = vc.password("Password: ", min_length=12)
choice = vc.choice("Language: ", ["Python", "Rust", "Go"])
numbers = vc.list("Numbers: ", parser=int)
Every prompt validates, reprompts on failure, supports defaults and optional input, accepts custom validators and custom error messages — so you never write a validation loop by hand.
Why VCoder?
- Pythonic & discoverable. One import (
vc) surfaces everything. - Strongly typed. Fully annotated; passes
mypy --strictandpyright. - Zero dependencies. Standard library only.
- Composable validators.
Validator(MinLength(8), Regex(...), NoControlCharacters()). - Honest security helpers. For paths, filenames, shell, SQL, HTML and passwords — with documented limitations, never misleading guarantees.
Installation
pip install vcoder
From source (development):
git clone https://github.com/bitilia/vcoder
cd vcoder
pip install -e ".[dev]"
Requires Python 3.9+.
Quick tour
Input functions
from vcoder import vc
vc.text("Name: ", min_length=1)
vc.int("Age: ", min=0, max=120)
vc.float("Ratio: ", min=0.0, max=1.0)
vc.decimal("Price: ") # exact, for money
vc.bool("Continue? ") # yes/no
vc.choice("Pick: ", ["a", "b", "c"])
vc.list("CSV: ", parser=int)
vc.json("Payload: ")
vc.date("When: ") # ISO 8601 by default
vc.uuid("Id: ")
vc.email("Email: ")
vc.url("Site: ") # http/https only by default
vc.ip("Addr: ")
vc.port("Port: ")
vc.password("Password: ", min_length=12) # never echoed, never logged
vc.filename("File: ") # rejects reserved/illegal names
vc.path("Path: ", within="/srv/uploads") # blocks traversal
All 26 input types accept the same keyword contract:
default, optional, retries, error_message, validators, reader.
The
reader=keyword lets you inject input (used throughout the tests and in the doctests). In real use you omit it and VCoder reads from the terminal.
Composable validators
from vcoder import Validator, MinLength, Regex, NoControlCharacters, ValidationError
username = Validator(
MinLength(3),
Regex(r"[a-z0-9_]+"),
NoControlCharacters(),
)
username.validate("ada_lovelace") # ok
username.is_valid("x") # False
# Extending is just subclassing:
class EvenNumber(Validator):
def validate(self, value):
if value % 2:
raise ValidationError("must be even", value=value)
Use any validator with any prompt via validators=[...].
Security helpers
from vcoder import vc
# Paths — anchored to a root, traversal-aware (raw, %2e-encoded, unicode).
vc.safe_join("/srv/uploads", user_supplied) # -> Path or UnsafePathError
vc.contains_traversal("../../etc/passwd") # True
# Subprocess — argument lists only, never a shell.
vc.run(["git", "status"])
vc.run_capture(["echo", user_supplied]) # metacharacters are inert
# SQL — parameterized by construction.
query, params = vc.sql.build_select("users", where={"id": 1})
vc.sql.execute(cursor, query, params)
# HTML — context-aware escaping.
vc.html.escape(user_supplied) # for text nodes
vc.html.escape_attribute(user_supplied) # for quoted attributes
# Passwords — configurable strength, optional HIBP check.
vc.validate_password(pw) # PasswordTooWeak on failure
Global configuration
from vcoder import vc
vc.configure(retries=5, strip=True, lowercase=False, logging=True)
What VCoder protects against (and what it does not)
See SECURITY.md for the full, honest breakdown. In short:
- It reduces the risk of path traversal, shell injection, accidental SQL string-building, XSS from untrusted text, and weak passwords.
- It cannot guarantee the absence of any of these. Validation is context-dependent, symlinks and TOCTOU races exist, and the program you invoke may still mishandle its arguments. Use least privilege and defense in depth.
Documentation
Development
pip install -e ".[dev]"
pytest # tests + doctests, 95%+ coverage
mypy # strict type checking
ruff check . # linting
black --check . # formatting
License
MIT © 2026 VCoder contributors.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vcoder-0.1.0.tar.gz.
File metadata
- Download URL: vcoder-0.1.0.tar.gz
- Upload date:
- Size: 56.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4c2b33c8b6ae6bdf4fca43d5c832000b62aa02e73e4b2d0376814a11290ebb7c
|
|
| MD5 |
77b832f941752fe26d862c59642dade2
|
|
| BLAKE2b-256 |
85863038a2428b80495d92cd093f85fc66fccba5ab40e1c4a52f7e610696d889
|
Provenance
The following attestation bundles were made for vcoder-0.1.0.tar.gz:
Publisher:
publish.yml on bitilia/vcoder
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
vcoder-0.1.0.tar.gz -
Subject digest:
4c2b33c8b6ae6bdf4fca43d5c832000b62aa02e73e4b2d0376814a11290ebb7c - Sigstore transparency entry: 2125031566
- Sigstore integration time:
-
Permalink:
bitilia/vcoder@f80fcc4f44a58c00ede30d5003b7e4a795e783e1 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/bitilia
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@f80fcc4f44a58c00ede30d5003b7e4a795e783e1 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file vcoder-0.1.0-py3-none-any.whl.
File metadata
- Download URL: vcoder-0.1.0-py3-none-any.whl
- Upload date:
- Size: 42.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7abde19395ed06f8baf2b01074e83021968c9a9dd0b8b34697cdaf4cec9d2103
|
|
| MD5 |
7b7c453fdca732c5df8411711e5406a8
|
|
| BLAKE2b-256 |
6400dc7e9d5bae8daef4d9df6735aff2cc7fe7e15b917c7bbf139c7a18ea41a0
|
Provenance
The following attestation bundles were made for vcoder-0.1.0-py3-none-any.whl:
Publisher:
publish.yml on bitilia/vcoder
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
vcoder-0.1.0-py3-none-any.whl -
Subject digest:
7abde19395ed06f8baf2b01074e83021968c9a9dd0b8b34697cdaf4cec9d2103 - Sigstore transparency entry: 2125031607
- Sigstore integration time:
-
Permalink:
bitilia/vcoder@f80fcc4f44a58c00ede30d5003b7e4a795e783e1 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/bitilia
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@f80fcc4f44a58c00ede30d5003b7e4a795e783e1 -
Trigger Event:
workflow_dispatch
-
Statement type: