Skip to content

Repository files navigation

pycodify

Python source code as a serialization format with automatic import resolution.

Quick Start

from pycodify import Assignment, generate_python_source
from dataclasses import dataclass

@dataclass
class Config:
    name: str = "default"
    value: int = 42

config = Config(name="production", value=100)
code = generate_python_source(Assignment("config", config))
print(code)
# Output:
# from __main__ import Config
# config = Config(name='production', value=100)

Why Python Source?

Format Diffable Inspectable Editable Type-preserving Cross-version
pickle
JSON/YAML
Python source Depends on imported APIs

Binary formats like pickle cannot be diffed, inspected, or edited. Text formats like JSON lose type information. Python source is diffable, inspectable, editable, and type-preserving, but replay still depends on the imported APIs and constructor signatures remaining compatible.

Features

  • Complete Executable Source: Generates imports + code, not just expressions
  • Type-Preserving: Enums, Paths, callables serialize as themselves
  • Collision Handling: Automatic aliasing for name collisions across modules
  • Clean Mode: Omit fields matching defaults for concise output
  • Extensible: Register custom formatters for domain-specific types

Documentation

Explicit mode is the default (clean_mode=False), preserving every field for reproducibility. Pass clean_mode=True only when concise, default-eliding source is desired.

Generated output is executable Python, not a sandboxed data format. Review it before execution and never call exec on source generated from untrusted objects, custom formatters, headers, or edited files.

Full documentation available at pycodify.readthedocs.io

Installation

pip install pycodify

License

MIT

About

No description, website, or topics provided.

Resources

Contributing

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages