bytes method should returns bytes, not string

Docs > Code Analysis > Static Analysis Rules > __bytes__ method should returns bytes, not string

This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

Metadata

ID: python-best-practices/return-bytes-not-string

Language: Python

Severity: Notice

Category: Error Prone

Description

The __bytes__ method should not return a string and instead, ensure to return bytes.

Non-Compliant Code Examples

class MyClass:
    def __bytes__(self):
        pass
        return "123" # should return b"123"

Compliant Code Examples

class MyClass:
    def __bytes__(self):
        pass
        return b"123"

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