why_ciso8601.md

Should I use ciso8601?

ciso8601's goal is to be the world's fastest ISO 8601 datetime parser for Python. However, ciso8601 is not the right choice for all use cases. This document aims to describe some considerations to make when choosing a timestamp parsing library.

• Do you care about the performance of timestamp parsing?
• Do you need strict RFC 3339 parsing?
• Do you need to support Python < 3.11?
• Do you need to support Python 2.7?

Flowchart

graph TD;
    A[Do you care about the performance of timestamp parsing?]
    A--yes-->Y;
    A--no-->C;

    C[Do you need to support Python 2.7?];
    C--yes-->Y
    C--no-->E

    E[Do you need strict RFC 3339 parsing?];
    E--yes-->Y;
    E--no-->H;

    H[Do you need to support Python < 3.11?]
    H--yes-->V;
    H--no-->Z;

    V[Use `backports.datetime_fromisoformat`]
    Y[Use `ciso8601`]
    Z[Use `datetime.fromisoformat`]

Loading

Do you care about the performance of timestamp parsing?

In most Python programs, performance is not a primary concern. Even for performance-sensitive programs, timestamp parsing performance is often a negligible portion of the time spent, and not a performance bottleneck.

Note: Since Python 3.11+, the performance of cPython's datetime.fromisoformat is now very good. See the benchmarks.

If you really, truly want to use the fastest parser, then ciso8601 aims to be the fastest. See the benchmarks to see how it compares to other options.

Do you need strict RFC 3339 parsing?

RFC 3339 can be (roughly) thought of as a subset of ISO 8601. If you need strict timestamp parsing that will complain if the given timestamp isn't strictly RFC 3339 compliant, then ciso8601 has a parse_rfc3339 method.

Do you need to support Python < 3.11?

Since Python 3.11, datetime.fromisoformat supports parsing nearly any ISO 8601 timestamp, and the cPython implementation is very performant.

If you need to support older versions of Python 3, consider backports.datetime_fromisoformat.

Do you need to support Python 2.7?

ciso8601 still supports Python 2.7, and is much faster than other options for this deprecated version of Python.