Skip to main content

Python API

FOSU is in active development; its API may change without compatibility shims. Parsing returns eager objects and lists, detached from native memory. All records are read-only native objects with eager Python fields, declared and typed in _model.py. Attribute reads do not allocate numeric values. Lists remain ordinary mutable Python lists.

Install and use

Requires CPython 3.10+. Stable-ABI wheels target glibc and musl Linux on x86-64 and AArch64, plus macOS 11+ on Intel and Apple Silicon. One wheel per platform supports every compatible CPython version. Windows x86-64 is supported both natively and through the Linux x86-64 wheel under WSL.

python -m pip install fosu

Installing from a source checkout requires a C++20 compiler. An ordinary isolated pip install . provisions CMake and Ninja when needed; Unix Makefiles are also supported when Ninja is unavailable. --no-build-isolation makes the caller responsible for all build tools.

import fosu

beatmap = fosu.parse_file("map.osu")
for note in beatmap.hit_objects:
    if isinstance(note, fosu.Slider):
        print(note.time, note.length, note.control_points)

parse_file(path) accepts strings, bytes, and os.PathLike. parse(data) accepts buffer-protocol objects, including bytes, bytearray, memoryview, and arrays. Non-bytes buffers are copied to an immutable snapshot; encode text explicitly.

File failures raise OSError; other parse failures, including invalid options and inputs too large to allocate, raise ValueError. Native parsing releases the GIL; Python value construction holds it. Malformed records are skipped and counted in beatmap.stats.malformed_lines; success does not certify playability.

parse and parse_file allocate native memory for each call. To parse many maps, reuse a fosu.Parser, which keeps that memory until the parser is garbage-collected:

parser = fosu.Parser()
maps = [parser.parse_file(path) for path in paths]

Its parse and parse_file methods take the same arguments as the module functions. Results are detached, so later calls never change earlier results. One parser handles one call at a time; a concurrent call raises RuntimeError. Use one parser per thread.

Performance

FOSU commit f2c86ce (after 0.6.1), measured on 2026-10-04 using CPython 3.12.14 on an Intel Core i7-8700 under Linux/WSL2. All rows use the same 1,004 mutually accepted all-mode maps. Times include eager result construction and release; lower is better. Warm-file measurements include opening and reading page-cached files.

Python interface Resident bytes (µs/map) Warm file (µs/map)
FOSU AVX2, reused fosu.Parser 162.8 174.5
FOSU scalar, reused fosu.Parser 219.0 227.0
FOSU AVX2, fosu.parse per call 265.0 277.2
FOSU scalar, fosu.parse per call 324.4 334.2
OsuPyParser 1.0.7 Unsupported 4,418.9

A fosu.Parser keeps its memory between calls. The module functions create a new parser per call, which also reserves that memory and takes a page fault on the first write to each page; keep a Parser when parsing many maps.

Figures are the fastest of six complete passes per API, not fastest individual parses: every pass keeps the garbage collection its parsing causes. The parsers expose different models: OsuPyParser also performs derived-statistic work. See the comparison and measured variation for result contracts, or the feature-cost tables for slider geometry, gameplay, mods, and ARM measurements.

Section selection

listing = fosu.parse_file(
    "map.osu",
    sections=fosu.Sections.METADATA | fosu.Sections.DIFFICULTY,
)

Both entry points accept keyword-only sections, defaulting to Sections.ALL. Members are GENERAL, EDITOR, METADATA, DIFFICULTY, EVENTS, TIMING_POINTS, COLOURS, and HIT_OBJECTS. Combine them with |. Skipped sections retain defaults and empty lists; Sections(0) selects none. Unsupported mask bits are rejected.

Include GENERAL for mode-dependent difficulty rules (such as mania CircleSize) and EVENTS for break-dependent combo rules. Only selected sections contribute malformed-line counts.

Results and important distinctions

The model classes in _model.py define the fields and convenience methods. Shared fields use C++ names. Important Python-specific behavior:

  • hit_objects contains Circle, Slider, Spinner, or HoldNote, in stable timestamp order. Narrow the union with isinstance.
  • Times are milliseconds. Slider endpoints are 0 by default. Pass calculate_slider_end_times=True to parse or parse_file to calculate them using curve distance, timing and repeats. Do not use slider endpoints unless calculation was requested. Accessing the field never computes or caches anything. Other object types still have numeric endpoints. Omitted sections use their default settings. Hit samples and slider edge fields remain text.
  • Slider control_points includes the head position, unlike the native point range. curve_segments preserves modern segment boundaries and explicit B-spline degrees. slides=2 means forward and back.
  • tag_list and bookmark_list are parsed conveniences alongside the tags and bookmarks text fields.
  • IDs and preview time map the -1 sentinel to None.
  • Strings decode with UTF-8 surrogateescape, preserving undecodable bytes.
  • Inherited timing-point NaN beat lengths are preserved; consumers must not treat them as ordinary slider velocities.

Records support equality, repr, deepcopy, and pickle. They are not dataclasses: dataclasses.asdict and dataclasses.replace do not apply. Public record classes cannot be subclassed, and attributes cannot be assigned or deleted. Constructors accept positional or keyword arguments and retain the supplied values without runtime type validation. Parsed numeric fields are always eagerly converted to their documented Python types.

List contents can be changed without affecting the input or another parse result. Such changes do not recompute derived data. All records participate in cyclic garbage collection, including cycles consumers create through lists or values passed to constructors.

Pass calculate_slider_paths=True to retain each slider's path (otherwise None). fosu.slider_position_at(slider.path, progress) is a pure query over that polyline, with progress clamped to [0, 1]. Returned PathPoint coordinates are relative to the head; add the slider's x/y for playfield coordinates. Paths alone do not calculate end times. Requesting both reuses their distance. Native code exposes the same query and Beatmap.slider_paths, indexed by slider.

calculate_slider_events=True additionally populates slider.events with HEAD, TICK, REPEAT, LEGACY_LAST_TICK, and TAIL records in official generator order, grouped by slider-span traversal. This is not necessarily timestamp order: a legacy last tick may be timed before a late tick or the repeat beginning its final span. The legacy event is the effective historical tail judgement, not an additional score or combo event; the real TAIL and slider end_time remain unchanged. This option includes path and end-time calculation. Each record has time, span index/start time, path progress, and a position relative to the head. Native code exposes Beatmap.slider_events, indexed by slider. Without the option, events are empty. These are path events using the decoded slider's timing, not a converted ruleset's nested hitobjects: no samples or catch conversion. Expansion beyond 1,048,576 events per map fails the parse with ValueError rather than silently dropping events.

apply_stacking=True applies unmodded osu!standard stacking after parsing, including the pre-v6 algorithm. Hit-object x/y and absolute slider control points are adjusted before returning. obj.raw_position() subtracts the stacking offset from the current x/y, or returns x/y when stacking is absent. It can have small floating-point rounding differences. Coordinates are floats in both interfaces, including when stacking is disabled. Each object also retains stack_height and stack_offset in its Stacking value for inspection; do not add the offset again. Relative path/event positions remain unchanged: add them to the adjusted head. It includes path and end-time calculation, but not events. Native results use Beatmap.stacking, indexed by hit object. Other modes are unchanged; Python stacking is None when not calculated. Include GENERAL, DIFFICULTY, TIMING_POINTS and HIT_OBJECTS when selecting sections for meaningful results.

mods= accepts combined Mods values. EZ and HR adjust difficulty settings for osu!standard and osu!taiko; HR also reflects standard hit objects and slider control points vertically. EZ/HR require GENERAL and DIFFICULTY in sections. They are not yet supported for osu!catch or osu!mania because those modes require converted fruit offsets or resolved hit windows; support is planned. DT, NIGHTCORE, and HT support every mode and divide gameplay timeline values by 1.5, 1.5, and 0.75 respectively. This includes hit objects, calculated slider events, timing-point offsets and uninherited beat lengths, and breaks. General and Editor timestamp metadata remains in source-map time.

See compatibility for supported behavior and limitations; there is no ruleset conversion.

CPU selection

fosu.backend reports "avx2", "neon", or "scalar". Set FOSU_BACKEND=auto|scalar|avx2|neon before importing to select an engine. Unsupported explicit requests raise ImportError; selection stays fixed for the loaded extension. See development checks.

Metadata

Release files for fosu 0.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fosu 0.7.0
File Size Uploaded Provenance Actions
fosu-0.7.0.tar.gz 249.4 kB With provenance Details for fosu-0.7.0.tar.gz

Built distributions (wheels)

Table of built distributions (wheels) for fosu 0.7.0
File Actions
fosu-0.7.0-cp310-abi3-win_amd64.whl CPython 3.10 abi3 Windows x86-64 Details for fosu-0.7.0-cp310-abi3-win_amd64.whl
fosu-0.7.0-cp310-abi3-musllinux_1_2_x86_64.whl CPython 3.10 abi3 Linux musl 1.2+ x86-64 Details for fosu-0.7.0-cp310-abi3-musllinux_1_2_x86_64.whl
fosu-0.7.0-cp310-abi3-musllinux_1_2_aarch64.whl CPython 3.10 abi3 Linux musl 1.2+ ARM64 Details for fosu-0.7.0-cp310-abi3-musllinux_1_2_aarch64.whl
fosu-0.7.0-cp310-abi3-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl CPython 3.10 abi3 Linux glibc 2.26+ x86-64, Linux glibc 2.28+ x86-64 Details for fosu-0.7.0-cp310-abi3-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl
fosu-0.7.0-cp310-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl CPython 3.10 abi3 Linux glibc 2.26+ ARM64, Linux glibc 2.28+ ARM64 Details for fosu-0.7.0-cp310-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl
fosu-0.7.0-cp310-abi3-macosx_11_0_x86_64.whl CPython 3.10 abi3 macOS 11.0+ x86-64 Details for fosu-0.7.0-cp310-abi3-macosx_11_0_x86_64.whl
fosu-0.7.0-cp310-abi3-macosx_11_0_arm64.whl CPython 3.10 abi3 macOS 11.0+ ARM64 Details for fosu-0.7.0-cp310-abi3-macosx_11_0_arm64.whl

Total release size: 2.3 MB

Release files / fosu-0.7.0.tar.gz

Download URL fosu-0.7.0.tar.gz
Size 249.4 kB
Tags Source
SHA-256 checksum
How to use checksums
4ce1082c2e3233cab42d6098c7179ef11c0960995ad9de135bbebfbfab6feeb0
BLAKE2b-256 checksum
How to use checksums
e8709e0454458c82d3b28b0b8270b8bc425bd63b06d4f39bf48bde5ca2231459
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 5, 2026.

Transparency log

Release files / fosu-0.7.0-cp310-abi3-win_amd64.whl

Download URL fosu-0.7.0-cp310-abi3-win_amd64.whl
Size 343.3 kB
Tags CPython 3.10 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
748646ce25ddb2ae250842284889cbf354e7f9a1313fc2f787f002e46564c682
BLAKE2b-256 checksum
How to use checksums
9c72109dd546dcfd3d312862a589c287d1f597ee92663b40d8333a8143164f7d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 5, 2026.

Transparency log

Release files / fosu-0.7.0-cp310-abi3-musllinux_1_2_x86_64.whl

Download URL fosu-0.7.0-cp310-abi3-musllinux_1_2_x86_64.whl
Size 329.9 kB
Tags CPython 3.10 Linux musl 1.2+ x86-64 abi3
SHA-256 checksum
How to use checksums
ea6a154703f3421715f3345b9b24b9157ebd19b16ec34420f912d8f1707e6874
BLAKE2b-256 checksum
How to use checksums
501c8c571a67d2a568f3de399e632317b9e755c39c0c9339b5c1d91d48b5ca88
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 5, 2026.

Transparency log

Release files / fosu-0.7.0-cp310-abi3-musllinux_1_2_aarch64.whl

Download URL fosu-0.7.0-cp310-abi3-musllinux_1_2_aarch64.whl
Size 351.4 kB
Tags CPython 3.10 Linux musl 1.2+ ARM64 abi3
SHA-256 checksum
How to use checksums
96f2820c2aa3858a63124d8efaded896a292c56e766a9e2ca5e4781640530543
BLAKE2b-256 checksum
How to use checksums
62d7161189a04ca8588893596947c4410ca99f89972c8911f9d8664fc9f5494c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 5, 2026.

Transparency log

Release files / fosu-0.7.0-cp310-abi3-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl

Download URL fosu-0.7.0-cp310-abi3-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl
Size 330.7 kB
Tags CPython 3.10 Linux glibc 2.26+ x86-64 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
2fd07ba308aed651a37336d2644820faa521768e310214b1dddfa354a8859af9
BLAKE2b-256 checksum
How to use checksums
0dc8a1578e0fb92fbf62624cb0ea3eb1a0dbd5df65be28818f74b38ff76e6dc0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 5, 2026.

Transparency log

Release files / fosu-0.7.0-cp310-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl

Download URL fosu-0.7.0-cp310-abi3-manylinux_2_26_aarch64.manylinux_2_28_aarch64.whl
Size 352.6 kB
Tags CPython 3.10 Linux glibc 2.26+ ARM64 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
b2673aff9704d72a30a626703a5f3f1067ef5577c7f6335c1aeea3ee2cfd3cf0
BLAKE2b-256 checksum
How to use checksums
8fb439ac3b973a4cb89775e02b4aa137ef96542e90b385ea5ca036ed17c71628
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 5, 2026.

Transparency log

Release files / fosu-0.7.0-cp310-abi3-macosx_11_0_x86_64.whl

Download URL fosu-0.7.0-cp310-abi3-macosx_11_0_x86_64.whl
Size 157.0 kB
Tags CPython 3.10 abi3 macOS 11.0+ x86-64
SHA-256 checksum
How to use checksums
03751f020711e7d5ee81cd1af27f4a4a0a621e3486b1bc82e45eafe08ad1e333
BLAKE2b-256 checksum
How to use checksums
04d44aaf2a7602068fe1c581803fe39e75f809bafbed2ca87b176b35e38ede9e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 5, 2026.

Transparency log

Release files / fosu-0.7.0-cp310-abi3-macosx_11_0_arm64.whl

Download URL fosu-0.7.0-cp310-abi3-macosx_11_0_arm64.whl
Size 146.8 kB
Tags CPython 3.10 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
02b22b9f589f2ae44851bb853659e1afdd40dc09ceb46ad8f93e198b90bc2a25
BLAKE2b-256 checksum
How to use checksums
22d76c02f8318dd569bce1d3e4cb2fe7741753a4e988e61d6146a8ddeb21ffda
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 5, 2026.

Transparency log

Security for fosu 0.7.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 8 files in this release have been uploaded with provenance metadata.

Select from 8 files

Attestation for fosu-0.7.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 5, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page