Formatting / style guide

[rdimaio]

There seems to be a few formatting guidelines in Rucio that are not yet mentioned in the documentation, e.g.:

• The SQLAlchemy query coding style mentioned here: Add type annotations and refactor to use TokenDict type rucio#6497 (comment)
• Sorting imports alphabetically, separating them into sections based on whether they're internal or external dependencies

It would benefit to have a documentation page collecting these guidelines.

[voetberg]

Seconding the need for this. I didn't even know there was an adopted sql syntax style.

[rdimaio]

Reopening to address follow-up comments from #308

[voetberg]

@dchristidis
I would like your opinions in particular on this section - https://github.com/rucio/documentation/blob/main/docs/developer/style_guide.md#sqlalchemy-query-guide

I tried to keep the queries generic to avoid confusing people with the exact functionality of the queries but this may be a mistake.

[dchristidis]

@dchristidis I would like your opinions in particular on this section - https://github.com/rucio/documentation/blob/main/docs/developer/style_guide.md#sqlalchemy-query-guide

If it is acceptable to you, may I take over and rewrite it?

Side note: my comment about the examples being non-functional was not related to having placeholder tables and columns; it was the use of scalars() in a query with two columns (hence, the for loop that follows results in an exception).

[voetberg]

Please do rewrite! I have no qualms with that.