Allow to preserve keys order in ConsoleRenderer. Related to #166

[darklow]

Pull Request Check List

This is just a friendly reminder about the most common mistakes. Please make sure that you tick all boxes. But please read our contribution guide at least once, it will save you unnecessary review cycles!

If an item doesn't apply to your pull request, check it anyway to make it apparent that there's nothing left to do.

• Added tests for changed code.
• Updated documentation for changed code.
  • New functions/classes have to be added to docs/api.rst by hand.
  • Changed/added classes/methods/functions have appropriate versionadded, versionchanged, or deprecated directives. Find the appropriate next version in our __init__.py file.
• Documentation in .rst files is written using semantic newlines.
• Changes (and possible deprecations) are documented in the changelog.

If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!

[hynek]

In case you're waiting for feedback:

• the CI is failing
• we don't need OrderedDict since structlog is 3.6+
• it needs a .. versionadded
• it needs a changelog entry

[darklow]

Thanks for feedback, if you find this PR useful, I can complete missing parts, wanted to be sure this change is welcomed before spending time the completion and docs.

Btw, seems to me CI is failing for non-related to my changes reasons:
/~https://github.com/hynek/structlog/pull/358/checks?check_run_id=3886960621

{'detail': ErrorDetail(string='Unable to locate build via Github Actions API. Please upload with the Codecov repository upload token to resolve issue.', code='not_found')}
Error: Codecov failed with the following error: The process '/usr/bin/bash' failed with exit code 1

[hynek]

I don't see much value in the behavior myself, but the impact is small enough that I'd merge it to make others happy. ;)

I've re-run the tests and now mypy is failing...I tried briefly to recreate the error locally but I couldn't.

[mje-nz]

@darklow For what it's worth, I'm also interested in this feature.

[darklow]

I personally see lot of value organising keys by priority, most important at first, and more secondary later rather relying on alphabet. Also having same length parameters as first helps readability as well.

Just pushed three things you mentioned.

[hynek]

I personally see lot of value organising keys by priority, most important at first, and more secondary later rather relying on alphabet.

To be clear, I don't disagree. It's just not always clear that the most important keys are merged first and sorting them gives a stable order which is also useful.

[hynek]

thanks!

[hynek]

(docs were failing due to a typo in the PR number but I quickly fixed it in abc9312 myself to avoid extra review cycles)

[darklow]

Thanks for approval and docs fix!