n-notation 0.1.0

Flake8 plugin enforcing N notation

Линтер N-нотации

Теперь следовать принципам легко!

Русский | English

Это flake8-плагин, который проверяет соответствие кода правилам N-нотации. Используйте его в проектах, где вы действительно пишете в этом кодстайле (или хотите быстро прогнать отдельные файлы/каталоги).

Принципы N-нотации (кратко)

Данный плагин проверяет следующие правила философии N-нотации:

• Имена не несут смысла. Смысл берётся из структуры и контекста, а не из словесных идентификаторов.
• Регистр важен: N... — структуры/типы, n... — данные/исполняемое.
• Файлы: n<цифры>.py (см. NNO401).
• Директории: N<цифры>[_<цифры>]... (см. NNO420).
• Переменные / функции: n<10 цифр> (для булевых — n<10 бит>).
• Классы: N<10 цифр>, наследники — цепочка N<id>n<id>... (см. NNO107).
• Члены класса: n_<...> / _n<...>; получатель метода — не self, а n<ClassId> (см. NNO210).
• Итераторы циклов/генераторов: n, nn, nnn, ...
• Импорты: обязателен алиас + порядок/разделение/сортировка (см. NNO301–NNO312).
• Шум запрещён: комментарии и docstring’и запрещены (кроме # noqa...).

[!IMPORTANT]

• Полное описание правил смотрите в документации.

Быстрый старт

Установка

python -m pip install -e .

Запуск линтера

Показывать только ошибки N-нотации:

python -m flake8 --select NNO .

Показывать ошибки N-нотации + остальные flake8 проверки:

python -m flake8 .

Тестирование

Запуск всех тестов:

python -m unittest discover -s tests -v

Коды (актуальные)

Уровень проекта:

• NNO401: имя файла должно быть в формате n<цифры>.py
• NNO500: README репозитория должен содержать точный блок объявления N-нотации

Уровень AST:

• NNO101: недопустимое имя переменной
• NNO104: недопустимое имя функции
• NNO106: недопустимое имя класса
• NNO107: имя производного класса должно соответствовать цепочке именования базового класса
• NNO108 / NNO109: недопустимые имена членов (n_... / _n...)
• NNO110: недопустимое имя итератора цикла / генератора (должно быть n, nn, ...)
• NNO201 / NNO202: недопустимые имена параметров
• NNO210: недопустимое имя получателя метода (замена self должна быть n<ИмяКласса[1:]>)
• NNO602: docstring’и запрещены
• NNO701: аннотации переменных запрещены

Уровень токенов:

• NNO601: комментарии запрещены (исключение: разрешены # noqa / # noqa: ...)

• Импорты:

  • NNO301: требуется алиас import X as N1
  • NNO302 / NNO303: требуется алиас from X import Y as N0000000001 (10 цифр)
  • NNO310: неверный порядок групп импортов (stdlib → third_party → local)
  • NNO311: неверное разделение пустыми строками между группами
  • NNO312: неверная числовая сортировка внутри группы

[!NOTE]

• Плагин намеренно строгий и может помечать код, не использующий N-нотацию (включая __init__.py).
• При необходимости используйте # noqa: NNO... для локального подавления ошибок.

Phasalo
Делаем красиво!

2026