Maintainability

Case Study: Building Software in Python

Mark Pedigo

Principal Data Scientist

PEP 8

  • Official style guide
  • Guidelines for code layout, naming conventions
  • Improves code readability and maintainability

A programmer diligently following PEP 8 standards

Case Study: Building Software in Python

Advantages of PEP8 code formatting

  • Enhanced readability
    • Consistency
  • Improved collaboration
    • Common style guidelines
  • Reduction in errors
    • Helps avoid common mistakes

Two people collaborating over a computer

Case Study: Building Software in Python

PEP8 and Variable Naming

  • Name indicates clarity and purpose
  • Provides conventions for consistency
  • Clear names help prevent errors
    • Use snake_case convention
    • Distinct names: my_variable versus myVariable

A blue and yellow snake

Case Study: Building Software in Python

How PEP8 Reduces Errors

  • Avoids ambiguous naming
  • Promotes simplicity
  • Encourages consistency
Case Study: Building Software in Python

What Does the Pylint Library Do?

  • Checks code against PEP 8
  • Reviews formatting, naming issues
  • Scores code
  • Provides detailed reports
Case Study: Building Software in Python

Advantages of pylint

  • Error detection
  • Code quality improvement
  • Customization and flexibility
  • pylint myfile.py
Case Study: Building Software in Python

Roadmap

Roadmap showcasing what parts of the project we've finished and which we'll be starting.

Case Study: Building Software in Python

Let's practice!

Case Study: Building Software in Python

Preparing Video For Download...