Are dict option values expected to be sorted I can t find an

Question

Are dict option values expected to be sorted I can t find any documentation saying as such but the behavior I m seeing is that they are

hundreds-father-404 · Answer

I wouldn t have expected them to be Where are you seeing the sorting ` pants help` output

bitter-ability-32190 · Answer

printing them in a integration test directly from my subsystem in a rule

bitter-ability-32190 · Answer

Passing the value on the CLI I see it being passed in a certain order but printed always in a sorted order The options parsing code isn t quite grokkable but I also don t see explitly see any sorting

bitter-ability-32190 · Answer

So `DictValueComponent create` is preserving order

bitter-ability-32190 · Answer

Ahhhh so this is interesting order IS preserved but the value is eq hash based on contents and not order so changing the order doesn t invalidate the cache

hundreds-father-404 · Answer

ah a possible bug

bitter-ability-32190 · Answer

I guess it all depends on what people would intuit about a dictionary option man shrugging

bitter-ability-32190 · Answer

I could see it either way

hundreds-father-404 · Answer

probably more how dict options are being consumed If order does impact plugin behavior then our caching is wrongg

bitter-ability-32190 · Answer

I guess it doesn t today but I was trying to introduce something where it does sweat smile

hundreds-father-404 · Answer

fwiw fixing eq hash isn t an API change imo It s only caching less than before which seems safe

bitter-ability-32190 · Answer

True although I think the value is truly a `dict` so that means we d need to swap that with a new dict type Which sounds nasty

bitter-ability-32190 · Answer

gt Equality tests between `OrderedDict` objects are order sensitive But maybe not that hard wink

hundreds-father-404 · Answer

`FrozenDict` I thinkkkkk considers order iirc

hundreds-father-404 · Answer

Note that DictOption was created when Pants still ran with Python 2 7 and dict order was not preserved So historically this is all correct It s only new that the order can be leveraged by plugin authors

bitter-ability-32190 · Answer

Yeah makes sense

bitter-ability-32190 · Answer

OK I ll PR it

curved-television-6568 · Answer

I think order of dict entries should not be significant that would be surprising in my book at least stuck out tongue

curved-television-6568 · Answer

i e dict with same contents in different order yields eq hashes

bitter-ability-32190 · Answer

In this case if you don t care then nothing changes But if you do care

bitter-ability-32190 · Answer

In my case I m defining a mapping from glob gt thing I need to specify what happens if multiple globs match First one wins Last one wins Unspecified It d be nice if it was first or last

curved-television-6568 · Answer

aahhh that s the reason why the dep rule globs are in a list rather than a dict as I had it starting out but changed after lengthy discussion with < happy kitchen 89482> on the topic smile

bitter-ability-32190 · Answer

In this case it d specifically be options

curved-television-6568 · Answer

can t they be in a list tho

bitter-ability-32190 · Answer

Option keys are always strings

curved-television-6568 · Answer

do you have any code example to share

bitter-ability-32190 · Answer

That may be a limitation of the new option code and not the parser however

curved-television-6568 · Answer

maybe time to dust of the idea of option schemas sweat smile

bitter-ability-32190 · Answer

I woulnd t mind that being done by someone else sweat smile

curved-television-6568 · Answer

lol

curved-television-6568 · Answer

well in that case I m not going to block you if you need to make a change wrgt how dicts are treated just aired my view on the matter wink

bitter-ability-32190 · Answer

So why didn t you use ordered dicts for the rule stuff My ignorant vision says that d be a really nice UX

proud-dentist-22844 · Answer

I think the dep rule globs would be nicer in a dict the n tuple construction is a little surprising since there is a clear map between key and value

curved-television-6568 · Answer

Benjy talked me into it smile

proud-dentist-22844 · Answer

< happy kitchen 89482> care to change your mind smile

bitter-ability-32190 · Answer

Wanna make a new thread for that I need to circle back to options stuck out tongue

curved-television-6568 · Answer

noooo stuck out tongue

bitter-ability-32190 · Answer

Looks like the parser can parse dicts with tuple keys

curved-television-6568 · Answer

yep that s what it was

bitter-ability-32190 · Answer

Although that doesn t help the order thing

proud-dentist-22844 · Answer

That dict w tuple keys is used for ` defaults `

bitter-ability-32190 · Answer

Sorry should ve realized that sooner

bitter-ability-32190 · Answer

< proud dentist 22844> I m talking about options not targets wink

proud-dentist-22844 · Answer

ah pants toml

curved-television-6568 · Answer

but dicts does preserve ordering right until there s a funny dict class that applies sorted to your elements then you re toast stuck out tongue

bitter-ability-32190 · Answer

It preserves order in iteration not in equality

curved-television-6568 · Answer

I mean it s a thin ice easy to break

proud-dentist-22844 · Answer

I think in this case we d need to consult the toml spec are dicts supposed to be ordered or is that a side effect of using python dicts

bitter-ability-32190 · Answer

ooh good razor

curved-television-6568 · Answer

do you have example toml config for this Josh

bitter-ability-32190 · Answer

Hmm Although < proud dentist 22844> the spec might not have an answer as it doesn t say anything about evaluation of the values

proud-dentist-22844 · Answer

In yaml maps are explicitly NOT ordered But in practice they are in python because of python dicts

bitter-ability-32190 · Answer

gt Key value pairs within tables are not guaranteed to be in any specific order

proud-dentist-22844 · Answer

That s your answer then

bitter-ability-32190 · Answer

Excellent idea to check the spec < proud dentist 22844> slightly smiling face

bitter-ability-32190 · Answer

Although for the targets debate y all still CAN used ordered wink

curved-television-6568 · Answer

forked that thread <https pantsbuild slack com archives C0D7TNJHL p1669748904260489>

happy-kitchen-89482 · Answer

I didn t want the rules to be a dict because order matters

happy-kitchen-89482 · Answer

and relying on order in a dict is subtle and extremely easy to get wrong

bitter-ability-32190 · Answer

As of now the versions of Python which don t support ordering are no longer active slightly smiling face

bitter-ability-32190 · Answer

I think it s OK honestly It makes sense lexically as we humans like is much nicer on the eyes and handles duplicate keys wink

happy-kitchen-89482 · Answer

I m still skeptical although if we convert from a dict to a list at parse time and keep it as a list internally I could maybe be convinced

happy-kitchen-89482 · Answer

But it would still seem to the casual reader that order is not significant

bitter-ability-32190 · Answer

point up I m not sure I agree with that BUILD files are Python and Python has insertion ordered dicts

bitter-ability-32190 · Answer

Oh hey < happy kitchen 89482> I think we re on the wrong thread This one was wrapped up