Skip to content

process: Python Coding Guidelines - #741

Merged
AlexanderLanin merged 9 commits into
mainfrom
alex-python-guide
Mar 31, 2025
Merged

process: Python Coding Guidelines#741
AlexanderLanin merged 9 commits into
mainfrom
alex-python-guide

Conversation

@AlexanderLanin

@AlexanderLanin AlexanderLanin commented Mar 19, 2025

Copy link
Copy Markdown
Member

Python Guidelines based on #416

@hoe-jo I would like to clarify some formal points before we discuss the actual guidelines:

  • Don't guidelines belong to "contributing"?
  • What do you think about my references to safety, checklists and templates?
  • Is it ok to skip completeness of the python rules as we did by referencing other webpages?

@AlexanderLanin AlexanderLanin added community:infrastructure General Score infrastructure topics community:process labels Mar 19, 2025
@AlexanderLanin
AlexanderLanin requested a review from hoe-jo March 19, 2025 22:04
@github-actions

github-actions Bot commented Mar 19, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

License Check Results

🚀 The license check preparation job ran successfully.

Status: ⚠️ Needs Review

Click to expand output 
2025/03/31 09:34:02 Downloading https://releases.bazel.build/7.4.0/release/bazel-7.4.0-linux-x86_64...
Extracting Bazel installation...
Starting local Bazel server and connecting to it...
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: docs
Loading: 0 packages loaded
    currently loading: docs
Analyzing: target //docs:license.check.python (1 packages loaded, 0 targets configured)
Analyzing: target //docs:license.check.python (1 packages loaded, 0 targets configured)

Analyzing: target //docs:license.check.python (96 packages loaded, 10 targets configured)

Analyzing: target //docs:license.check.python (126 packages loaded, 707 targets configured)

Analyzing: target //docs:license.check.python (134 packages loaded, 1615 targets configured)

Analyzing: target //docs:license.check.python (144 packages loaded, 2465 targets configured)

Analyzing: target //docs:license.check.python (144 packages loaded, 2465 targets configured)

Analyzing: target //docs:license.check.python (144 packages loaded, 2465 targets configured)

Analyzing: target //docs:license.check.python (148 packages loaded, 4611 targets configured)

INFO: Analyzed target //docs:license.check.python (149 packages loaded, 4736 targets configured).
[11 / 13] [Prepa] JavaToolchainCompileBootClasspath external/rules_java~/toolchains/platformclasspath.jar
[12 / 13] Building docs/license.check.python.jar (); 0s multiplex-worker
INFO: Found 1 target...
Target //docs:license.check.python up-to-date:
  bazel-bin/docs/license.check.python
  bazel-bin/docs/license.check.python.jar
INFO: Elapsed time: 17.814s, Critical Path: 2.49s
INFO: 13 processes: 9 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 13 total actions
INFO: Running command line: bazel-bin/docs/license.check.python docs/formatted.txt -review -project automotive.score -repo https://github.com/eclipse-score/score -token otyhZ4eaRYK1tKLNNF-Y
[main] INFO Querying Eclipse Foundation for license data for 69 items.
[main] INFO Found 45 items.
[main] INFO Querying ClearlyDefined for license data for 25 items.
[main] INFO Found 25 items.
[main] INFO License information could not be automatically verified for the following content:
[main] INFO 
[main] INFO pypi/pypi/-/docutils/0.21.2
[main] INFO 
[main] INFO This content is either not correctly mapped by the system, or requires review.
[main] INFO A review is required for pypi/pypi/-/docutils/0.21.2.
[main] INFO A review request already exists https://gitlab.eclipse.org/eclipsefdn/emo-team/iplab/-/issues/19880 .

@github-actions

github-actions Bot commented Mar 19, 2025

Copy link
Copy Markdown
Contributor

The created documentation from the pull request is available at: docu-html

masc2023
masc2023 reviewed Mar 20, 2025
View reviewed changes
Comment thread docs/process/process_areas/implementation/guidance/python/coding_guidelines.rst Outdated
masc2023
masc2023 reviewed Mar 20, 2025
View reviewed changes
Comment thread docs/process/process_areas/implementation/guidance/python/coding_guidelines.rst Outdated
masc2023
masc2023 requested changes Mar 20, 2025
View reviewed changes

@masc2023 masc2023 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please consider to move this content outside of process folder, as it contains concrete tools for a specific language. Process area should not be tool agnostic.

@AlexanderLanin AlexanderLanin mentioned this pull request Mar 20, 2025
Closed
pahmann
pahmann reviewed Mar 20, 2025
View reviewed changes
Comment thread docs/process/process_areas/implementation/guidance/python/coding_guidelines.rst Outdated
@AlexanderLanin

AlexanderLanin commented Mar 24, 2025

Copy link
Copy Markdown
Member Author
  • Moved to contribute as discussed.
  • Changed types from gd_guidl to doc as discussed.

@MaximilianSoerenPollak MaximilianSoerenPollak linked an issue Mar 25, 2025 that may be closed by this pull request
Setup Python guidelines #81
Closed
@AlexanderLanin
AlexanderLanin requested a review from masc2023 March 25, 2025 11:10
@AlexanderLanin

AlexanderLanin commented Mar 25, 2025

Copy link
Copy Markdown
Member Author

@hoe-jo @pahmann @masc2023 please re-review

hoe-jo
hoe-jo reviewed Mar 25, 2025
View reviewed changes
Comment thread docs/contribute/development/python/coding_guidelines.rst Outdated
hoe-jo
hoe-jo reviewed Mar 25, 2025
View reviewed changes
Comment thread docs/contribute/development/python/coding_guidelines.rst
hoe-jo
hoe-jo reviewed Mar 25, 2025
View reviewed changes
Comment thread docs/contribute/development/python/coding_guidelines.rst
hoe-jo
hoe-jo reviewed Mar 25, 2025
View reviewed changes
Comment thread docs/contribute/development/python/coding_guidelines.rst Outdated
hoe-jo
hoe-jo requested changes Mar 25, 2025
View reviewed changes

@hoe-jo hoe-jo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please take a look a the comments

masc2023
masc2023 reviewed Mar 26, 2025
View reviewed changes

@masc2023 masc2023 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a placeholder for the RUSt guidelines?

@AlexanderLanin

AlexanderLanin commented Mar 31, 2025

Copy link
Copy Markdown
Member Author

mhh seems I merged the wrong main :D

masc2023
masc2023 approved these changes Mar 31, 2025
View reviewed changes

@masc2023 masc2023 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My aspects, location, structure covered now

@AlexanderLanin

AlexanderLanin commented Mar 31, 2025

Copy link
Copy Markdown
Member Author

I have currently no idea what that is about, so I cannot merge 😢

https://api.eclipse.org/git/eca/status/gh/eclipse-score/score/741

@masc2023

masc2023 commented Mar 31, 2025

Copy link
Copy Markdown
Contributor

I have currently no idea what that is about, so I cannot merge 😢

https://api.eclipse.org/git/eca/status/gh/eclipse-score/score/741

Just follow our Git guidelines, may also squash it to one commit, the other I do not know

@AlexanderLanin

AlexanderLanin commented Mar 31, 2025

Copy link
Copy Markdown
Member Author

All eca checks were failing in eclipse-score. Fixed now.

hoe-jo
hoe-jo approved these changes Mar 31, 2025
View reviewed changes

@hoe-jo hoe-jo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to Writing Test Cases still missing, can be added in later PR
Rest ok

@AlexanderLanin
AlexanderLanin merged commit fab2dbc into main Mar 31, 2025
@AlexanderLanin
AlexanderLanin deleted the alex-python-guide branch March 31, 2025 11:03
pahmann pushed a commit that referenced this pull request Apr 1, 2025
@AlexanderLanin @pahmann
process: Python Coding Guidelines (#741)
1b0d2fc 
Move guidelines to contribution and add guidelines for python
ramceb pushed a commit that referenced this pull request Apr 11, 2025
@AlexanderLanin @ramceb
process: Python Coding Guidelines (#741)
397e829 
Move guidelines to contribution and add guidelines for python
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@masc2023 masc2023 masc2023 approved these changes
@hoe-jo hoe-jo hoe-jo approved these changes
@pahmann pahmann Awaiting requested review from pahmann pahmann is a code owner

Assignees

No one assigned

Labels

community:infrastructure General Score infrastructure topics community:process

Projects

INF - Infrastructure Community
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Setup Python guidelines

4 participants

@AlexanderLanin @masc2023 @pahmann @hoe-jo