API

make sure class names are readable

Docs > コード分析 > Static Analysis Rules > make sure class names are readable

このページは日本語には対応しておりません。随時翻訳に取り組んでいます。翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

Metadata

ID: python-best-practices/ambiguous-class-name

Language: Python

Severity: Notice

Category: Best Practices

Description

In some fonts, some characters are indistinguishable from the numerals one and zero, such as, O looks like a zero. Use characters that are not ambiguous.

Non-Compliant Code Examples

class I:  # use i instead
    pass

Compliant Code Examples

class MyClass:
    pass

How to use this rule

1
2
rulesets:
  - python-best-practices     # Rules to enforce Python best practices.

Create a static-analysis.datadog.yml with the content above at the root of your repository
Use our free IDE Plugins or add Code Analysis scans to your CI pipelines
Get feedback on your code

For more information, please read the Code Analysis documentation

VS Code Extension

Identify code vulnerabilities directly in your
VS Code editor

JetBrains Plugin

Identify code vulnerabilities directly in
JetBrains products