filter on style (or: all options/fields)

[AlbertMietus]

Currently a filter as "red_border" in style is not possible, as only a few "variables" (see https://sphinxcontrib-needs.readthedocs.io/en/latest/filter.html#filter-string) exist.

My request is to add "style" to that list.

Or better to add ALL options as variable -- as I can't see why some are more useful as others.
Suggested syntax: option.$NAME (or: field.$NAME) where $NAME is any option/field that is set in a directive

Thanks

BTW, I know, it is possible to add it myself, but this seams very generic

[danwos]

Mhh, I think this is already possible by using current_need in the filter string.

Something like this should work (untested)

.. needtable::
   :filter: current_need["style"] == "red_border"

This should give you access to every option.
Also needs is available, which contains all needs and their options.

But yes, it's totally undocumented.
I leave this ticket open until the docs got updated.

[AlbertMietus]

This sounds oke, BUT: It does not work

I got the following error
sphinxcontrib.needs.filter_common.NeedInvalidFilter: Filter current_need["style"] == "red_border" not valid: Error: name 'current_need' is not defined

As it is undocumented, is kind of hard to see which version I should use. But I have piped this week. __needs.py says 0.5.6 ...

Thanks again

[danwos]

Tested it with current version and it is working as expected.

Used this code for tests:

.. needtable::
   :filter: style == "red_border"

.. needtable::
   :filter: "red_border" in style

Both needtables show me only the related needs and not more.

But current_need was really not accessible.
This gets fixed with #268.

You can see all available "vars" for a filter string by using the debug layout of a need, which prints all internal vars.

.. req:: test
   :layout: debug