Repository navigation
is there still a need for irradiance functions to return OrderDict since Python-3.7 is minimum version? #1684
Description
Is your feature request related to a problem? Please describe.
Python-3.7 is the minimum python. I believe since Python-3ish, all dicts are ordered by default. So do we still need to use OrderedDict for returns in irradiance.py?
Describe the solution you'd like
If no longer necessary, remove import of OrderedDict and replace all calls with simple dictionary.
Describe alternatives you've considered
Leave it as is. It seems to function now, and there may be an added benefit b/c an OrderedDict can be compared to another mapping that doesn't respect order?
Additional context
related to #1455 and raised in #1179 (comment)
Activity
AdamRJensen commentedon Mar 7, 2023
This article describes a few reasons why one might want to continue using OrderedDicts:
Though I still think that I favor the simplicity of getting rid of OrderedDicts.
markcampanelli commentedon Dec 2, 2023
I’d like to point out that one should never rely on the implementation of
dictbeing ordered (as it is in newer CPython versions, IIRC for better performance). Thus, if a dictionary must be ordered for some good reason, then keep it declared as anOrderedDict.kandersolar commentedon Dec 2, 2023
As I understand it, dicts being ordered according to insertion was a CPython implementation detail in 3.6 that got upgraded to an official language feature in 3.7 onward, so it should be reliable for our purposes :)
markcampanelli commentedon Dec 2, 2023
I read this part of the “tutorial” documentation for Python 3.12, and indeed it mentions that insertion order is guaranteed for certain operations. (Notably, when applied to a
dict,sortedproduces a generally different ordering of keys thanlist, which produces the insertion ordering.)IMHO, this opens a can of worms about what contract you intend to uphold when supplying a dictionary, say, as a return value, because consumers now could apparently expect some consistent ordering, or perhaps not 🤷♂️. (It’s not uncommon for a dictionary to get constructed in a different order based on some internal logic.) Seems like a poor design choice for the language to make
dictordering more than an implementation detail, especially when there is still anOrderedDict. IMHO, it forces an element of complexity and risks making code and contracts more ambiguous.https://docs.python.org/3/tutorial/datastructures.html#dictionaries
adriesse commentedon Dec 2, 2023
I just browsed some code that uses OrderedDict and I didn't see any reason why order even matters. Am I missing something?
wholmgren commentedon Dec 3, 2023
I started using OrderedDict because I wanted my plots to consistently use the same colors when iterating over dictionaries returned by pvlib. And I thought "well DataFrames have ordered columns so I guess in general dict-like pvlib results should too." I don't remember if there was ever another use case. That was nearly 10 years ago and a lot has changed since then!
kandersolar commentedon Aug 6, 2025
I suggest we excise
OrderedDictfrom the package and replace it withdict. I've added this to the v0.14.0 milestone since it could potentially break user code, although I expect most code to accept the change without issue.