Documentazione e test in pratica

Principi di Ingegneria del Software in Python

Adam Spannbauer

Machine Learning Engineer at Eastman

Documentare progetti con Sphinx

  Esempio Pagina Sphinx

Principi di Ingegneria del Software in Python

Documentare le classi

class Document:
    """Analizza dati testuali

    :param text: testo da analizzare

    :ivar text: testo passato all'istanza alla creazione
    :ivar tokens: Lista di parole analizzate dal testo
    :ivar word_counts: Contatore dei hashtag usati nel testo
    """
    def __init__(self, text):
        ...
Principi di Ingegneria del Software in Python

Test di integrazione continua

    Logo Travis CI

Esempio Output Travis - Fallito

Principi di Ingegneria del Software in Python

Test di integrazione continua

  Esempio Output Travis - Superato

Principi di Ingegneria del Software in Python

Link e strumenti aggiuntivi

  • Sphinx - Genera documentazione accattivante
  • Travis CI - Testa continuamente il tuo codice
  • GitHub & GitLab - Ospita i tuoi progetti con git
  • Codecov - Scopri dove migliorare i test dei tuoi progetti
  • Code Climate - Analizza il tuo codice per migliorarne la leggibilità
Principi di Ingegneria del Software in Python

Facciamo pratica

Principi di Ingegneria del Software in Python

Preparing Video For Download...