api.rst

py

natsort

natsort API

Standard API

~natsort.natsorted

natsorted

The ~natsort.ns enum

ns

~natsort.natsort_key

natsort_key

~natsort.natsort_keygen

natsort_keygen

Convenience Functions

~natsort.realsorted

realsorted

~natsort.humansorted

humansorted

~natsort.index_natsorted

index_natsorted

~natsort.index_realsorted

index_realsorted

~natsort.index_humansorted

index_humansorted

~natsort.order_by_index

order_by_index

Help With Bytes On Python 3

The official stance of natsort is to not support bytes for sorting; there is just too much that can go wrong when trying to automate conversion between bytes and str. But rather than completely give up on bytes, natsort provides three functions that make it easy to quickly decode bytes to str so that sorting is possible.

decoder

as_ascii

as_utf8

Help With Creating Function Keys

If you need to create a complicated key argument to (for example) natsorted that is actually multiple functions called one after the other, the following function can help you easily perform this action. It is used internally to natsort, and has been exposed publicly for the convenience of the user.

chain_functions

If you need to be able to search your input for numbers using the same definition as natsort, you can do so using the following function. Given your chosen algorithm (selected using the ~natsort.ns enum), the corresponding regular expression to locate numbers will be returned.

numeric_regex_chooser