Metadata-Version: 2.4
Name: llll-py
Version: 0.1.1
Summary: A basic package for parsing lisp-like linked lists in Python.
Author-email: Felipe Tovar-Henao <felipe.tovar.henao@gmail.com>
License: Copyright (c) 2025 Felipe Tovar-Henao
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
        EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
        MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
        IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
        DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
        OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
        OR OTHER DEALINGS IN THE SOFTWARE.
License-File: LICENSE
Keywords: bach,lisp-like linked lists
Requires-Python: >=3.10
Requires-Dist: typing-extensions
Provides-Extra: dev
Requires-Dist: hatch; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Description-Content-Type: text/markdown

![version](https://img.shields.io/pypi/v/llll-py)
![last_commit](https://img.shields.io/github/last-commit/felipetovarhenao/llll)
![license](https://img.shields.io/pypi/l/llll-py)

# llll

Python support for lisp-like linked lists (_llll_).

## Key Features

- **Read/write operations** in both text (`.txt`) and native (`.llll`) formats.
- **1-based indexing** following the [bach](https://bachproject.net) library and [_bell_](https://felipe-tovar-henao.com/bell-tutorials) language conventions.
- **Element-wise arithmetic** with automatic broadcasting.
- **Flexible mapping** with depth control.
- **Address and key syntax support** for data access and assignment.
- **Fraction support** for exact rational arithmetic.

## Installation

```bash
pip3 install llll-py
```

## Basic Usage

### Creating lllls

```python
from llll import llll

# Atomic values
x = llll(42)      # 42
y = llll("hello") # hello

# Nested lists
z = llll(1, 2, [3, 4], 5)  # 1 2 [ 3 4 ] 5

# From Python objects
data = llll.from_python([1, [2, 3], 4]) # 1 [ 2 3 ] 4
```

### File I/O

```python
# Save to file
l = llll(1, 2, [3, 4])
l.write("data.txt")      # Human-readable format
l.write("data.llll")     # Native llll format

# Load from file
from_txt = llll.read("data.txt")
from_llll = llll.read("data.llll")
print(l == from_txt == from_llll) # True
```

### Indexing

llll uses 1-based indexing by convention:

```python
l = llll(10, 20, [30, 40], 50)

l[1]      # 10
l[-1]     # 50
l[3]      # 30 40
l[3, 2]   # 40 (address-based access)

# Slicing (1-based, inclusive)
l[2:3]    # 20 [ 30 40 ]
```

### Keys

Access and modify lllls via keys:

```python
l = llll(["name", "Alice"], ["age", 33], ["parents", "Bob", "Chloe"])

# Access by key
l["name"]         # "Alice"
l["age"]          # 33
l["parents"]      # "Bob" "Chloe"

# Assignment by key
l['name'] = "John"
l['age'] = 55
l['parents'] = ["Geoffrey", "Ada"]
# [ name John ] [ age 33 ] [parents Geofrrey Ada ]
```

### Arithmetic Operations

Element-wise operations with broadcasting:

```python
l = llll(1, 2, 3)

l + 10              # 11 12 13
l * llll(2, 3, 4)   # 2 6 12
l / 2               # 1/2 1 3/2 (returns Fractions for int division)

# Nested operations
nested = llll([1, 2], [3, 4])
nested + 10      # [ 11 12 ] [ 13 14 ]
```

### Mapping

Apply functions at specific depths:

```python
l = llll(1, [2, 3], [[4, 5], 6])

# Boolean comparison
l.map(lambda x, addr: int(x > 2))
# 0 [ 0 1 ] [ [ 1 1 ] 1 ]

# Apply only at depth 2
l.map(lambda x, addr: x * 10,
      mindepth=2,
      maxdepth=2)
# 1 [ 20 30 ] [ [ 4 5 ] 60 ]
```

The mapping function receives both the value and its address (tuple of indices).

### Utility Methods

```python
l = llll(1, [2.5, 3])

l.depth()         # 2
l.to_python()     # [1, [2.5, 3]]
l.append([4, 5])  # 1 [ 2.5 3 ] [ 4 5 ]
l.extend([4, 5])  # 1 [ 2.5 3 ] 4 5
l.as_float()      # 1.0 [ 2.5 3.0 ] 4.0 5.0
l.as_int()        # 1 [ 2 3 ] 4 5
```

## License

[MIT License](LICENSE) - Copyright © 2025 Felipe Tovar-Henao

## Development setup

Follow these steps if you intend to run and/or build **llll-py** from source.

1. Install [Miniconda](https://www.anaconda.com/download/success?reg=skipped).
2. In the terminal, run:

```sh
conda env create -f environment.yml
conda activate llll
```

To build or publish, run:

```sh
hatch build
hatch publish
```

To run unit tests run:

```sh
pytest tests
```
