foliar 0.4.0
Foliar is a Rust-powered Python library for pretty-printing Python objects.
Requires Python: >=3.8
Keywords: rust, pyo3, pretty-printing

# Foliar

[![PyPI - Version](https://img.shields.io/pypi/v/foliar?style=for-the-badge)](https://pypi.org/project/foliar/)
[![License](https://img.shields.io/github/license/campbellmbrown/foliar?style=for-the-badge)](LICENSE)
[![Deploy](https://img.shields.io/github/actions/workflow/status/campbellmbrown/foliar/deploy.yaml?style=for-the-badge&logo=github&label=Deploy)](https://github.com/campbellmbrown/foliar/actions/workflows/deploy.yaml)
[![Develop](https://img.shields.io/github/actions/workflow/status/campbellmbrown/foliar/develop.yaml?branch=main&style=for-the-badge&logo=github&label=Develop)](https://github.com/campbellmbrown/foliar/actions/workflows/develop.yaml)

![Rust](https://img.shields.io/badge/rust-%23000000.svg?style=for-the-badge&logo=rust&logoColor=white)
![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&style=for-the-badge)

## 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.

- ⚡️ Fast, secure, Rust-powered
- 🐍 Installable via `pip`
- 🧩 Easy to use
- 🙌 Community driven (suggestions and contributions are welcome!)

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:

```bash
pip install foliar
```

## Usage

### Pretty-Printing Objects

To pretty-print objects, simply import `foliar` and create a `Pretty` object:

```python
from foliar import Pretty

pretty = Pretty()
```

Then print any Python data structure using the `Pretty` instance:

```python
@dataclass
class MyClass:
    foo: int
    bar: list[str]

my_object = MyClass(foo=42, bar=["hello", "world"])

pretty.print(my_object)
```

Which produces the following output:

```
MyClass(
    foo=42,
    bar=[
        'hello',
        'world',
    ],
)
```

`print` will print to standard output. `format` can be used to return a formatted string instead:

```python
formatted_string = pretty.format(my_object)
```

#### Configuration

You can customize the number of spaces to use for indentation by passing the `indent` parameter (defaults to 4):

```python
pretty = Pretty(indent=2)
```

### Formatting Bytes

Sometimes it's annoying to see printable characters mixed in with non-printable characters when printing bytes.
Foliar can format bytes to show both printable and non-printable characters as escaped sequences:

```python
import foliar

byte_data = b"Hello, world!\n"

foliar.print_escaped_bytes(byte_data)
```

Which produces the following output:

```
\x48\x65\x6c\x6c\x6f\x2c\x20\x57\x6f\x72\x6c\x64\x21\x0a
```

`format_escaped_bytes` can be used to return a formatted string instead of printing to standard output.

## Examples

See the [examples directory](examples/) for a collection of usage examples.

## Known Issues

Pylint sometimes complains "*No name 'Pretty' in module 'foliar'*" ([E0611:no-name-in-module](https://pylint.readthedocs.io/en/latest/user_guide/messages/error/no-name-in-module.html)).
This is because [Pylint doesn't lint Rust-compiled extensions by default](https://pylint.pycqa.org/en/v2.11.1/technical_reference/c_extensions.html).
This can be fixed by using the [`extension-pkg-allow-list` option](https://pylint.readthedocs.io/en/latest/user_guide/messages/error/no-member.html) in your chosen Pylint configuration.

## Contributing

Contributions are welcome! Please see the [contributing guide](CONTRIBUTING.md) for details.