Skip to main content

fprime-fpp-format

A formatter for the F Prime Prime (FPP) modeling language.

This package ships the fpp-format executable, a pretty-printer for .fpp source files.

Usage

# Format files in place
fpp-format path/to/model.fpp

# Check formatting without modifying (exit 1 if not formatted)
fpp-format --check path/to/model.fpp

# Format from stdin to stdout
cat path/to/model.fpp | fpp-format --stdin

# Override the indentation width and maximum line length
fpp-format --indent 4 --line-length 100 path/to/model.fpp

Options

Option Description
--check Check formatting without writing; exit 1 if a file is unformatted.
--stdin Read from stdin and write to stdout (default when no files given).
--recursive-includes Also follow include specifiers and format reachable .fppi fragments.
--indent <N> Number of spaces per indentation level. Overrides .fpp-format (default: 2).
--line-length <N> Maximum line width before specs explode their clauses. Overrides .fpp-format (default: 80).
--entry <RULE> Select the parser entrypoint / grammar rule (see below).
--help Print usage.

Configuration file (.fpp-format)

The indentation width and maximum line length can be set project-wide in a .fpp-format file. Starting from each formatted file's directory, fpp-format searches upward through parent directories for the nearest .fpp-format file (the same discovery model as .clang-format). The same file is honored by fprime-util format and by the language server's format-on-save, so the editor and CI always agree.

The file is a minimal key = value list; blank lines and # comments are ignored:

# .fpp-format
indent = 2
line-length = 80

Supported keys:

Key Description Default
indent Spaces per indentation level. 2
line-length Maximum line width before clauses break. 80

Precedence, lowest to highest: built-in defaults → .fpp-format file → --indent / --line-length command-line flags. A malformed .fpp-format file is a hard error on the command line (to avoid formatting with the wrong profile and reporting false --check failures); the language server logs it and falls back to defaults so an editor save never fails.

Entrypoint rule (--entry)

The formatter parses input starting from a specific grammar rule. A whole .fpp file is a module (the default), but other rules are needed when formatting include fragments.

Supported rules:

  • module (default)
  • component
  • topology
  • tlm-packet
  • tlm-packet-set

Recursive include formatting (--recursive-includes)

By default fpp-format formats only the files you name and does not touch .fppi fragments referenced via include. Pass --recursive-includes to also follow every include specifier and format the referenced fragments (recursively):

# Formats model.fpp and every .fppi it (transitively) includes
fpp-format --recursive-includes path/to/model.fpp

With --recursive-includes, include paths are resolved relative to the including file (matching the parser), each fragment is formatted exactly once even if included from several places, and include cycles are detected and reported as an error. The entrypoint for each fragment is derived from the context of its include — a fragment included in a component { ... } body is formatted as component members, one in a topology { ... } body as topology members, and so on, so you do not need --entry for fragments reached this way.

State-machine includes have no standalone entrypoint and are left untouched.

Note: the language-server integration never follows includes; it only ever formats the current document buffer.

Formatting a bare .fppi file

An .fppi file is not a standalone module — it is a fragment that is spliced in via an include specifier. When you format a fragment directly (rather than reaching it from a root .fpp), there is no include context to infer the rule from, so pass --entry to select the matching entrypoint:

# An .fppi included inside a `module { ... }` body (module-level members)
fpp-format --entry module commands.fppi

# An .fppi included inside a `component { ... }` body
fpp-format --entry component ports.fppi

# An .fppi included inside a `topology { ... }` body
fpp-format --entry topology connections.fppi

If you omit --entry, the module rule is used, which is correct for normal .fpp files and for .fppi fragments containing module-level members.

Download files

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

Source Distribution

fprime_fpp_format-3.3.6.tar.gz (123.4 kB view details)

Uploaded Source

Built Distributions

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

fprime_fpp_format-3.3.6-py3-none-win_amd64.whl (419.9 kB view details)

Uploaded Python 3Windows x86-64

fprime_fpp_format-3.3.6-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (517.2 kB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

fprime_fpp_format-3.3.6-py3-none-macosx_11_0_arm64.whl (471.0 kB view details)

Uploaded Python 3macOS 11.0+ ARM64

File details

Details for the file fprime_fpp_format-3.3.6.tar.gz.

File metadata

  • Download URL: fprime_fpp_format-3.3.6.tar.gz
  • Upload date:
  • Size: 123.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for fprime_fpp_format-3.3.6.tar.gz
Algorithm Hash digest
SHA256 03d908f7fb920f1aaa1e693abdc048ffd3788bfbc41ef5e0a2be1613d3ed7182
MD5 564134869c5616cb115dc95de990201f
BLAKE2b-256 26322b23ab824da7b6c47408bdf63caaf9ebdaf0ce4cbc54c9b71dbc7bc1a957

See more details on using hashes here.

Provenance

The following attestation bundles were made for fprime_fpp_format-3.3.6.tar.gz:

Publisher: pip.yml on fprime-community/fpp-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fprime_fpp_format-3.3.6-py3-none-win_amd64.whl.

File metadata

File hashes

Hashes for fprime_fpp_format-3.3.6-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 cf23ddd3329cac34369db98e7b45a159644237dbdc59f4645c1af5c6f86a7e90
MD5 954e30c3252e59642f64d3b0f2ff216c
BLAKE2b-256 1b48691f4568a8c7c37e072398b3a7d7590aa3596590c8321887d5e822fe7321

See more details on using hashes here.

Provenance

The following attestation bundles were made for fprime_fpp_format-3.3.6-py3-none-win_amd64.whl:

Publisher: pip.yml on fprime-community/fpp-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fprime_fpp_format-3.3.6-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for fprime_fpp_format-3.3.6-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 de5c4104120c0cf427fd499f1f0a4cafe4e38c2d68d1488524b39035527bd19f
MD5 ae071f94c94abda75c93e94fcd16f312
BLAKE2b-256 727463fd3c4c5e9d4ca47d672292f95680c7dd7b2ceaa3f52e46fc9f8bc454b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for fprime_fpp_format-3.3.6-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: pip.yml on fprime-community/fpp-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fprime_fpp_format-3.3.6-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for fprime_fpp_format-3.3.6-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 a65a11e87a1ac440869b67618239cc4d33f590a2edd38a3d5a44a723f1523cda
MD5 1f7a6742195b114c7e42e2e2df144a03
BLAKE2b-256 a673de80ecb68e1d04bdac2b720cf2494b987537e06c6dbc6ef28f493faaeabc

See more details on using hashes here.

Provenance

The following attestation bundles were made for fprime_fpp_format-3.3.6-py3-none-macosx_11_0_arm64.whl:

Publisher: pip.yml on fprime-community/fpp-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

3.3.10

4 files

3.3.9

4 files

3.3.8

4 files

3.3.7

4 files

This release

3.3.6 This release

4 files

3.3.5

4 files

3.3.4

4 files

3.3.3

4 files

3.3.2

4 files

3.3.1

4 files

3.3.0

4 files

3.0.0

4 files

2.3.1

4 files

2.3.0

4 files

2.2.1

4 files

2.2.0

4 files

2.1.0

4 files

2.0.2

4 files

2.0.1

4 files

2.0.0

4 files

Supported by

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