ლექცია 15 · XV კვირაLecture 15 · Week XV

მოდულები,
პაკეტები, gitModules,
packages, git

import და from · მოდულის მოძებნა და ხელახლა ჩატვირთვა · პაკეტები · ვერსიების კონტროლი · შემაჯამებელი import and from · how a module is found and reloaded · packages · version control · the wrap-up

დღეს ასევე: პრაქტიკული დავალება #5 Also today: practical assignment #5

გამეორება · ლექციები 13–14Review · lectures 13–14

შემოწმება — 8 კითხვაCheck yourself — 8 questions

ცნებაThe concept

მოდული — უბრალოდ .py ფაილიA module is just a .py file

ყოველი Python-ის ფაილი უკვე მოდულია. საკმარისია მისი იმპორტი. Every Python file already is a module. All you have to do is import it.

"""მათემატიკური დამხმარე ფუნქციები. / Mathematical helper functions."""

PI = 3.14159


def circle_area(r):
    return PI * r ** 2


def is_prime(n):
    if n < 2:
        return False
    for d in range(2, int(n ** 0.5) + 1):
        if n % d == 0:
            return False
    return True

import mathtools

print(mathtools.PI)
print(mathtools.circle_area(5))
print(mathtools.is_prime(17))

სინტაქსიSyntax

import დაand from

# 1. the whole module — the name is always visible
import mathtools
print(mathtools.circle_area(5))

# 2. specific names
from mathtools import circle_area, PI
print(circle_area(5))

# 3. an alias
import mathtools as mt
print(mt.circle_area(5))

from mathtools import circle_area as area
print(area(5))

# 4. ✗ everything — never
from mathtools import *

მნიშვნელოვანიImportant

if __name__ == "__main__":

def circle_area(r):
    return PI * r ** 2


print("test:", circle_area(1))     # ⚠ this also runs on import!

def circle_area(r):
    return PI * r ** 2


if __name__ == "__main__":
    # runs only when the file is executed directly
    print("test:", circle_area(1))

მექანიზმიThe mechanism

სად ეძებს Python მოდულსWhere Python looks for a module

import sys

for path in sys.path:
    print(path)

1. მიმდინარე საქაღალდე (სკრიპტის ადგილმდებარეობა)The current folder (where the script lives)
2. გზები, რომლებიც PYTHONPATH გარემოს ცვლადშია მითითებულიThe paths listed in the PYTHONPATH environment variable
3. სტანდარტული ბიბლიოთეკის საქაღალდეებიThe standard library folders
4. site-packages — სადაც pip აყენებს პაკეტებსsite-packages — where pip installs packages

import importlib
import mathtools

importlib.reload(mathtools)    # the code changed — read it again

მოდული სესიაზე ერთხელ იტვირთება. ჩვეულებრივ სკრიპტში ეს არ გვაწუხებს, მაგრამ REPL-ში ან Jupyter-ში reload გამოგადგება. A module is loaded once per session. In an ordinary script this never bothers us, but in the REPL or in Jupyter reload comes in handy.

სტრუქტურაStructure

პაკეტი — მოდულების საქაღალდეA package is a folder of modules

myproject/
├── main.py
├── requirements.txt
├── .gitignore
└── tools/
    ├── __init__.py
    ├── mathtools.py
    └── textutils.py

from tools.mathtools import circle_area
from tools import textutils

import tools.mathtools as mt

print(circle_area(5))
print(textutils.clean("  ტექსტი  "))

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

ნამდვილი პაკეტი, რომელიც შეგიძლია წაიკითხოA real package you can go and read

ზუსტად ის სტრუქტურა, რაზეც ახლა ვსაუბრობდით — ცოცხალ პროექტში: Exactly the structure we just described — in a live project:

library/
├── pyproject.toml            the package description: name, version, license
├── README.md                 this text appears on the PyPI page
├── LICENSE
├── kapo_mathtools/           ← the package itself
│   ├── __init__.py           from . import statistics, geometry, ...
│   ├── statistics.py
│   ├── geometry.py
│   ├── text_tools.py
│   └── converters.py
├── tests/                    26 tests
└── examples/demo.py

__version__ = "0.4.0"

from . import converters, geometry, statistics, text_tools

__all__ = ["statistics", "geometry", "text_tools", "converters", "__version__"]

ვერსიების კონტროლიVersion control

რა პრობლემას წყვეტს gitWhat problem git solves

main.py
main_v2.py
main_v2_final.py
main_v2_final_FIXED.py
main_v2_final_FIXED_ok.py

git

საბაზისო ბრძანებებიThe basic commands

# once, per machine
git config --global user.name "Firstname Lastname"
git config --global user.email "you@example.com"

# inside a project
git init                    # create the repository
git status                  # what changed

git add main.py             # stage a file
git add .                   # stage everything
git commit -m "add the loops assignment"

git log --oneline           # the history
git diff                    # what changed since the last commit

git checkout main.py        # discard the changes in a file

git

განშტოებები და GitHubBranches and GitHub

git branch feature-menu       # a new branch
git switch feature-menu       # move onto it
git switch -c feature-menu    # both at once

git switch main               # back to main
git merge feature-menu        # merge the changes in

git remote add origin https://github.com/user/project.git
git push -u origin main       # upload
git pull                      # download
git clone https://github.com/user/project.git

git

.gitignore — რას არ ვინახავთwhat we do not keep

# Python
__pycache__/
*.pyc
.venv/
venv/

# environment and secrets
.env
config_secret.py

# editor
.vscode/
.idea/

# operating system
.DS_Store
Thumbs.db

# data
*.log
data/temp/

მზა შაბლონები: github.com/github/gitignore Ready-made templates: github.com/github/gitignore

შეფასებაAssessment

პრაქტიკული დავალება #5Practical assignment #5

8 ქულა · სრულდება აუდიტორიაში, დამოუკიდებლად 8 points · done in class, individually

1. მოდულად დაშლაწინა დავალება დაშალე: tools/mathtools.py, tools/textutils.py, main.py Split into modulesBreak up your previous assignment: tools/mathtools.py, tools/textutils.py, main.py
2. __init__.pyშექმენი პაკეტი და გამოიყენე from tools.mathtools import ... __init__.pyMake it a package and use from tools.mathtools import ...
3. if __name__ == "__main__":თითოეულ მოდულს დაუმატე საკუთარი ტესტ-ბლოკი if __name__ == "__main__":Give every module its own small test block
4. gitgit init → .gitignore → მინიმუმ 3 აზრიანი commit gitgit init → .gitignore → at least 3 meaningful commits
5. ატვირთვაატვირთე GitHub-ზე და დაამატე README.md პროექტის აღწერით PublishPush it to GitHub and add a README.md describing the project

შემაჯამებელი ლექციაThe wrap-up

რა ვისწავლეთ სემესტრშიWhat we learned this semester

შეფასებაAssessment

დასკვნითი გამოცდაThe final exam

გაგრძელებაWhat comes next

სად წავიდეთ აქედანWhere to go from here