Git — это распределенная система управления версиями, предназначенная для отслеживания изменений в коде и обеспечения удобной командной работы.

Дополнительно: Сравнение Merge vs Rebase — https://www.atlassian.com/ru/git/tutorials/merging-vs-rebasing

1. Создать фичу и отправить на сервер

git checkout -b feature/login                 # Создание новой ветки
git add . && git commit -m "feat: login page" # Зафиксировать изменения
git push -u origin feature/login              # Отправить и создать удалённую ветку

2. Подтянуть изменения из main и обновить свою ветку (Merge-вариант) Этот процесс позволяет вам получить последние изменения из главной ветки (main) и интегрировать их в вашу рабочую ветку (feature/login), используя слияние (merge).

git checkout main            # 1. Переключиться на главную ветку
git fetch && git pull        # 2. Получить все удаленные ветки и обновить локальную main
git checkout feature/login   # 3. Вернуться на свою ветку
git merge main               # 4. Слить изменения из main в текущую ветку

• Исключаем: сборочные директории (build/, dist/), кеши (pip-cache/, pycache/), логи, артефакты инструментов (.tox, coverage), секреты и конфиги.
• Конфиги IDE (например, .idea/ / .pycharm/) хранить в Git обычно не нужно.

Дополнительно: Генератор gitignore — https://www.toptal.com/developers/gitignore

Наименование коммитов по соглашению Conventional Commits помогает автоматизировать задачи (например, генерацию лога изменений) и делает историю проекта чистой и понятной. 1. Тип (<type>)

2. Примеры хороших коммитов

❌ Плохо vs ✅ Хорошо

Чистый заголовок коммита должен быть кратким, на английском языке (в повелительном наклонении) и ясным.

Ветки должны отражать их назначение и включать тип и/или номер задачи из вашего трекера.

Для создания репозитория на GitHub у вас уже должен быть создан профиль на платформе. Пройти процесс регистрации можно на официальном сайте GitHub.

После этого необходимо перейти на свою страницу GitHub и переключиться на вкладку «Repositories».

После нажать на зеленую кнопку «New».

В открывшемся меню необходимо указать имя репозитория, описание (по желанию), выбрать настройки приватности (публичный или закрытый репозиторий) и добавить вспомогательные файлы (README-файл, gitignore и лицензию).

После того как поля страницы будут заполнены, необходимо нажать на зеленую кнопку «Create repository». Новый репозиторий будет создан.

После создания нового пустого репозитория пользователя обычно встречает страница самого репозитория с кратким руководство по работе с ним. В этот момент репозиторий хранится удаленно на серверах GitHub и доступ к нему может получить его владелец и круг его доверенных лиц.

Репозиторий можно клонировать на локальную машину и работать с его содержимым на своем компьютере. Актуальные изменения можно синхронизировать с удаленным репозиторием и всеми его участниками.

Для клонирования репозитория с помощью PyCharm для начала необходимо скопировать ссылку на репозиторий, которую можно получить на начальной странице репозитория.

Далее переходим в PyCharm, переключаемся на вкладку «VCS» и выбираем пункт «Get from Version Control».

Вставляем ссылку в поле URL и нажимаем кнопку «Clone».

После того как мы внесли изменения в проект, их необходимо зафиксировать в нашем репозитории. Для этого на боковой панели слева есть вкладка «Commit». Переходим в нее, выбираем файлы для коммита и указываем осмысленное сообщение к коммиту, такое, чтобы новый человек в проекте мог понять суть и необходимость совершенного коммита.

Коммит и все изменения должны оказаться на удаленном репозитории. Для этого необходимо перейти во вкладку «Git» и выбрать пункт «Push».

README (от англ. "Read Me" — "Прочти меня") — это текстовый файл, который является первым контактом пользователя или другого разработчика с вашим проектом. Это самый важный файл, который обычно находится в корневой директории любого репозитория (например, на GitHub).

• Лицо проекта: Это "витрина" или "лицо" вашего проекта. Он должен сразу объяснить, что это за проект и зачем он нужен.
• Быстрый старт: Предоставляет критически важные сведения, чтобы кто-то мог быстро понять, как установить, запустить и использовать код.
• Документация: Служит краткой, но структурированной документацией по основным аспектам проекта.

1. Название и краткое описание: Заголовок и 1-2 предложения о сути проекта.
2. Установка (Installation): Пошаговая инструкция, как установить все необходимые зависимости.
3. Использование (Usage) / Быстрый старт: Примеры кода или команды для запуска проекта.
4. Функциональность (Features): Что умеет делать проект.
5. Технологический стек: Какие языки и фреймворки использованы.
6. Участие (Contributing): Правила для тех, кто хочет внести свой вклад.
7. Лицензия: Информация о лицензии, под которой распространяется код.

Чаще всего файл называется README.md, где .md означает, что он написан с использованием синтаксиса Markdown. Это позволяет красиво форматировать текст (заголовки, списки, кодовые блоки) для отображения на веб-платформах, таких как GitHub или GitLab.

Оформление README.md: https://gist.github.com/alinastorm/8a04cdbc36be9c051a66f90ae6d6df35

Виртуальное окружение — это локальная, изолированная "копия" интерпретатора Python и набора библиотек для конкретного проекта. Как работает: Инструмент (например, venv) создает каталог (например, .venv/ или env/) с копией интерпретатора и изменяет переменные окружения среды, чтобы все команды (pip, python) работали внутри этого изолированного каталога.

1. При создании нового проекта При инициализации нового проекта PyCharm автоматически предлагает настроить изолированное окружение.

1. Запуск PyCharm и выбор "New Project" (Новый проект).
2. В окне "New Project" найдите раздел "Python Interpreter" (Интерпретатор Python).
3. Из выпадающего меню выберите тип:
   • "Virtualenv" (Виртуальное окружение).
   • Или "Poetry" / "Conda" (если вы используете эти менеджеры).
4. Укажите расположение (Location): PyCharm по умолчанию предлагает создать папку окружения (.venv или env) внутри каталога проекта.
5. Выберите базовый интерпретатор (Base interpreter): Укажите путь к системной установке Python (например, Python 3.11), который будет служить основой для нового окружения.
6. Нажмите "Create" (Создать).

PyCharm автоматически создаст изолированное окружение и привяжет его к вашему проекту.

2. Для существующего проекта (Через настройки) Если вы клонировали проект без окружения, или вам нужно изменить/добавить интерпретатор:

1. Откройте проект в PyCharm.
2. Перейдите в Settings/Preferences (клавиши: Ctrl+Alt+S или ⌘,).
3. В дереве слева выберите "Project: [Имя проекта]" → "Python Interpreter".
4. Нажмите на значок ⚙️ (Шестеренка) справа от поля "Python Interpreter" и выберите "Add..." (Добавить...).
5. В окне "Add Python Interpreter" выберите "Virtualenv Environment".
   • Выберите "New environment" (Новое окружение).
   • Укажите расположение и базовый интерпретатор.
6. Нажмите "OK".

PyCharm создаст окружение и автоматически установит его как активный интерпретатор для текущего проекта. После создания виртуального окружения (.venv или env/) обязательно откройте новый терминал или перезапустите текущий. Это гарантирует, что переменные среды корректно подтянутся, и все последующие команды (python, pip) будут использовать правильный изолированный интерпретатор вашего проекта

Зависимости в Python можно задавать вручную, но в больших проектах с огромным количеством библиотек это бывает неудобно и долго. Поэтому нужно создать специальный файл, прописать в нем все зависимости и система сама все подключит.

Для это создаем в проекте файл requirements.txt и на каждой новой строке прописываем отдельную зависимость. После заполнения файла PyCharm сам поймет, что мы хотим сделать и предложит установить библиотеки. Для этого следует нажать кнопку «Install requirements».

Важно отметить: В этом случаем система установит последнюю доступную версию. Если необходимо установить специальную версию или ту, у которой не было официально релиза, то это необходимо указать в файле requirements.txt вручную. Для этого необходимо указать имя библиотеки и через знак == версию, которую необходимо установить. К примеру, selene==2.0.0rc7. Также можно указать версию с помощью знака >=. К примеру, selene>=2.0.0rc7, это означает что система установит последнюю версию библиотеки, которая не ниже 2.0.0rc7 включая версию которая указана после равно.

Если зависимостей много и не отображается кнопка «Install requirements», то можно воспользоваться командой pip install -r requirements.txt которую необходимо ввести в терминал проекта. Эта команда установит все зависимости из файла requirements.txt.

Также управлять зависимостями можно через терминал

Инструменты, такие как Poetry или uv, используются для более надёжной фиксации версий, управления зависимостями проекта и его метаданными. Конфигурация хранится в файле pyproject.toml.

Пример файла pyproject.toml

# Метаданные проекта
[project]
name = "qa-demo"
version = "0.1.0"
# Список зависимостей проекта
dependencies = [
    "pytest>=8", 
    "selenium>=4"
]

# Настройки для инструментов
[tool.pytest.ini_options]
addopts = "-ra -q"
testpaths = ["tests"]

Соблюдение стандартов и использование автоматических инструментов критически важно для читабельности, поддерживаемости и стабильности кода в командной разработке.

PEP 8 — это набор рекомендаций о том, "как писать питоновский код читабельно". Это краткий, но исчерпывающий чек-лист по форматированию, именованию и структуре кода.

Полная документация: https://peps.python.org/pep-0008/

PEP 20 — набор из 19 принципов, лежащих в основе языка Python, которые помогают писать понятный и красивый код.

Линтеры — это инструменты статического анализа кода. Они ищут ошибки, неочевидные баги, несоблюдение стиля, "пахнущий" код и т.д. https://peps.python.org/pep-0008/

• Обеспечение единого стиля и читабельности.
• Раннее обнаружение багов и антипаттернов (до запуска).
• Более стабильные PR и быстрые ревью.
• Автоматизация проверок в CI/CD.

Эти плагины расширяют возможности стандартного запуска тестов pytest:

Полный список плагинов: https://docs.pytest.org/en/stable/reference/plugin_list.html

Перед отправкой изменений в удалённый репозиторий убедитесь, что:

1. Тесты локально зелёные (pytest -q).
2. Выполнен прогон линтеров/форматтеров (ruff/black/isort).
3. Коммиты атомарные, а их сообщения — информативные (см. правила именования коммитов).
4. Секретов и лишних артефактов в Git нет (.gitignore в порядке).
5. README (при необходимости) обновлён.

Важно: в Pytest есть некоторые правила, которые необходимо соблюдать, чтобы корректно запускались тесты.
Все файлы, в которых написаны тесты, должны начинаться или заканчиваться на слово test. К примеру, test_google.py или google_test.py.
Все функции с тестами должны начинаться с префикса test. К примеру, def test_first().

Простой тест на Pytest, который просто запускается и ничего не делает, выглядит следующим образом:

def test_first():
    pass

Чтобы запустить, тест необходимо нажать на зеленую стрелку рядом с названием функции. В открывшемся окне выбрать Run 'pytest in test_something'.

Если не отображается зеленая стрелка, то нужно перейти в настройки проекта и в разделе Tools выбрать Python Integrated Tools. В открывшемся окне в разделе Testing выбрать Default test runner и в выпадающем списке выбрать pytest. И далее нажать Apply и Ok.

После запуска, результат теста будет отображен в консоли. Если тест не падает, то в консоли будет сообщение Process finished with exit code 0.

Также можно запустить тесты через терминал, для этого необходимо в терминале ввести команду pytest. Команда pytest запустит все тесты в проекте. Если необходимо запустить только один тест, то нужно указать его название через двоеточие. К примеру, pytest test_google.py::test_first. Если его запустить, то в терминале появится подробное сообщение с информацией о запуске теста.

Если мы напишем тест, который будет падать, то система подробно расскажет обо всех ошибках. И выделит конкретные строчки, на которых тест падает.

def test_sum():
    a = 5
    b = 10
    assert a == b

Следующим образом можно выводить в консоль сообщения во время падения теста:

def test_first():
    assert 1 == 1

def test_second():
    assert 1 == 2, "Единица не должна быть равна двойке"

Текст в кавычках будет выведен в консоль вместе с сообщением об ошибке. Это может быть полезно для быстрого понимания, что пошло не так. Текст в кавычках это просто текст который не изменяется в зависимости от того, что произошло в тесте.

Фикстуры в Pytest — это функции, которые могут вызываться перед тестом или после него. Фикстуры могут быть полезны для подготовки тестовых данных или окружения. Все фикстуры должны быть описаны в файле conftest.py.

Для того чтобы создать фикстуру необходимо создать функцию с декоратором @pytest.fixture(). Внутри функции можно указать необходимые действия, которые будут выполняться при вызове фикстуры. Синтаксис фикстур:

@pytest.fixture()
def before_each():
    print("Called before each test")

def test_first(before_each):
    assert 1 == 1

Для того чтобы увидеть дерево вызовов фикстур можно воспользоваться командой pytest fixtures.py ----setup-plan, где fixtures.py название файла с тестами. В консоли будет выведено дерево вызовов фикстур.

import pytest


@pytest.fixture
def login_page(browser):
    print("Логин пейдж!")


@pytest.fixture
def user():
    print("Юзер!")
    return "username", "password"


def test_login(login_page, user):
    username, password = user
    assert username == "username"
    assert password == "password"


def test_logout(login_page, user):
    username, password = user
    assert username == "username"
    assert password == "password"
    

Чтобы реализовать teardown, необходимо использовать ключевое слово yield. Все что будет после yield будет выполняться после теста. Разница между yield и return в том, что yield позволяет выполнить код после теста, а return нет, так как после return выполнение функции прекращается. Return можно использовать, для того чтобы вернуть значение из фикстуры.

import pytest


@pytest.fixture(scope="function")
def browser_settings():
    print("Браузер!")

    yield

    print("Закрываем браузер!")

При запуске теста в консоли видно, что сначала вызывается фикстура browser_settings_, которая печатает Браузер!, затем вызывается тест, и после теста вызывается снова фикстура browser_settings, которая печатает Закрываем браузер!.

В фикстурах используются scope, который позволяет указать, когда будет вызываться фикстура. Возможные значения:

• function — фикстура будет вызываться перед каждым тестом. Это значение по умолчанию и можно не указывать его явно.
• class — фикстура будет вызываться перед всеми тестами в классе. И если в классе несколько тестов, то фикстура будет вызываться один раз перед всеми тестами в классе и один раз после всех тестов в классе.
• module — фикстура будет вызываться перед всеми тестами в модуле. Будет вызываться один раз перед всеми тестами в модуле и один раз после всех тестов в модуле.
• session — фикстура будет вызываться перед всеми тестами в сессии. Будет вызываться один раз перед всеми тестами в сессии и один раз после всех тестов в сессии.
• package — фикстура будет вызываться перед всеми тестами в пакете. Будет вызываться один раз перед всеми тестами в пакете и один раз после всех тестов в пакете.

import pytest

@pytest.fixture(scope="function")
def my_fixture():
    # ...

def test_foo(my_fixture):
    # ...

def test_bar(my_fixture):
    # ...

import pytest

@pytest.fixture(scope="class")
def my_fixture():
    # ...

class TestClass:
    def test_foo(self, my_fixture):
        # ...

    def test_bar(self, my_fixture):
        # ...

import pytest

@pytest.fixture(scope="module")
def my_fixture():
    # ...

def test_foo(my_fixture):
    # ...

def test_bar(my_fixture):
    # ...

import pytest

@pytest.fixture(scope="session")
def my_fixture():
    # ...

def test_foo(my_fixture):
    # ...
    
def test_bar(my_fixture):
    # ...

import pytest

@pytest.fixture(scope="package")
def my_fixture():
    # ...

def test_foo(my_fixture):
    # ...

def test_bar(my_fixture):
    # ...

browser.config.window_height = 1080  # задает высоту окна браузера
browser.config.window_width = 1920  # задает ширину окна браузера
browser.quit() # закрывает браузер после выполнения теста

@pytest.fixture()
def setting_browser():
    # задаем размер окна браузера (вместо этого комментария нужно подставить код из примера выше как задать размер окна браузера)
    yield 
    # закрываем браузер после выполнения теста (вместо этого комментария нужно подставить код из примера выше как закрыть браузер)

def test_first(setting_browser):
    browser.open("https://www.google.com/")

def test_second(setting_browser):
    browser.open("https://www.google.com/")

@pytest.fixture(autouse=True)
def setting_browser():
    # задаем размер окна браузера (вместо этого комментария нужно подставить код из примера выше как задать размер окна браузера)
    yield 
    # закрываем браузер после выполнения теста (вместо этого комментария нужно подставить код из примера выше как закрыть браузер)

def test_first():
    browser.open("https://www.google.com/")

def test_second():
    browser.open("https://www.google.com/")

• Pytest Documentation
• Selenium
• Python Virtual Environments (venv)
• Pip freeze and requirements.txt
• How to Run a Makefile in Windows
• Makefile on MAC OS
• Оформляем README-файл профиля на GitHub
• PEP-8 - Секрет чистого и профессионального кода! [Python - Первый шаг 014]
• Дзен Python — философии программирования от Тима Петерса (PEP20)
• PEP 8 - руководство по написанию кода на Python
• PEP 8 – Style Guide for Python Code
• Ruff Documentation
• Black Documentation
• isort Documentation
• Руководство по makefile для начинающих (Habr)