Lancez votre package en convertissant des scripts que vous avez déjà écrits. Vous créerez un package simple que vous pourrez utiliser sur votre propre ordinateur.

Démarrer un package

Modules, packages et sous-packages

D’un script à un package

Mettre votre package au travail

Documentation

Rédiger la documentation d’une fonction avec pyment

Rédiger la documentation des fonctions avec pyment II

Documentation de package et de module

Structurer les imports

Imports entre modules frères

Importer depuis les parents

Rendre des fonctions accessibles aux utilisateurs

D’un code épars à un package local

Rendez votre package installable pour vous et pour les autres. Dans ce chapitre, vous apprendrez à gérer les dépendances, à rédiger des README et à inclure des licences. Vous accomplirez aussi toutes les étapes pour publier votre package sur PyPI — le principal hébergement de packages Python.

Installer votre propre package

Ajout du script de configuration

Installer votre package en local

Utiliser les installations modifiables

Gérer les dépendances

Dépendances utilisateur

Dépendances de développement

Ajouter des licences et rédiger des READMEs

Rédiger un README

MANIFEST - Inclure des fichiers supplémentaires avec votre package

Publier votre package

Créer une distribution

Téléverser les distributions

Installer votre package depuis n’importe où

Amenez votre package à un niveau professionnel. Découvrez comment utiliser pytest pour éviter les erreurs, tox pour tester votre package avec plusieurs versions de Python, et flake8 pour maintenir un excellent style de code.

Tester votre package

from impyrial.length.core import inches_to_feet, inches_to_yards


Créer le répertoire de tests

from impyrial.length.core import inches_to_feet, inches_to_yards

# Define tests for inches_to_feet function
def ____():
	# Check that 12 inches is converted to 1.0 foot
    ____ ____(____) == 1.0 
    # Check that 2.5 feet is converted to 30.0 inches
    ____ ____(____, reverse=True) == ____


from impyrial.length.core import inches_to_feet, inches_to_yards

# Define tests for inches_to_feet function
def test_inches_to_feet():
	# Check that 12 inches is converted to 1.0 foot
    assert inches_to_feet(12) == 1.0
    # Check that 2.5 feet is converted to 30.0 inches
    assert inches_to_feet(2.5, reverse=True) == 30.0


Écrire des tests de base

from impyrial.length.core import inches_to_feet, inches_to_yards

# Define tests for inches_to_feet function
def test_inches_to_feet():
	# Check that 12 inches is converted to 1 foot
    assert inches_to_feet(12) == 1.0
    # Check that 2.5 feet is converted to 30 inches
    assert inches_to_feet(2.5, reverse=True) == 30.0
    


"""Conversions between inches and larger imperial length units"""
INCHES_PER_FOOT = 120  # 12.0 inches in a foot
INCHES_PER_YARD = INCHES_PER_FOOT * 3.0  # 3 feet in a yard

UNITS = ("in", "ft", "yd")


def inches_to_feet(x, reverse=False):
    """Convert lengths between inches and feet.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from feet to inches
        instead of the default behaviour of inches to feet.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_FOOT
    else:
        return x / INCHES_PER_FOOT


def inches_to_yards(x, reverse=False):
    """Convert lengths between inches and yards.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from yards to inches
        instead of the default behaviour of inches to yards.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_YARD
    else:
        return x / INCHES_PER_YARD


"""Conversions between inches and larger imperial length units"""
INCHES_PER_FOOT = 12.0  # 12.0 inches in a foot
INCHES_PER_YARD = INCHES_PER_FOOT * 3.0  # 3 feet in a yard

UNITS = ("in", "ft", "yd")


def inches_to_feet(x, reverse=False):
    """Convert lengths between inches and feet.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from feet to inches
        instead of the default behaviour of inches to feet.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_FOOT
    else:
        return x / INCHES_PER_FOOT


def inches_to_yards(x, reverse=False):
    """Convert lengths between inches and yards.
    Parameters
    ----------
    x : array_like
        Lengths in feet.
    reverse : bool, optional
        If this is set to true this function converts from yards to inches
        instead of the default behaviour of inches to yards.
    Returns
    -------
    ndarray
        An array of converted lengths with the same shape as `x`. If `x` is a
        0-d array, then a scalar is returned.
    """
    if reverse:
        return x * INCHES_PER_YARD
    else:
        return x / INCHES_PER_YARD


Exécuter vos tests

Tester votre package dans différents environnements

[tox]
____

[testenv]
____ = 
	____
____ =
	____


[tox]
envlist = py27, py39

[testenv]
deps = 
	pytest
commands =
	pytest


Configurer tox

[tox]
envlist = py27, py39

[testenv]
deps = 
	pytest
commands =
	pytest
    


from setuptools import setup, find_packages

# Add install requirements
setup(
    author="<your-name>",
    description="A package for converting imperial lengths and weights.",
    name="impyrial",
    packages=find_packages(include=["impyrial", "impyrial.*"]),
    version="0.1.0",
    install_requires=['numpy>=1.10', 'pandas'],
    #python_requires="==____.*",
)


from setuptools import setup, find_packages

# Add install requirements
setup(
    author="<your-name>",
    description="A package for converting imperial lengths and weights.",
    name="impyrial",
    packages=find_packages(include=["impyrial", "impyrial.*"]),
    version="0.1.0",
    install_requires=['numpy>=1.10', 'pandas'],
    python_requires="==3.9.*",
)


Exécuter tox

Garder votre package élégant

Filtrage de style approprié

"""Main module."""

def absolute_value(num):
    """Return the absolute value of the number"""
    if num>=0: return num
    else:
    	return -num


"""Main module."""


def absolute_value(num):
    """Return the absolute value of the number"""
    if num >= 0:
        return num
    else:
        return -num


Utiliser flake8 pour nettoyer un fichier

import numpy as np


def calculate_hypotenuse(side1, side2):
    """Calculate the length of the hypotenuse."""
    l = np.sqrt( side1**2 + side2**2 )  # ____: ____
    return l


import numpy as np


def calculate_hypotenuse(side1, side2):
    """Calculate the length of the hypotenuse."""
    l = np.sqrt( side1**2 + side2**2 )  # noqa: E741
    return l


Ignorer des erreurs spécifiques

[flake8]

# Ignore F401 violations in the main __init__.py file
# per-file-ignores =
#     ____ : ____
        
# Ignore all violations in the tests directoory
# exclude = ____


from impyrial.length.api import (
    convert_unit,
    unit_to_mixed,
    mixed_to_unit,
)

def test_convert_unit():
    assert convert_unit(30, "ft", "in")==360.0
    assert convert_unit(30, "yd", "ft")==90.0
    assert convert_unit(10, "mi", "yd")==17600.0


[flake8]

# Ignore F401 violations in the main __init__.py file
per-file-ignores =
    impyrial/__init__.py: F401
        
# Ignore all violations in the tests directoory
exclude = tests/*


Configurer flake8

Améliorer la qualité de votre package

Créez vos packages plus rapidement. Dans ce dernier chapitre, vous apprendrez à utiliser cookiecutter pour générer tous les fichiers d’accompagnement dont votre package a besoin, des Makefiles pour simplifier la publication de nouvelles versions, et vous découvrirez les derniers fichiers à ajouter pour attirer des utilisateurs et des contributeurs.

Accélérez le développement de vos packages avec des modèles

Utiliser des modèles de package

Numéros de version et historique

CONTRIBUTING.md

Fichier d’historique

Suivi de la version avec bumpversion

Makefiles et classificateurs

Classifiers PyPI

Utiliser des Makefiles

Récapitulatif

Développement rapide de packages

Vous copiez et collez souvent le même code entre plusieurs fichiers et vous aimeriez le réutiliser et le partager plus facilement ? Transformer votre code en packages Python peut vous aider ! Dans ce cours, vous allez découvrir la structure d’un package et les fichiers supplémentaires nécessaires pour convertir du code isolé en packages pratiques. Vous verrez aussi l’organisation des imports, la documentation et comment maintenir un style de code cohérent avec flake8. Vous accélérerez ensuite votre développement en créant des modèles et en utilisant cookiecutter pour générer l’ossature d’un package. Enfin, vous apprendrez à utiliser setuptools et twine pour construire et publier vos packages sur PyPI — la scène mondiale des packages Python.

Introduction to Shell

Writing Functions in Python

Découvrez la structure des paquets, l'importation, la documentation, et maintenez le style du code.

Développer des packages Python

Apprenez à créer vos propres packages Python afin de faciliter l'utilisation de votre code et de le partager avec d'autres.

Exécuter tox

Développer des packages Python

Exercice interactif pratique