Skip to main content

Python supercharged for fastai development

Project description

Welcome to fastcore

[!NOTE]

fastcore v2

In July 2026 we released fastcore v2, which removes or relocates a number of APIs that had accumulated better alternatives. If you use from fastcore.utils import * (or fastcore.all), most of these changes won’t affect you. The breaking changes: Param is gone from fastcore.script; use plain type annotations with docments, or typing.Annotated[type, "help"], optionally with a dict of argparse arguments for advanced features. L’s starmap, starfilter, and the other star*/rstar* methods are replaced by the star and rstar function adapters, which compose with every L method (e.g. t.map(star(f))); relatedly, spread is replaced by star, and dspread is renamed to dstar. Async helpers now live in the new fastcore.aio module: run_sync, iter_sync, and ctx_sync moved there from net, and maybe_await, then, mapa, acache, reawaitable, is_async_callable, and the other async utilities moved there from xtras. Config and the config file functions moved from foundation to xtras. fastcore.net lost its request builders (urlrequest, urlsend, do_request, urlcheck) and clean_type_str is gone. parallel_gen is removed; the stdlib ProcessPoolExecutor initializer pattern replaces it (fastai’s parallel_tokenize shows the recipe). Python 3.11 or later is now required. If you need the old APIs, pin fastcore<2.

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:

  • Liberal imports: Use from fastcore.module import * freely. The library is designed for safe wildcard imports.
  • Enhanced list operations: Substitute list with L. This provides advanced indexing, method chaining, and additional functionality while maintaining list-like behavior.
  • Extend existing classes: Apply the @patch decorator to add methods to classes, including built-ins, without subclassing.
  • Streamline class initialization: In __init__ methods, use store_attr() to efficiently set multiple attributes, reducing repetitive assignment code.
  • Explicit keyword arguments: Apply the delegates decorator to functions to replace **kwargs with specific parameters, enhancing IDE support and documentation.
  • Optimize parallel execution: Use fastcore’s enhanced ThreadPoolExecutor and ProcessPoolExecutor for simplified concurrent processing.
  • Expressive testing: Prefer fastcore’s testing functions like test_eq, test_ne, test_close for more readable and informative test assertions.
  • Advanced file operations: Use the extended Path class, which adds methods like ls(), read_json(), and others to pathlib.Path.
  • Flexible data structures: Convert between dictionaries and attribute-access objects using dict2obj and obj2dict for more intuitive data handling.
  • Functional programming paradigms: Use tools like compose, maps, and filter_ex to write more functional-style Python code.
  • Documentation: Use docments where possible to document parameters of functions and methods.
  • Time-aware caching: Apply the timed_cache decorator to add time-based expiration to the standard lru_cache functionality.
  • Simplified CLI creation: Use fastcore.script to easily transform Python functions into command-line interfaces.

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

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 functions
  • fastcore.foundation: Mixins, delegation, composition, and more
  • fastcore.xtras: Utility functions to help with functional-style programming, parallel processing, and more

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.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

fastcore-2.1.16.tar.gz (131.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fastcore-2.1.16-py3-none-any.whl (137.6 kB view details)

Uploaded Python 3

File details

Details for the file fastcore-2.1.16.tar.gz.

File metadata

  • Download URL: fastcore-2.1.16.tar.gz
  • Upload date:
  • Size: 131.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.2

File hashes

Hashes for fastcore-2.1.16.tar.gz
Algorithm Hash digest
SHA256 aeeeab05bb28913af04a682d7bb093dcb59f354145a69fa9498cb4a503cd2039
MD5 daa560b88bc7f436ca37f2ebce21e958
BLAKE2b-256 22e162ffb49e24033c63ffef0d2fe9f415b0f1d0164eb6667512a3c245602a3f

See more details on using hashes here.

File details

Details for the file fastcore-2.1.16-py3-none-any.whl.

File metadata

  • Download URL: fastcore-2.1.16-py3-none-any.whl
  • Upload date:
  • Size: 137.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.2

File hashes

Hashes for fastcore-2.1.16-py3-none-any.whl
Algorithm Hash digest
SHA256 4a4a535af01b8792e34ad630086556ffdffc85af8f4c4accdde8cb2ab1e3edff
MD5 ecd65134cbf194aa98731d9c9973d18b
BLAKE2b-256 d53bdd7ca0fa89032745eb2b3d51aff3ba42b8c8f18e0d57682f24f973073260

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page