Metadata-Version: 2.4
Name: aalign
Version: 1.0.0
Home-page: https://codeberg.org/Zamanhuseyinli/aalign/
License: GPL-3.0-or-later
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: adamlibrary
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python

# Aalign

Fully name: **Adamlibrary.Align**

It is an adamlibrary-based library where you can make real alignment calculations in Python. You cannot directly guarantee the real alignment value in Python, other than the value it produces at runtime, but aalign offers a sample aligment library abstraction using the adamlibrary memreplication_cutline modules that will guarantee this! This abstraction is an example of the use of adamlibrary. Anyone who wants to access raw pointer can develop methods to control memory interaction, real memreplication cutline, directly access raw pointer, list the memory string like aalign, there are no restrictions, all control and responsibility is on you.

## Usage

### Context manager

```python
from aalign import AlignedBuffer

with AlignedBuffer(size=4096, alignment=64) as buf:
    print(buf.size, buf.alignment, buf.usable_size)
# with block output auto free()
```

### Lifetime handling

```python
from aalign import AlignedBuffer

buf = AlignedBuffer(size=256, alignment=32)
try:
    print(buf.usable_size)
finally:
    buf.free()  # idempotent, second double calling not is problem
```

### posix_memalign controlling

```python
buf = AlignedBuffer(size=128, alignment=16, strategy="posix_memalign")
```

### Free late using (error is)

```python
from aalign import AlignedBuffer, AlreadyFreedError

buf = AlignedBuffer(size=64, alignment=16)
buf.free()

try:
    buf.usable_size
except AlreadyFreedError as e:
    print(e)  # this AlignedBuffer has already been freed
```

### Context proccesing - reset

```python
from aalign import zero_buffer

data = bytearray(b"\xAA" * 32)
zero_buffer(data)
print(data.hex())  # full 00
```

### Context processing - byte finder

```python
from aalign import find_byte

data = bytearray(b"hello_world")
result = find_byte(data, ord("w"))
print(result)  # b'world'
```

### CLI using

```bash
python3 -m aalign
python3 -m aalign --size 128 4096 --alignment 16 64
```
