Question on support for needs_global_options using TOML

[MrChocolateMoose]

Hi Sphinx-Needs Community,

I have ported over my configuration file to use a toml file using needs_from_toml

My use case is to set default properties on my needs (in one case based upon the directory structure so that I do not need to manually annotate many needs with fields).

I can successfully do it using needs_global_options.

I am wondering if there is equivalent syntax to be able to use this inside the toml file instead of in the conf.py.

Does this functionality exist or is it planned? Is there a better way to do this?

CONTEXT: I would like to have ubcode recognize that I have set default properties

[chrisjsewell]

Heya, yep it already exists; you can put all sphinx-needs configuration in the toml (assuming none require dynamic python code)

[ubmarco]

Does that already answer your question?
You'll find a little example at the end of the example in the ubCode docs how to do the config in TOML.
There is also a migration script for the config that you can use to translate between conf.py and ubproject.toml.

[MrChocolateMoose]

D'Oh.

I had used the migration script initially, but should have thought of continuing to use it as I added additional options. I was having trouble figuring out the syntax for the more complex predicate based functionality you can use for global options.

.. After using the script to guide me,

✔️[SPHINX-NEEDS] I can confirm that I have it working for sphinx-needs for both a simple example and for a "more complicated" example using predicates and variables like "docname".
⚠️ [UBCODE] When ubcode reads the toml, I can confirm a simple example work (e.g. set field X to Y), but a more complicated example fails (set field Y to Y if Z).

For instance, this would work in sphinx but not in ubcode:

[needs.global_options.feature]
predicates = [
    [
        "\"example_feature\" in docname",
        "Example Feature",
    ],
]
default = "Unspecified Feature"

(This is autogenerated output from the script.py)

I assume it doesn't have support for the predicate syntax listed here:
https://sphinx-needs.readthedocs.io/en/latest/configuration.html#global-option-filters

[ubmarco]

I can reproduce the problem. docname is not yet supported by ubCode unfortunately.
@chrisjsewell any plans to get that in?

[MrChocolateMoose]

I raised this issue on the appropriate repo
useblocks/ubcode-pub#49

I am OK closing this out.