1002-python-style-guide

A Python style rule covering consistent indentation, type hints, and docstrings. It applies to Python files under `src/` and includes examples of documented classes, methods, parameters, and return values.

In plain words
What is it for?
Use it when creating or reviewing Python source files, especially classes and functions that manage files, metadata, caching, or concurrent work.
Why use it?
It reduces differences in how code is written and explained, making a shared Python codebase easier to read.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/savagelysubtle/big-brain-memory-bank/1002-python-style-guide
Clone the repo
git clone --depth 1 https://github.com/savagelysubtle/BIG-BRAIN-Memory-Bank

Made for: Cursor.

Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 1,234 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.01234
Opus 5 $0.00000 $0.00617
Sonnet 5 $0.00000 $0.00247
Haiku 4.5 $0.00000 $0.00123

Measured 2d ago against content hash ac627ea9da0a, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

1002-python-style-guide scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

inspiration/original-concepts/My-memory-bank/.cursor/rules/1002-python-style-guide.mdc · 145 lines

How it starts

The opening of the file, as written. The whole thing — 145 lines — stays where its author put it; the contents beside it link to each section on GitHub.


description: Maintain consistent Python code style with proper docstrings, typing, and indentation globs: src/**/*.py

This class provides functionality to read files, detect their MIME types,
and extract content for further processing.
"""

def __init__(
    self,
    max_workers: int = 2,
    preview_length: int = 100,
    cache_manager: CacheManager | None = None,
) -> None:
    """Initialize FileReader.

    Args:
        max_workers: Maximum number of worker threads for
            concurrent operations
        preview_length: Maximum length of file previews
        cache_manager: Cache manager for caching extraction results
    """
    self.max_workers = max_workers
    self.preview_length = preview_length
    self.logger = logging.getLogger(__name__)

    # Initialize the magic library for file type detection
    self._magic_instance = None

    self.executor = ThreadPoolExecutor(max_workers=max_workers)
    self.cache_manager = cache_manager

    # Initialize the metadata manager
    self.metadata_manager = MetadataManager(cache_manager)

def get_mime_type(self, file_path: str | Path) -> str:
    """Get the MIME type of a file.

    Args:
        file_path: Path to the file

    Returns:
        MIME type of the file

    Raises:
        FileNotFoundError: If the file does not exist
    """
    path = Path(file_path)
    if not path.exists():
        raise FileNotFoundError(f"{path} does not exist.")

    if magic is None:
        self.logger.warning("Magic library not available, using default MIME type")
        return "application/octet-stream"

    # Implementation details...
    return self._fallback_mime_type(path)
  </code>
</good-example>

<bad-example>
  <title>Poor Python Formatting Style</title>
  <code>

class file_reader: # Incorrect class naming (should be PascalCase) '''Class that reads files''' # Incomplete docstring

def __init__(self, max_workers=2, preview_length=100, cache_manager=None):  # Missing type hints
    # No docstring for method
    self.max_workers=max_workers  # Missing space around operator
    self.preview_length = preview_length
    self.logger = logging.getLogger(__name__)

    self._magic_instance = None

    self.executor = ThreadPoolExecutor(max_workers=max_workers)
    self.cache_manager=cache_manager  # Missing space around operator
    self.metadata_manager = MetadataManager(cache_manager)

def get_mime_type(self, file_path):  # Missing type hints
    # Docstring should be more descriptive
    """Get MIME type."""
    path = Path(file_path)
    if not path.exists():
        raise FileNotFoundError("Path %s does not exist." % path)  # Using %-formatting instead of f-string

Read the full file on GitHub · 145 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 145 lines · 0 tokens per session scan A ac627ea9da0a

Subscribe to this mod's changes

1002-python-style-guide is a cursor rule published in the GitHub repository savagelysubtle/BIG-BRAIN-Memory-Bank (5 stars, last pushed 1y ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 1,234 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.