[INFRA] Support for Block Comment Style for Python files

[mikhail-dr]

Please answer these questions before submitting your issue.

• Why do you submit this issue?
• [ X] Question or discussion
• Bug
• [ X] Requirement
• Feature or performance improvement

---

Question

• What do you want to know?

There does not appear to be any way to configure the tool to use block comment for the insertion of copyright notice into Python files? The only way I can use block comments for that is if I modify styles.yaml and languages.yaml files?

---

Bug

• Which version of SkyWalking, OS, and JRE?

• Which company or project?

• What happened?
  If possible, provide a way to reproduce the error. e.g. demo application, component version.

---

Requirement or improvement

• I would like to use block style comments, rather than # inline comments to insert copyright notices into Python files. It would be great if such possibility or config option were available in the tool.

[kezhenxu94]

@mikhail-dr IIRC Python doesn't allow multi line comments, do you mean docstring?

[mikhail-dr]

@kezhenxu94 yes, correct, docstrings, """. thanks.

[wu-sheng]

@kezhenxu94 yes, correct, docstrings, """. thanks.

Could do share which project uses this style?

[mikhail-dr]

we'd like to use """-style docstring, rather than #-style comments for Python files. thanks.

[wu-sheng]

Hi, my question is which? Is recommended in any Python doc or project? If so, it is reasonable to accept this.
At least we should be able to find more than one top level open source Python projects using in this way.

[mikhail-dr]

well, this was just an internal preference, to use docstring """, rather than # comments for copyright notice. while i can change the two yaml files to use """ docstring and rebuild the binary (i did do that today and that works), I thought it would be better if that was an official option so that folks could use your official docker image. thanks.

[wu-sheng]

@kezhenxu94 I noticed no doc on https://hub.docker.com/r/apache/skywalking-eyes. Could you update it?
I think we should or already have yaml override for our image.

[mikhail-dr]

@wu-sheng do you mean to say that it is already somehow possible to override the default styles.yaml and languages.yaml files? if so, please, let me know how, i found no information on that. thanks.

[wu-sheng]

do you mean to say that it is already somehow possible to override the default styles.yaml and languages.yaml files? if so, please, let me know how, i found no information on that. thanks.

I think we should have at least. We have this similar feature in other images, same for this too. Let's wait for @kezhenxu94 's confirmation. We are closing to eye 0.2.0. Let's see.

[mikhail-dr]

@kezhenxu94 any further comments/updates on this? thanks.

[kezhenxu94]

@kezhenxu94 any further comments/updates on this? thanks.

@mikhail-dr those files styles.yaml and languages.yaml are not overridable for now, and I didn't expect users to override them at all, we might consider another config to allow users to specify using block comments or inline comments

[mikhail-dr]

ok, thanks.

[kezhenxu94]

@mikhail-dr Thanks to @dongzl 's apache/skywalking-eyes#97 and my apache/skywalking-eyes#100 , now you can configure the comment style like this 👇 to use DocString style

header: # `header` section is configurations for source codes license header.
  # ... other configurations
  language:
    Python:
      extensions:
        - ".py"
      comment_style_id: PythonDocStringStyle