blob: c890c0c1f6b71c54fdc6d21fabdf98a3b9716c89 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
---
applyTo: "**/*.py"
---
# Project general coding standards
## Naming Conventions
- Use snake_case for variable and function names.
- Use CamelCase for class names.
- Follow PEP 8 style guidelines.
- Prefix private class members with underscore (\_).
- Use ALL_CAPS for constants.
## Error Handling
- Use try/except blocks for async operations.
- Always log errors with contextual information.
## Coding Guidelines
- Use type annotations / hints for function and method parameters, return types and variables. Follow PEP 484.
- Use newest coding style which is supported by the used Python version.
- Use blank lines to keep code organized and readable.
- Follow PEP 492 – Coroutines with async and await syntax
- Follow PEP 498 – Literal String Interpolation
- Follow PEP 572 – Assignment Expressions
## Code Documentation
- Always write doc strings for all modules, classes, functions, and methods using google docstring style.
- Use typing in doc strings.
- Use short inline comments to explain complex logic.
|
