Welcome to fastcore
Python is a powerful, dynamic language. Rather than bake everything into the language, it lets the programmer customize it to make it work for them. fastcore uses this flexibility to add to Python features inspired by other languages we’ve loved, mixins from Ruby, and currying, binding, and more from Haskell. It also adds some “missing features” and cleans up some rough edges in the Python standard library, such as simplifying parallel processing, and bringing ideas from NumPy over to Python’s list type.
Here are some tips on using fastcore:
- Use
from fastcore.module import *freely. fastcore’s modules are built to be safe for wildcard imports. - Use
Lin place oflist.Lbehaves like a list, with extra indexing options, method chaining and more methods. - Add methods to existing classes, including built-ins, with the
@patchdecorator instead of subclassing. - In
__init__methods, callstore_attr()to set multiple attributes at once instead of assigning each one. - Apply the
delegatesdecorator to show a function’s real parameters in place of**kwargs, for IDEs and generated documentation. - Use fastcore’s versions of
ThreadPoolExecutorandProcessPoolExecutorfor simpler concurrent processing. - Prefer fastcore’s test functions, such as
test_eq,test_neandtest_close, for assertions that read clearly and give informative failures. - fastcore extends
pathlib.Pathwith methods such asls()andread_json(). - Convert between dictionaries and objects with attribute access using
dict2objandobj2dict. - Write in a functional style with tools such as
compose,mapsandfilter_ex. - Document parameters and return values with
docments, using source comments orAnnotatedmetadata for generated APIs.MarkdownRenderershows the effective signature and keeps usage sections such as Notes, Raises and Examples. - Apply the
timed_cachedecorator to add time-based expiry to the standardlru_cache. - Turn Python functions into command-line interfaces with
fastcore.script.
For example, L is a drop-in replacement for list with extra superpowers:
x = L(1,2,3,4)
test_eq(x[[0,3]], [1,4]) # index with a collection
test_eq(x.map(lambda o:o*2), [2,4,6,8])
test_eq(x.filter(lambda o:o>2), [3,4])
x += [5]
test_eq(x.unique(), [1,2,3,4,5])
Tutorials
- Quick tour: A quick tour of a few highlights from fastcore.
- fastcore: an underrated Python library: A tour of some of the features of fastcore.
- API list: A succinct list of all functions and methods in fastcore.
Getting started
To install fastcore run: conda install fastcore -c fastai (if you use Anaconda, which we recommend) or pip install fastcore. For an editable install, clone this repo and run: pip install -e ".[dev]". fastcore is tested to work on Ubuntu, macOS and Windows (versions tested are those shown with the -latest suffix here).
fastcore contains many features, including:
fastcore.test: Simple testing functionsfastcore.foundation: Mixins, delegation, composition, and morefastcore.xtras: Utility functions to help with functional-style programming, parallel processing, and morefastcore.xml: HTML withft, and case-preserving, namespace-aware XML withEfactories
To get started, we recommend you read through the fastcore tour.
Contributing
After you clone this repository, please run nbdev_install_hooks in your terminal. This sets up git hooks, which clean up the notebooks to remove the extraneous stuff stored in the notebooks (e.g. which cells you ran) which causes unnecessary merge conflicts.
To run the tests in parallel, launch nbdev_test.
Before submitting a PR, check that the local library and notebooks match.
- If you made a change to the notebooks in one of the exported cells, you can export it to the library with
nbdev_prepare. - If you made a change to the library, you can export it back to the notebooks with
nbdev_update.
Metadata
Release files for fastcore 2.2.33
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fastcore-2.2.33.tar.gz | 145.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fastcore-2.2.33-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 297.4 kB
Release files / fastcore-2.2.33.tar.gz
| Download URL | fastcore-2.2.33.tar.gz |
|---|---|
| Size | 145.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
919cc6d182e633a206238bfaacb39f37b7da985974568121347eedf0bec602c0
|
|
BLAKE2b-256 checksum How to use checksums |
10f4a03f290cb0d1aedcf837c51b2be193a28dcc437697f5a57441f16d2c6a27
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.15
|
Release files / fastcore-2.2.33-py3-none-any.whl
| Download URL | fastcore-2.2.33-py3-none-any.whl |
|---|---|
| Size | 152.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2c29d35263d88d21d6c3c5ddef92fe3547161e4af0d3efcd324a6277de1a4fba
|
|
BLAKE2b-256 checksum How to use checksums |
9377687142707e4ff6b11c63f10dba0562e1be08eb214eaca9b46eab2f77a1fe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.15
|