Skip to content

Latest commit

 

History

History
19 lines (18 loc) · 2.08 KB

cs_python.md

File metadata and controls

19 lines (18 loc) · 2.08 KB

Strong Python Coding Standards

  • Consistent Naming Conventions: Use snake_case for variables, functions, and methods, and PascalCase for classes.
  • PEP 8 Compliance: Follow the PEP 8 style guide for formatting, indentation, line length, and overall code style.
  • Clear and Descriptive Naming: Choose names that clearly describe the purpose and behavior of functions, variables, and classes.
  • Type Annotations: Utilize type hints for function signatures and variable declarations to improve readability and maintainability.
  • Docstrings: Include concise docstrings for modules, classes, and functions to explain functionality and intent.
  • Modular Architecture: Organize code into modules and packages with a clear separation of responsibilities.
  • Error Handling: Implement robust exception handling to manage errors gracefully and maintain code stability.
  • Immutable Defaults: Use immutable objects as default values for function parameters to prevent unintended side effects.
  • Efficient Data Structures: Leverage Python's built-in data structures effectively to optimize performance and memory usage.
  • Code Readability: Write self-documenting code with clear comments and a logical structure that enhances understandability.
  • Testing Practices: Integrate unit tests and continuous testing to ensure code reliability and simplify maintenance.
  • Dependency Management: Manage third-party libraries using virtual environments and dependency files (e.g., requirements.txt).
  • Logging: Implement structured logging for debugging and monitoring, ensuring logs are clear and informative.
  • Security Practices: Adhere to secure coding guidelines to protect against vulnerabilities and ensure data integrity.
  • Continuous Integration: Use automated testing and code quality checks in a CI pipeline to maintain high standards.
  • Version Control Discipline: Maintain clean commit histories and follow branching strategies to streamline collaboration.
  • Performance Optimization: Write efficient code by considering algorithmic complexity and resource management.