ლექცია 14 · XIV კვირაLecture 14 · Week XIV

კოდის სტილი
და პაკეტებიCode style
and packages

PEP 8 · style checker-ები · PyPI რეპოზიტორი · პარალელი სხვა ენების პაკეტების მენეჯერებთან PEP 8 · style checkers · the PyPI repository · a parallel with other languages' package managers

მოტივაციაMotivation

რატომ ვწუხდებით სტილზეWhy we care about style

კოდი ერთხელ იწერება და ათჯერ იკითხება — შენივე თავის მიერ, სამი თვის შემდეგ. Code is written once and read ten times — by you, three months from now.

def calc(x,y,z=0):
  a=x*y
  if a>100 :
      b = a*0.9
  else :
      b=a
  return b+z

def calculate_total(price, quantity, shipping=0):
    subtotal = price * quantity

    if subtotal > 100:
        subtotal *= 0.9      # 10% discount

    return subtotal + shipping

კონტექსტიContext

რა არის PEPWhat is a PEP

Python Enhancement Proposal — საჯარო წინადადება ენის განვითარებაზე. ნებისმიერს შეუძლია დაწეროს; საზოგადოება განიხილავს. Python Enhancement Proposal — a public proposal for developing the language. Anyone may write one; the community discusses it.

PEP 8

განლაგებაLayout

# indentation — 4 spaces (not a tab!)
def function():
    if True:
        print("four spaces per level")

# line length — 79 characters at most
# wrap a long line with parentheses:
total = (first_value + second_value
         + third_value + fourth_value)

# two blank lines between functions
def first():
    pass


def second():
    pass


# one blank line — between logical blocks inside a function
def process(data):
    cleaned = data.strip()

    result = cleaned.upper()
    return result

PEP 8

სახელდების კონვენციებიNaming conventions

PEP 8

ჰარეებიWhitespace

x = 5
result = x + y * 2
print(a, b)
def f(a, b=1):
    pass
f(1, b=2)
lst[0]
d["key"]
if x == 1 and y > 2:

x=5
result = x+y * 2
print( a,b )
def f(a, b = 1):
    pass
lst [0]
d ["key"]
if x==1 and y>2 :

PEP 8

იმპორტებიImports

# 1. the standard library
import os
import sys
from pathlib import Path

# 2. third-party packages
import requests
import pandas as pd

# 3. your own modules
from utils import clean_text
from models import Student


# ✗ not like this:
import os, sys                # several on one line
from math import *            # importing everything

• ყველა იმპორტი — ფაილის თავში, docstring-ის შემდეგAll imports go at the top of the file, after the docstring
• სამი ჯგუფი, ცარიელი ხაზით გამოყოფილიThree groups, separated by a blank line
• თითოეულ ჯგუფში — ანბანურადAlphabetical within each group

PEP 20

Zen of Python — import this

ინსტრუმენტებიTooling

Style checker-ებიStyle checkers

პრაქტიკაPractice

Ruff — ერთ წუთშიRuff — in one minute

pip install ruff

ruff check .              # find problems
ruff check . --fix        # fix them automatically
ruff format .             # format the code

# typical output:
main.py:3:1: F401 [*] `os` imported but unused
main.py:7:80: E501 Line too long (94 > 79)
main.py:12:5: E722 Do not use bare `except`
Found 3 errors (2 fixable with `--fix`).

[tool.ruff]
line-length = 88
target-version = "py312"

[tool.ruff.lint]
select = ["E", "F", "I"]   # pycodestyle, pyflakes, isort
ignore = ["E501"]

PyPI

რა არის PyPIWhat is PyPI

PyPI (Python Package Index) — pypi.org — ღია რეპოზიტორი, სადაც ~600 000 პაკეტია განთავსებული. PyPI (the Python Package Index) — pypi.org — an open repository hosting roughly 600,000 packages.

pip

პაკეტების მართვაManaging packages

pip install requests              # install
pip install requests==2.31.0      # a specific version
pip install "requests>=2.28"      # a minimum version
pip install --upgrade requests    # upgrade
pip uninstall requests            # remove

pip list                          # what is installed
pip show requests                 # details of one package
pip freeze                        # exact versions

# inside a virtual environment (see lecture 00)
python -m venv .venv
.venv\Scripts\activate            # Windows
source .venv/bin/activate         # Linux / macOS

გამეორებადობაReproducibility

requirements.txt

# write the current environment into a file
pip freeze > requirements.txt

# restore the same environment on another machine
pip install -r requirements.txt

requests==2.31.0
pandas==2.1.4
matplotlib==3.8.2

თანამედროვე ალტერნატივები: pyproject.toml + poetry ან uv — იგივე იდეა, უფრო მოხერხებული ინსტრუმენტებით. Modern alternatives: pyproject.toml with poetry or uv — the same idea, with more convenient tooling.

ცოცხალი მაგალითიA live example

ჩვენი კურსის პაკეტი PyPI-ზეThis course's own package on PyPI

ეს არაა თეორია — კურსს საკუთარი პაკეტი აქვს გამოქვეყნებული. სცადე ახლავე: This is not theory — the course has its own package published. Try it right now:

pip install kapo-mathtools

from kapo_mathtools import statistics, geometry, text_tools, converters

print(statistics.mean([85, 90, 78, 92]))      # 86.25
print(geometry.circle_area(5))                # 78.53981633974483
print(text_tools.is_palindrome("radar"))      # True
print(converters.celsius_to_fahrenheit(25))   # 77.0

help(statistics.mean)      # bilingual docstring

კონტექსტიContext

პარალელი სხვა ენებთანA parallel with other languages

უსაფრთხოებაSecurity

რაზე უნდა იფიქრო პაკეტის დაყენებამდეWhat to think about before installing a package

• სახელი ზუსტად შეამოწმეrequests vs request vs requestss — თავდამსხმელები განზრახ არეგისტრირებენ მსგავს სახელებს (typosquatting) Check the name exactlyrequests vs request vs requestss — attackers deliberately register lookalike names (typosquatting)
• შეხედე პოპულარობასჩამოტვირთვების რაოდენობა, GitHub-ის ვარსკვლავები, ბოლო განახლების თარიღი Look at how popular it isDownload counts, GitHub stars, the date of the last update
• PyPI მოდერაციას არ ახორციელებსნებისმიერს შეუძლია პაკეტის ატვირთვა. დაყენებისას კოდი შენს კომპიუტერზე სრულდება PyPI does not moderate uploadsAnyone can publish a package. On installation, its code runs on your machine
• ვირტუალური გარემოზღუდავს ზიანს — გლობალურ Python-ს არ ეხება A virtual environmentLimits the damage — it does not touch the global Python

შემაჯამებელიSummary

რა უნდა დაგამახსოვრდესWhat to take away

• PEP — ენის განვითარების წინადადება; PEP 8 სტილის სტანდარტიაA PEP is a proposal for developing the language; PEP 8 is the style standard
• 4 ჰარე · ≤79 სიმბოლო · snake_case · UPPER_CASE · PascalCase4 spaces · ≤79 characters · snake_case · UPPER_CASE · PascalCase
• იმპორტები თავში, სამ ჯგუფად; import * — არასდროსImports at the top in three groups; import * — never
• Ruff ერთ ინსტრუმენტში აერთიანებს linter-სა და formatter-სRuff combines a linter and a formatter in one tool
• PyPI + pip install; გამეორებადობა — requirements.txtPyPI + pip install; reproducibility — requirements.txt
• იგივე იდეა npm, maven, cargo, composer-შიცThe same idea appears in npm, maven, cargo and composer
• უცნობი პაკეტი — ჯერ შეამოწმე, მერე დააყენეAn unfamiliar package — check it first, install it second