Skip to main content

An Association List construct

Project description

alistpy

An Association List construct for Python


Install

pip install alistpy


Usage

This simple library provides an AList object that should be a drop-in replacement for most dictionaries, but based on immutable data structures instead.

Cheap to construct, expensive to mutate, as it isn't mutable. Every mutative method actually generates a new AList in it's place.

Example:

import alist

# This is cheap:
a = alist.AList(x=0,y=1)

# This is also cheap:
print(a['x'])

# This is expensive:
a['x'] = 12

Differences to Dictionaries

There's primarily two differences:

  • Mutating the AList is expensive, rather than cheap.

  • Setting the same key multiple times at init time is a ValueError.

That is, Python is happy with:

{'x': 0, 'x': 4}
> {'x': 4}

That sort of behaviour might be unexpected, or cause unexpected problems for the programmer.

So, instead alist:

alist.AList(x=0, x=4)
> Exception raised, ValueError

Issues

Issue tracker.

Anonymous users (those without accounts) are welcome to submit issues.


Explicit API

There isn't one yet.

Check back in future versions. For now, be guided by the tests.


Testing

Install pytest, and then run it.

Currently 31 tests for 21 methods.


License

BSD-3 Clause. See LICENSE.md for more.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for alistpy, version 1.2.0
Filename, size File type Python version Upload date Hashes
Filename, size alistpy-1.2.0-py3-none-any.whl (4.4 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size alistpy-1.2.0.tar.gz (3.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page