Python Project တစ်ခုကို မှန်ကန်စွာ စတင်တည်ဆောက်နည်း

Virtual environment ဆိုတာ project တစ်ခုအတွက်သီးသန့် Python နှင့် package များကို သိမ်းထားပေးတဲ့ folder တစ်ခုပါ။ ဒါမရှိဘဲ pip install လုပ်လိုက်ရင် package တွေဟာ system တစ်ခုလုံးအတွက် global နေရာမှာ ရောက်သွားပြီး၊ project A က Django 4 လိုချင်၊ project B က Django 5 လိုချင်တဲ့အခါ တစ်ခုနဲ့တစ်ခု ပဋိပက္ခဖြစ်ပါတယ်။ venv က ဒီပြဿနာကို project တစ်ခုချင်းစီအတွက် သီးခြားခွဲထားပေးခြင်းဖြင့် ဖြေရှင်းပါတယ်။

$ mkdir greeter && cd greeter

$ python -m venv .venv

ဖန်တီးပြီးရင် activate လုပ်ရပါမယ် — activate မလုပ်ဘဲ pip install လုပ်မိရင် global ထဲ ပြန်ရောက်သွားပါလိမ့်မယ်။ Activate command က operating system အလိုက် မတူပါဘူး: Linux/macOS မှာ source .venv/bin/activate၊ Windows PowerShell မှာ .venv\Scripts\Activate.ps1၊ Git Bash မှာ source .venv/Scripts/activate ဖြစ်ပါတယ်။ အောင်မြင်ရင် terminal prompt ရှေ့မှာ (.venv) ဆိုတဲ့ စာသားလေး ပေါ်လာပါလိမ့်မယ် — ဒါက အခု venv ထဲမှာ ရောက်နေပြီဆိုတဲ့ အမှတ်အသားပါ။

$ source .venv/bin/activate

Code ကို project root မှာ တိုက်ရိုက်မထားဘဲ src/ folder အောက်မှာ ထားတဲ့ ပုံစံကို 'src layout' လို့ခေါ်ပါတယ်။ အကျိုးကျေးဇူးက ရှင်းပါတယ် — test တွေ run တဲ့အခါ Python က သင့် package ကို install လုပ်ထားသလိုမျိုး ရှာရမှာဖြစ်လို့၊ 'ကျွန်တော့်စက်မှာတော့ import ရတယ်' ဆိုတဲ့ မှားယွင်းသော အောင်မြင်မှုမျိုး မဖြစ်တော့ပါဘူး။ Test က တကယ့် package structure ကို စမ်းသပ်ပေးမှာ ဖြစ်ပါတယ်။

$ mkdir -p src/greeter tests

$ touch src/greeter/__init__.py src/greeter/core.py tests/test_core.py

__init__.py ဖိုင်က folder တစ်ခုကို Python package အဖြစ် သတ်မှတ်ပေးတဲ့ အမှတ်အသားပါ (ဗလာဖြစ်နေလည်း ရပါတယ်)။ ပြီးရင် src/greeter/core.py ထဲမှာ လက်တွေ့ code အနည်းငယ် ရေးထည့်ပါ။

def greet(name: str) -> str:
    """Return a friendly greeting for name."""
    if not name:
        raise ValueError("name must not be empty")
    return f"Hello, {name}!"

pyproject.toml က ခေတ်မီ Python project တွေရဲ့ တစ်ခုတည်းသော configuration file ဖြစ်ပါတယ် — dependency စာရင်း၊ pytest setting၊ ruff setting အားလုံးကို ဒီတစ်ဖိုင်ထဲမှာပဲ ထားနိုင်ပါတယ် (ယခင်က requirements.txt, setup.py, pytest.ini, .flake8 စသဖြင့် ဖိုင်များစွာ ခွဲထားရပါတယ်)။ Project root မှာ အောက်ပါအတိုင်း ဖန်တီးပါ။

[project]
name = "greeter"
version = "0.1.0"
requires-python = ">=3.9"
dependencies = []

[project.optional-dependencies]
dev = ["pytest", "ruff"]

[tool.pytest.ini_options]
pythonpath = ["src"]
testpaths = ["tests"]

[tool.ruff]
line-length = 88

$ python -m pip install pytest ruff

Test ဆိုတာ code မှန်ကန်စွာ အလုပ်လုပ်မလုပ် အလိုအလျောက် စစ်ပေးတဲ့ code ပါ။ အောင်မြင်တဲ့ လမ်းကြောင်း (happy path) တစ်ခုနဲ့ error ဖြစ်သင့်တဲ့ လမ်းကြောင်း တစ်ခု — အနည်းဆုံး နှစ်ခု ရေးတာက စတင်ရန် ကောင်းမွန်တဲ့ အလေ့အထပါ။ tests/test_core.py ထဲမှာ ရေးပါ။

import pytest

from greeter.core import greet


def test_greet_returns_greeting():
    assert greet("Aung") == "Hello, Aung!"


def test_greet_rejects_empty_name():
    with pytest.raises(ValueError):
        greet("")

$ python -m pytest

============================= test session starts =============================
platform win32 -- Python 3.9.7, pytest-8.4.2, pluggy-1.6.0
rootdir: /path/to/greeter
configfile: pyproject.toml
testpaths: tests
collected 2 items

tests/test_core.py ..                                                    [100%]

============================== 2 passed in 0.04s ==============================

ruff က Python အတွက် linter (အမှားနှင့် စာရေးဟန် ပြဿနာများ ရှာဖွေပေးသည်) နှင့် formatter (code ကို ပုံစံတကျ ပြန်စီပေးသည်) နှစ်မျိုးလုံး လုပ်ပေးနိုင်တဲ့ tool တစ်ခုပါ။ ယခင်က flake8, isort, black စတဲ့ tool သုံးမျိုးလောက် ခွဲသုံးရတာကို ruff တစ်ခုတည်းက အစားထိုးပေးနိုင်ပြီး၊ Rust နဲ့ ရေးထားလို့ အလွန်မြန်ပါတယ်။

$ python -m ruff check .

All checks passed!

Format ပြန်စီချင်ရင် ruff format ကို သုံးပါ။ ဒါက code ရဲ့ အလုပ်လုပ်ပုံကို မပြောင်းဘဲ spacing, quote, line break တွေကိုသာ ပုံစံတကျ ပြင်ပေးတာဖြစ်လို့ commit မလုပ်ခင် တစ်ကြိမ် run လိုက်တာက အလေ့အထကောင်းတစ်ခုပါ။

$ python -m ruff format .

နောက်ဆုံးအဆင့်ကတော့ git ထဲ မတင်သင့်တဲ့ ဖိုင်တွေကို .gitignore ဖြင့် ဖယ်ထုတ်ခြင်းပါ — .venv (အရွယ်ကြီးပြီး စက်တစ်လုံးချင်းစီအတွက် သီးသန့်)၊ __pycache__ (Python က အလိုအလျောက် ထုတ်ပေးသော cache)၊ .pytest_cache နှင့် .ruff_cache တို့ ဖြစ်ပါတယ်။

.venv/
__pycache__/
*.py[cod]
.pytest_cache/
.ruff_cache/
.env

$ git init && git add . && git commit -m "Initial project setup"