Quillstack Dotenv
Reads a .env file. Values keep the type they plainly have, and nothing is expanded unless you
ask for it.
Why this exists
It does not expand ${SOMETHING}, and that is on purpose
Most .env libraries resolve one value from another out of the box. This one does not, and the
model it follows is JavaScript's.
dotenv for Node is the most installed .env library anywhere, and it does not interpolate.
Nor does dotenv-java. In that world, building values from other values is a second package,
because it is a second decision: it turns a list of pairs into a small language, with escaping
and ordering and undefined names to settle.
The same choice is made here, and by
quillstack/dotenv in PHP. A .env file which quietly
became a template is a .env file you have to read twice.
A value keeps the type it has
if settings["APP_DEBUG"]:
...
Read as text, false is a non-empty string and therefore true. That is a bug which looks like
working code, and it is the reason the values are typed rather than handed back as strings.
The values do not go into os.environ
os.environ holds strings and nothing else, so a port put there comes back '5432' and a
false comes back true — the exact thing the typing avoids. What is read stays where its types
survive, and export() is there for when something else needs the environment set.
Requirements
- Python 3.11 or newer
Installation
pip install quillstack-dotenv
Usage
APP_DEBUG=true
APP_NAME=quillstack
DB_PORT=5432
from quillstack.dotenv import Dotenv
settings = Dotenv(".env").load()
settings["APP_DEBUG"] # True, a boolean
settings["APP_NAME"] # 'quillstack'
settings["DB_PORT"] # 5432, a number
It is a Mapping, so len(), in, iteration and unpacking all work on it.
Saying you meant the text
Quote it:
DB_PORT_TEXT="5432"
settings["DB_PORT_TEXT"] # '5432', a string
Default values
settings.get("MISSING", "a default") # 'a default'
settings.get("MISSING") # None
Required keys
Where there is no sensible default, say so and find out at boot rather than at midnight:
settings.required("DATABASE_HOST")
ValueNotSetError: Value not set for key: DATABASE_HOST
Comments after a value
A # starts a comment where a shell would treat it as one — after whitespace, and outside
quotes:
COMMENTED=5432 # the default
PASSWORD=hunter2#7
QUOTED="a # inside quotes"
settings["COMMENTED"] # 5432
settings["PASSWORD"] # 'hunter2#7'
settings["QUOTED"] # 'a # inside quotes'
A parser which took every # would turn a password into a shorter password and say nothing
about it.
Nothing is expanded
URL=https://${APP_NAME}.org
settings["URL"] # 'https://${APP_NAME}.org'
Setting the environment anyway
For the sake of something else which reads os.environ directly:
settings.export() # leaves what is already set alone
settings.export(override=True) # does not
What goes out is text: True is exported as true, because that is what it was in the file and
what another reader expects to find. A deployment which set a variable meant it, which is why
what is already there wins unless you say otherwise.
Benchmark
Against python-dotenv 1.2.3, on Python 3.13.5, reading the same 23-pair file. Interleaved
runs, median of five.
Read what each one does before reading the numbers, because they are not doing the same work — in both directions:
quillstack-dotenv |
python-dotenv |
|
|---|---|---|
A=true |
True |
'true' |
B=5432 |
5432 |
'5432' |
C=${A} |
'${A}' |
'true' — expanded |
| multi-line values | no | yes |
${MISSING:-fallback} |
no | yes |
| escapes inside quotes | no | yes |
So one of them reads types and the other builds a small language. Now the numbers:
| Per load | Relative | |
|---|---|---|
| quillstack-dotenv | 32.0 µs | — |
| python-dotenv | 459.2 µs | 14× |
That is not the number that matters, because a .env file is read once. What an application
pays is the whole thing — importing the library and loading the file, over 25 process starts:
| Whole process | Of which is the library | |
|---|---|---|
bare python, importing nothing |
14.49 ms | — |
| quillstack-dotenv | 19.38 ms | 4.9 ms |
| python-dotenv | 25.84 ms | 11.4 ms |
About 70% of that is Python starting, and no .env library can do anything about it. Choosing
between these two moves a boot by six milliseconds.
Being faster because you do less is not being faster. If you want multi-line values, defaults
inside ${…}, or escapes, python-dotenv has them and this does not — and it is the more
popular library in this ecosystem by a wide margin, which is worth knowing when you pick.
Tests
uv run pytest
Static analysis
uv run ruff check --no-cache
uv run mypy
--no-cache on purpose: a cached ruff result once said a Quillstack package was clean while CI
said it was not.
Against the standard
uv run quillstack-standards .
The rest of Quillstack
This is one component of Quillstack, the same way of building APIs in more than one language.
- quillstack-standards — what keeps every package the same shape
- quillstack/dotenv — the same decisions in PHP
- quillstack/dotenv-expand — values built from other values, where you want them
License
MIT — see LICENSE.
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 quillstack_dotenv-0.1.1.tar.gz.
File metadata
- Download URL: quillstack_dotenv-0.1.1.tar.gz
- Upload date:
- Size: 53.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d9ed26f215f770d2811653e3744a668e4a0243e23beb95e2073937f81552d225
|
|
| MD5 |
6524b1e8f36db295e5e6c27b0b78d27f
|
|
| BLAKE2b-256 |
58af4aa461cca25c1e998c453d2691d3015a8378bf6f493b4c021d517df62581
|
Provenance
The following attestation bundles were made for quillstack_dotenv-0.1.1.tar.gz:
Publisher:
release.yml on quillstack-py/dotenv
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
quillstack_dotenv-0.1.1.tar.gz -
Subject digest:
d9ed26f215f770d2811653e3744a668e4a0243e23beb95e2073937f81552d225 - Sigstore transparency entry: 2591441379
- Sigstore integration time:
-
Permalink:
quillstack-py/dotenv@0db3c8cba7f6fb29f26db96ab6c1a928310e0108 -
Branch / Tag:
refs/tags/v0.1.1 - Owner: https://github.com/quillstack-py
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@0db3c8cba7f6fb29f26db96ab6c1a928310e0108 -
Trigger Event:
push
-
Statement type:
File details
Details for the file quillstack_dotenv-0.1.1-py3-none-any.whl.
File metadata
- Download URL: quillstack_dotenv-0.1.1-py3-none-any.whl
- Upload date:
- Size: 9.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
574edce908b10e8eba3921cac2479140c9bec3e0477023c98fd113bbef536e0c
|
|
| MD5 |
8a2222e7cb836fb53b4c5eb3712c5a38
|
|
| BLAKE2b-256 |
2cedcdc3259d2e204210d7b46d6eb98a0ebde0f46b6f905f85b5ebd229c259cf
|
Provenance
The following attestation bundles were made for quillstack_dotenv-0.1.1-py3-none-any.whl:
Publisher:
release.yml on quillstack-py/dotenv
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
quillstack_dotenv-0.1.1-py3-none-any.whl -
Subject digest:
574edce908b10e8eba3921cac2479140c9bec3e0477023c98fd113bbef536e0c - Sigstore transparency entry: 2591441609
- Sigstore integration time:
-
Permalink:
quillstack-py/dotenv@0db3c8cba7f6fb29f26db96ab6c1a928310e0108 -
Branch / Tag:
refs/tags/v0.1.1 - Owner: https://github.com/quillstack-py
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@0db3c8cba7f6fb29f26db96ab6c1a928310e0108 -
Trigger Event:
push
-
Statement type: