pynudger

opennudge Python linter (naming conventions and other automated checks)

✨ Features 🚀 Quick start 📚 Documentation 🤝 Contribute 👍 Adopters 📜 Legal

Features

pynudger is an opinionated linter for Python projects, focused on naming conventions and making your code "more Pythonic".

• Length rules: Too long class/function names are flagged.
• Setters/getters: Discourages usage of setters/getters, encourages properties instead.
• No helpers/utils/commons: Incentivizes more descriptive and semantically coherent names for functionalities.

Table of contents

• Quick start
  • Installation
  • Usage
• Advanced
  • Configuration
  • Run as a pre-commit hook
  • Disable in code
  • Rules

Quick start

Installation

[!TIP] You can use your favorite package manager like uv, hatch or pdm instead of pip.

> pip install pynudger

Usage

To check against the rules run the following from the command line:

> pynudger check

You can pass additional arguments to pynudger check, like files to check (by default all Python files in the current directory):

> pynudger check path/to/file.py another_file.py

Advanced

Configuration

You can configure pynudger in pyproject.toml (or .pynudger.toml in the root of your project, just remove the [tool.pynudger] section), for example:

[tool.pynudger]
# include rules by their code
include_codes = [1, 2, 5] # default: all rules included
# exclude rules by their code (takes precedence over include)
exclude_codes = [4, 5, 6] # default: no rules excluded
# whether to exit after first error or all errors
end_mode = "first" # default: "all"

[!TIP] Rule-specific configuration can be found in the section below.

Run as a pre-commit hook

pynudger can be used as a pre-commit hook, to add as a plugin:

repos:
-   repo: "https://github.com/open-nudge/pynudger"
    rev: ...  # select the tag or revision you want, or run `pre-commit autoupdate`
    hooks:
    -   id: "pynudger"

Disable in code

You can disable pynudger on a line-by-line basis (you have to specify exact code), e.g.:

def set_my_too_long_function_name():  # noqa: PYNUDGER0, PYNUDGER16
    pass

or a line span:

# noqa-start: PYNUDGER0, PYNUDGER16
def set_my_too_long_function_name():
    pass

def set_another_long_function():
    pass
# noqa-end: PYNUDGER0, PYNUDGER16

def set_will_error_out_this_time():
    pass

It is also possible to disable all checks in a file by placing the following somewhere in the file (preferably at the top):

# noqa-file: PYNUDGER0, PYNUDGER16

[!NOTE] If you are running pynudger with ruff you should add lint.external = ["PYNUDGER"] to [tool.ruff] section in pyproject.toml to avoid removing # noqa: PYNUDGER comments.

Rules

[!TIP] Run pynudger rules to see the list of available rules.

pynudger provides the following rules:

with the following configurable options (in pyproject.toml or .pynudger.toml):

Contribute

We welcome your contributions! Start here:

• Code of Conduct
• Contributing Guide
• Roadmap
• Changelog
• Report security vulnerabilities
• Open an Issue

Legal

• This project is licensed under the Apache 2.0 License - see the LICENSE file for details.
• This project is copyrighted by open-nudge - the appropriate copyright notice is included in each file.