foliar 0.2.0

Foliar is a Rust-powered library for pretty-printing Python objects.

Foliar

Overview

foliar [foh-lee-er]

adjective: of, relating to, or having the nature of a leaf or leaves.

Are you sick of your Python prints looking like a tangled mess of nested dictionaries and lists, all on one line? Foliar serves as a simple tool to pretty-print complex Python data structures, making them easier to read at a glance.

For example, the following print is difficult to read:

ClassA(simple_bool=True, class_list=[ClassB(simple_int=42, simple_str='Hello,'), ClassB(simple_int=7, simple_str='world!')], simple_dict={'key1': 1, 'key2': 2})

With foliar, the same print becomes much more readable:

ClassA(
    simple_bool=True,
    class_list=[
        ClassB(
            simple_int=42,
            simple_str='Hello,',
        ),
        ClassB(
            simple_int=7,
            simple_str='world!',
        ),
    ],
    simple_dict={
        'key1': 1,
        'key2': 2,
    },
)

Installation

Foliar can be installed via pip:

pip install foliar

Usage

To use foliar, simply import it and create a Pretty object:

from foliar import Pretty

pretty = Pretty()
pretty.print("Hello, World!")

You can customize the number of spaces to use for indentation by passing the indent parameter (defaults to 4):

pretty = Pretty(indent=2)

Development

maturin is used to build and manage the Python package. To run the package in your development environment, use:

maturin develop

Code Quality

To lint Rust code, run:

cargo clippy --fix --allow-dirty -- -W clippy::pedantic

To format Rust code, run:

cargo fmt

To lint Python code, run:

ruff check

To format Python code, run:

ruff format

To type check Python code, run:

mypy .