Rozjeď svůj balíček tak, že převedeš skripty, které už máš napsané. Vytvoříš jednoduchý balíček, který budeš moct používat na vlastním počítači.

Začínáme tvořit balíček

Možnosti

Modul

Balíček

Subbalíček

Moduly, balíčky a subbalíčky

# Open the text file
with open('alice.txt') as file:
    text = file.read()

n = 0
for word in text.split():
    # Count the number of times the words in the list appear
    if word.lower() in ['cat', 'cats']:
        n += 1

print('Lewis Carroll uses the word "cat" {} times'.format(n))


def count_words(filepath, words_list):
    # Open the text file
    with open(filepath) as file:
        text = file.read()
    
    n = 0
    for word in text.split():
        # Count the number of times the words in the list appear
        if word.lower() in words_list:
            n += 1
    return n


Ze skriptu k balíčku

def count_words(filepath, words_list):
    # Open the text file
    with open(filepath) as file:
        text = file.read()
    # Count number of times these words appear
    n = 0
    for word in text.split():
        if word.lower() in words_list:
            n += 1
    return n


from textanalysis.textanalysis import count_words

# Count the number of positive words
nb_positive_words = ____(____, [____, ____])

# Count the number of negative words
nb_negative_words = ____(____, ____)

print("{} positive words.".format(nb_positive_words))
print("{} negative words.".format(nb_negative_words))


from textanalysis.textanalysis import count_words

# Count the number of positive words
nb_positive_words = count_words('hotel-reviews.txt', ['good', 'great'])

# Count the number of negative words
nb_negative_words = count_words('hotel-reviews.txt', ['bad', 'awful'])

print("{} positive words.".format(nb_positive_words))
print("{} negative words.".format(nb_negative_words))


Využij svůj balíček v praxi

Dokumentace

INCHES_PER_FOOT = 12.0  # 12 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):
    if reverse:
        return x * INCHES_PER_FOOT
    else:
        return x / INCHES_PER_FOOT


INCHES_PER_FOOT = 12.0  # 12 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):
    """

    Parameters
    ----------
    x :

    reverse :
         (Default value = False)

    Returns
    -------

    """
    if reverse:
        return x * INCHES_PER_FOOT
    else:
        return x / INCHES_PER_FOOT


# Run the following command in the console
# pyment -w -o numpydoc impyrial/length/core.py

Psaní dokumentace funkcí pomocí pymentu

INCHES_PER_FOOT = 12.0  # 12 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):
    """

    Parameters
    ----------
    x :

    reverse :
         (Default value = False)

    Returns
    -------

    """
    if reverse:
        return x * INCHES_PER_FOOT
    else:
        return x / INCHES_PER_FOOT


INCHES_PER_FOOT = 12.0  # 12 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 : numpy.ndarray
        Lengths in feet.
    reverse : bool, optional
        If true this function converts from feet to inches 
        instead of the default behavior of inches to feet. 
        (Default value = False)

    Returns
    -------
    numpy.ndarray
    """
    if reverse:
        return x * INCHES_PER_FOOT
    else:
        return x / INCHES_PER_FOOT


Psaní dokumentace funkcí pomocí pyment II

"""
impyrial
========
A package for converting between imperial measurements of length and weight.
"""


"""
impyrial.length
===============
Length conversion between imperial units.
"""


"""Conversions between inches and larger imperial length units"""
INCHES_PER_FOOT = 12.0  # 12 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 : numpy.ndarray
        Lengths in feet.
    reverse : bool, optional
        If true this function converts from feet to inches 
        instead of the default behavior of inches to feet. 
        (Default value = False)

    Returns
    -------
    numpy.ndarray
    """
    if reverse:
        return x * INCHES_PER_FOOT
    else:
        return x / INCHES_PER_FOOT


Dokumentace balíčku a modulů

Strukturování importů

from ____ import ____

result = convert_unit(10, 'in', 'yd')
print(result)


"""User-facing functions."""
from ____ import (
    ____,
    ____,
    ____
)


def convert_unit(x, from_unit, to_unit):
    """Convert from one length unit to another.

    Parameters
    ----------
    x : array_like
        Lengths to convert.
    from_unit : {'in', 'ft', 'yd'}
        Unit of the input lengths `x`
    to_unit : {'in', 'ft', 'yd'}
        Unit of the returned lengths

    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.
    """
    # Convert length to inches
    if from_unit == "in":
        inches = x
    elif from_unit == "ft":
        inches = inches_to_feet(x, reverse=True)
    elif from_unit == "yd":
        inches = inches_to_yards(x, reverse=True)

    # Convert inches to desired units
    if to_unit == "in":
        value = inches
    elif to_unit == "ft":
        value = inches_to_feet(inches)
    elif to_unit == "yd":
        value = inches_to_yards(inches)

    return value


from impyrial.length.api import convert_unit

result = convert_unit(10, 'in', 'yd')
print(result)


"""User-facing functions."""
from impyrial.length.core import (
    UNITS,
    inches_to_feet,
    inches_to_yards
)


def convert_unit(x, from_unit, to_unit):
    """Convert from one length unit to another.

    Parameters
    ----------
    x : array_like
        Lengths to convert.
    from_unit : {'in', 'ft', 'yd'}
        Unit of the input lengths `x`
    to_unit : {'in', 'ft', 'yd'}
        Unit of the returned lengths

    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.
    """
    # Convert length to inches
    if from_unit == "in":
        inches = x
    elif from_unit == "ft":
        inches = inches_to_feet(x, reverse=True)
    elif from_unit == "yd":
        inches = inches_to_yards(x, reverse=True)

    # Convert inches to desired units
    if to_unit == "in":
        value = inches
    elif to_unit == "ft":
        value = inches_to_feet(inches)
    elif to_unit == "yd":
        value = inches_to_yards(inches)

    return value


Importy mezi moduly

from impyrial.length.api import convert_unit

# Make sure unit checking is working by trying examples
print('The following line should run:')
result1 = convert_unit(10, 'in', 'yd')
print(result1)

print('The following line should cause an error:')
result2 = convert_unit(10, 'lb', 'yd')
print(result2)


"""User-facing functions."""
# Import the check_units function
____
from impyrial.length.core import (
    UNITS,
    inches_to_feet,
    inches_to_yards,
)


def convert_unit(x, from_unit, to_unit):
    """Convert from one length unit to another.

    Parameters
    ----------
    x : array_like
        Lengths to convert.
    from_unit : {'in', 'ft', 'yd'}
        Unit of the input lengths `x`
    to_unit : {'in', 'ft', 'yd'}
        Unit of the returned lengths

    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.
    """
    # Check if units are valid length units
    check_units(from_unit, to_unit, UNITS)
    
    # convert length to inches
    if from_unit == "in":
        inches = x
    elif from_unit == "ft":
        inches = inches_to_feet(x, reverse=True)
    elif from_unit == "yd":
        inches = inches_to_yards(x, reverse=True)

    # Convert inches to desired units
    if to_unit == "in":
        value = inches
    elif to_unit == "ft":
        value = inches_to_feet(inches)
    elif to_unit == "yd":
        value = inches_to_yards(inches)

    return value


"""User-facing functions."""
# Import the check_units function
from impyrial.utils import check_units
from impyrial.length.core import (
    UNITS,
    inches_to_feet,
    inches_to_yards,
)


def convert_unit(x, from_unit, to_unit):
    """Convert from one length unit to another.

    Parameters
    ----------
    x : array_like
        Lengths to convert.
    from_unit : {'in', 'ft', 'yd'}
        Unit of the input lengths `x`
    to_unit : {'in', 'ft', 'yd'}
        Unit of the returned lengths

    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.
    """
    # Check if units are valid length units
    check_units(from_unit, to_unit, UNITS)
    
    # Convert length to inches
    if from_unit == "in":
        inches = x
    elif from_unit == "ft":
        inches = inches_to_feet(x, reverse=True)
    elif from_unit == "yd":
        inches = inches_to_yards(x, reverse=True)

    # Convert inches to desired units
    if to_unit == "in":
        value = inches
    elif to_unit == "ft":
        value = inches_to_feet(inches)
    elif to_unit == "yd":
        value = inches_to_yards(inches)

    return value


Import z nadřazených modulů

# This is the __init__.py file for the impyrial/length subpackage

# Import the convert_unit function from the api.py module
____


# This is the top level __init__.py file

# Import the length subpackage
____


import impyrial

result = impyrial.length.convert_unit(10, 'in', 'yd')
print(result)


# This is the __init__.py file for the impyrial/length subpackage

# Import the convert_unit function from the api.py module
from .api import convert_unit


# This is the top level __init__.py file

# Import the length subpackage
from . import length


Zpřístupnění funkcí uživatelům

Od volného kódu k lokálnímu balíčku

Připrav svůj balíček k instalaci – pro sebe i pro ostatní. V této kapitole se naučíš pracovat se závislostmi, psát README soubory a přidávat licence. Projdeš také všechny kroky potřebné k publikování balíčku na PyPI – hlavním místě pro Python balíčky.

Instalace vlastního balíčku

Přidání instalačního skriptu

Lokální instalace balíčku

Využití editovatelných instalací

Práce se závislostmi

Závislosti pro uživatele

Vývojové závislosti

Licence a soubory README

Psaní README

MANIFEST – přidání dalších souborů do balíčku

Publikování balíčku

Sestavení distribuce

Nahrání distribucí

Instaluj svůj balíček odkudkoli

Posuň svůj balíček na profesionální úroveň. Zjistíš, jak používat pytest k odhalování chyb, tox k testování kompatibility s různými verzemi Pythonu a flake8 k udržování čistého stylu kódu.

Testování balíčku

Vytvoření testovacího adresáře

Píšeme základní testy

Spouštění testů

Testování balíčku v různých prostředích

Nastavení tox

Spuštění tox

Udržuj svůj balíček ve stylu

Vhodné filtrování stylu

Úprava souboru pomocí flake8

Ignorování konkrétních chyb

Konfigurace flake8

Zvyšování kvality balíčku

Vytvárej balíčky rychleji. V této závěrečné kapitole se naučíš používat cookiecutter k automatickému generování podpůrných souborů, Makefiles ke zjednodušení vydávání nových verzí a seznámíš se s posledními soubory, které balíčku pomůžou přilákat uživatele i přispěvatele.

Rychlejší vývoj balíčků pomocí šablon

Použití šablon balíčků

Čísla verzí a historie

CONTRIBUTING.md

Soubor HISTORY

Sledování čísla verze pomocí bumpversion

Makefile a klasifikátory

Klasifikátory PyPI

Používání Makefile

Závěr

Rychlý vývoj balíčků

Kopíruješ stále stejný kód mezi soubory a přeješ si, aby bylo snazší ho znovu používat a sdílet? Řešením jsou Python balíčky! V tomto kurzu se naučíš, jak jsou balíčky strukturované a jaké soubory potřebuješ, abys z volně napsaného kódu vytvořil/a praktický balíček. Zjistíš také, jak fungují importy, jak psát dokumentaci a jak udržovat čistý styl kódu pomocí flake8. Pak zrychlíš vývoj díky šablonám a nástroji cookiecutter, který ti vygeneruje základní strukturu balíčku. Na závěr se naučíš, jak pomocí setuptools a twine sestavit balíček a publikovat ho na PyPI – hlavním místě pro sdílení Python balíčků.

Introduction to Shell

Writing Functions in Python

Naučte se strukturu balíčků, importy, dokumentaci a udržování stylu kódu, pak publikujte šablony.

Developing Python Packages

Vytvářejte vlastní balíčky Python, aby se váš kód snadněji používal a sdílel s ostatními.

Psaní dokumentace funkcí pomocí pymentu

Developing Python Packages

Interaktivní praktické cvičení