| 1 |
name: subproject |
| 2 |
long_name: Subproject object |
| 3 |
description: This object is returned by [[subproject]] and is an opaque object representing it. |
| 4 |
|
| 5 |
methods: |
| 6 |
- name: found |
| 7 |
returns: bool |
| 8 |
since: 0.48.0 |
| 9 |
description: Returns whether the subproject was successfully setup. |
| 10 |
|
| 11 |
- name: get_variable |
| 12 |
returns: any |
| 13 |
description: | |
| 14 |
fetches the specified variable from inside the subproject. |
| 15 |
This is useful to, for instance, get a |
| 16 |
[[declare_dependency]] from the [subproject](Subprojects.md). |
| 17 |
|
| 18 |
If the variable does not exist, the variable `fallback` is returned. |
| 19 |
If a fallback is not specified, then attempting to read a non-existing |
| 20 |
variable will cause a fatal error. |
| 21 |
|
| 22 |
arg_flattening: false |
| 23 |
|
| 24 |
posargs: |
| 25 |
var_name: |
| 26 |
type: str |
| 27 |
description: The name of the variable to query |
| 28 |
|
| 29 |
optargs: |
| 30 |
fallback: |
| 31 |
type: any |
| 32 |
description: The fallback value to return if `var_name` does not exist. |