1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
# CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## Project
FlatDict is a single-module Python library providing `FlatDict` and `FlatterDict` classes that flatten nested dictionaries into single-level dicts with delimited keys (e.g., `{"foo:bar": "baz"}`). `FlatterDict` additionally flattens lists, tuples, and sets. No runtime dependencies.
## Commands
```bash
# Setup dev environment
uv sync
# Run tests
uv run coverage run # runs pytest under coverage
uv run coverage report # print coverage summary
# Run a single test
uv run pytest tests.py::FlatDictTests::test_method_name
# Lint
uv run ruff check .
uv run ruff format --check .
```
## Architecture
Package library — all code lives in `flatdict/__init__.py`, all tests in `tests.py`.
- `FlatDict(MutableMapping)` — core class, flattens nested dicts using a configurable delimiter (default `:`). Uses `maxsplit=1` on delimiter to resolve composite keys one level at a time.
- `FlatterDict(FlatDict)` — extends FlatDict to also flatten lists/tuples/sets using enumerated string indices, storing `original_type` to reconstruct via `as_dict()`.
## Lint/Style Config
Ruff config is in `pyproject.toml`.
|
