Documentație și testare în practică

Principii de inginerie software în Python

Adam Spannbauer

Machine Learning Engineer at Eastman

Documentarea proiectelor cu Sphinx

  Exemplu de pagină Sphinx

Principii de inginerie software în Python

Documentarea claselor

class Document:
    """Analyze text data

    :param text: text to analyze

    :ivar text: text originally passed to the instance on creation
    :ivar tokens: Parsed list of words from text
    :ivar word_counts: Counter containing counts of hashtags used in text
    """
    def __init__(self, text):
        ...
Principii de inginerie software în Python

Testare prin integrare continuă

    Logo Travis CI

Exemplu ieșire Travis - Eșuat

Principii de inginerie software în Python

Testare prin integrare continuă

  Exemplu ieșire Travis - Trecut

Principii de inginerie software în Python

Linkuri și instrumente suplimentare

  • Sphinx - Generați documentație elegantă
  • Travis CI - Testați continuu codul
  • GitHub & GitLab - Găzduiți proiectele cu git
  • Codecov - Identificați unde să îmbunătățiți testele
  • Code Climate - Analizați codul pentru lizibilitate mai bună
Principii de inginerie software în Python

Să exersăm!

Principii de inginerie software în Python

Preparing Video For Download...