with open('file.json', 'w', encoding='utf-8') as f: json.dump

Standard Library Idioms

Meaning

This pattern opens a file for writing and serializes a Python object to JSON using the json module. It solves the problem of manually managing file handles and ensuring proper closure, which can lead to resource leaks. You reach for it whenever you need to persist structured data to a JSON file safely.

Primary Function

File I/O and serialization

Communicative Purpose

Persist a data structure to disk in JSON format.

Pattern

with open(filename, mode, encoding=encoding) as file: json.dump(obj, file)

Core Structure

with open(..., ..., encoding=...) as ...: json.dump(..., ...)

Função primária

File I/O and serialization

Propósito comunicativo

Persist a data structure to disk in JSON format.

Situações de gatilho

Configuration management: saving application settings to a JSON file; Data export: writing query results to a .json file for downstream processing; Logging: persisting structured log entries to a file.

Contextos

General Python scripts, CLI tools, data processing pipelines, web back‑ends that need to store JSON files.

Padrão

with open(filename, mode, encoding=encoding) as file: json.dump(obj, file)

Estrutura central

with open(..., ..., encoding=...) as ...: json.dump(..., ...)

Slots de substituição

filename: path string, mode: 'w' or 'a', encoding: charset string, file_handle: identifier, obj: serializable Python object, json_file_handle: identifier for json.dump (often same as file_handle)

Colocados típicos

json.dump
json.load
pathlib.Path
ensure_ascii=False
indent=4

Substituições comuns

json.dumps + file.write
pathlib.Path().write_text(json.dumps(obj))
pandas.DataFrame.to_json for tabular data

Erros comuns

Opening file without proper encoding; forgetting to import json; overwriting existing file unintentionally; not handling exceptions that may arise during dumping.

Similar / contraste

pickle.dump for binary serialization (different format); yaml.safe_dump for YAML output (different library).

Interferências

Coming from JavaScript: assuming JSON.stringify works the same; from C: forgetting to import the json module.

Família do chunk

File context manager
JSON serialization
resource management

Nuance

For large objects consider custom JSONEncoder or streaming; avoid writing to the same file you are reading from; set ensure_ascii=False for non‑ASCII characters.

Efeito pragmático

Guarantees the file is closed even on error; makes serialization concise and readable.

Dica de memória

JSON file with 'with open' context manager

Nota

Ensure the object is JSON serializable and import the json module before use.

Upgrade path

json.dump(obj, f, indent=4, ensure_ascii=False) for pretty printing, or use the orjson library for faster serialization.

Frequência: HighFormulaicidade: Semi-fixedTipo de construção: context managerPrioridade de aquisição: Active recallPrioridade de output: BothTag de espaçamento: Short-term

Examples

import json config = { "host": "localhost", "port": 8080, "debug": True } with open('config.json', 'w', encoding='utf-8') as f: json.dump(config, f, ensure_ascii=False, indent=2)

import json records = [ {"id": 1, "name": "Alice"}, {"id": 2, "name": "Bob"}, {"id": 3, "name": "Charlie"} ] with open('records.json', 'w', encoding='utf-8') as f: json.dump(records, f, ensure_ascii=False, indent=4)

import json from pathlib import Path data_path = Path('data') / 'output.json' payload = {"status": "ok", "items": []} with data_path.open('w', encoding='utf-8') as f: json.dump(payload, f, ensure_ascii=False)