symforce.path_util module

exception MissingManifestException

Bases: RuntimeError

symforce_dir()

Return type:

Path

symenginepy_install_dir()

Return type:

Path

cc_sym_install_dir()

Return type:

Path

binary_output_dir()

Return type:

Path

symforce_root()

The root directory of the symforce project

Return type:

Path

eigen_lcm_lcmtypes_dir()

Directory of the eigen_lcm .lcm sources, or None if not found.

Codegen feeds these to skymarshal’s recursive-hash precompute. Standalone builds keep them under third_party/eigen_lcm; Bazel sets SYMFORCE_EIGEN_LCM_LCMTYPES_DIR (absolute, or relative to the runfiles tree) to point elsewhere.

Return type:

Path | None

symforce_data_root(test_file_path)

The root directory of the symforce project, for use accessing data that might need to be updated (such as generated files). Most of the time this is the same as symforce_root(), except for two cases:

1. When running tests on wheels, this is the root of the copy of SymForce containing the test, not the installed copy. The generated files we’re checking aren’t in the wheel, they’re in the source tree.

2. When the --update flag is passed to a test, this is guaranteed to point to the resolved version, i.e. the actual symforce location on disk regardless of whether this path is a symlink.

Parameters:

test_file_path (str | None)

Return type:

Path