An improved version of the List type
Project description
listo
Listo is an enhanced version of the list
type that aims to do the following:
- Make behavior more consistent. No more methods with "in-place" changes. Every method call returns a value
- Adds methods that are missing from the
list
type. For example,listo
has afirst
method that returnsself[0]
- A list of arguments passed in will be converted to a
listo
object, but a single argument that is an iterator will be unpacked into alisto
object. This is useful for when you want to pass in a generator or other iterator into a function that expects a list
Usage
First install it via pip, poetry, or whatever you use
pip install listo
Then use it in your code
from listo import listo
lst = listo(1, 2, 3)
assert lst.first() == 1
assert lst.last() == 2
Usage: How listo handles initial arguments
For arguments passed in, it just converts them to a listo
object
lst = listo(1, 2, 3)
assert lst == [1, 2, 3]
lst2 = listo([1, 2, 3]) # list is unpacked
assert lst2 == [1, 2, 3]
lst3 = listo((1, 2, 3)) # tuple is converted and unpacked
assert lst3 == [1, 2, 3]
lst4 = listo([1, 2, 3], (1, 2)) # Two args mean nothing is unpacked
assert lst4 == [[1, 2, 3], (1, 2)]
This is different from standard Python iterator behavior.
Development
Install the package in editable mode with test dependencies:
pip install -e '.[test]'
Code quality
make lint
Testing
make test
Releasing on PyPI
- Update the
version
inpyproject.toml
. We use semantic versioning - Create and merge a PR branch called
release-x.x.x
- Pull from `main``
- At the command line, run
make tag
- Go to tags page, choose the most recent tag, and click
Draft a new release
Building the project locally
Go to the project root
pip install --upgrade build
python -m build
Test the project, forcing reinstall if necessary
pip install dist/listo-0.1.0-py3-none-any.whl --force-reinstall
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
listo-0.5.0.tar.gz
(4.2 kB
view hashes)
Built Distribution
listo-0.5.0-py3-none-any.whl
(3.7 kB
view hashes)