naming-conventions

Python naming conventions for this codebase. Apply when writing or reviewing Python code including functions, classes, variables, and constants.

Zur Installation springen

Repository: libertininick/pyclaudefig
Letzte Quellaktivität: 6. März 2026 um 20:05
Erkannte Sprache von SKILL.md: Englisch
Sterne: 0
Forks: 0

Installationsoptionen

Standardmäßig ist der Prompt ausgewählt, der zuerst die Quelle prüft. Sie können zu einem direkten Befehl wechseln oder eine lokale Kopie herunterladen.

Mit Codex oder Claude installieren Kopieren Sie diesen Prompt, fügen Sie ihn in Codex, Claude oder einen anderen Assistant ein und lassen Sie die Skill-Seite prüfen und installieren.

Ein direkter Befehl überspringt den Prüf-Prompt. Prüfen Sie die Quelle, bevor Sie ihn ausführen.

npx skills add https://github.com/libertininick/pyclaudefig --skill naming-conventions

Der Befehl bleibt in einer Zeile. Scrollen Sie horizontal, um ihn vor dem Kopieren vollständig zu prüfen.

Sie bevorzugen eine lokale Kopie? Laden Sie die Dateien herunter, die SkillsMP derzeit vorliegen.

Quelldateien prüfen

Lesen Sie SKILL.md und alle von SkillsMP angezeigten Begleitdateien, bevor Sie sich für eine Installation entscheiden.

SKILL.md

Quellanweisungen · Schreibgeschützte Vorschau

Zurück zur Suche Zurück zur Installation

docstring-conventions

Google-style docstring conventions for Python code. Apply when writing or reviewing functions, classes, or modules that need documentation.

2026-04-09

type-hints

Python type hint conventions for this codebase. Apply when writing or reviewing Python code that needs type annotations on functions, classes, or variables.

2026-03-06

pythonic-conventions

Essential Pythonic idioms and conventions. Apply when writing or reviewing Python code to ensure idiomatic patterns like comprehensions, built-in functions, context managers, and unpacking.

2026-03-06

Alle aus diesem Repository ansehen

Verb	When to use	Example
`get_`	Retrieve data already in memory or from local cache	`get_user_by_id`, `get_config`
`fetch_`	Retrieve from external source (API, database, file system)	`fetch_api_data`, `fetch_remote_file`
`create_`	Instantiate a new object	`create_session`, `create_embedding`
`build_`	Construct a complex object step-by-step	`build_query`, `build_request`
`parse_`	Convert raw data into structured format	`parse_json`, `parse_response`
`validate_`	Check correctness, return bool or raise	`validate_input`, `validate_schema`
`calculate_`	Compute and return a value	`calculate_score`, `calculate_distance`
`transform_`	Convert from one format to another	`transform_coordinates`, `transform_response`
`is_`	Return boolean for state check	`is_valid`, `is_authenticated`
`has_`	Return boolean for existence check	`has_permission`, `has_feature`

# CORRECT
async def async_fetch_user(user_id: int) -> User:
    return await client.get(f"/users/{user_id}")

async def async_process_batch(items: list[Item]) -> list[Result]:
    return await asyncio.gather(*[async_process(item) for item in items])

# INCORRECT - missing async_ prefix
async def fetch_user(user_id: int) -> User:  # Bad: not clear await is needed
    ...

Variable type	Pattern	Examples
Counts	`<noun>_count`	`user_count`, `retry_count`
Maximums	`max_<noun>`	`max_retry_attempts`, `max_connections`
Minimums	`min_<noun>`	`min_threshold`, `min_batch_size`
Boolean state	`is_<adjective>`	`is_authenticated`, `is_valid`
Boolean existence	`has_<noun>`	`has_permission`, `has_feature`
Dimensions/sizes	`<noun>_dimensions` or `<noun>_size`	`embedding_dimensions`, `batch_size`

# CORRECT
user_count = len(users)
max_retry_attempts = 3
embedding_dimensions = 768
is_authenticated = True
has_valid_license = check_license(user)

# INCORRECT
data = len(users)      # Too generic
n = 3                  # Single letter

# CORRECT
class SearchIndex: ...
class EmbeddingModel: ...
class RetryPolicy: ...
class ValidationError: ...

# INCORRECT
class Search: ...          # Verb-like, unclear purpose
class EmbModel: ...        # Abbreviation
class DoValidation: ...    # Verb phrase

from typing import Final

# CORRECT - always use Final[type] with explicit type parameter
MAX_RETRY_ATTEMPTS: Final[int] = 3
DEFAULT_TIMEOUT_SECONDS: Final[float] = 30.0
SUPPORTED_FILE_FORMATS: Final[frozenset[str]] = frozenset({"json", "csv", "parquet"})

# INCORRECT
MaxRetries = 3              # Wrong case, missing Final
max_retry_attempts = 3      # Wrong case for constant
MAX_RETRY_ATTEMPTS = 3      # Missing Final annotation
MAX_RETRY_ATTEMPTS: Final = 3  # Missing type parameter in Final

class SearchService:
    def __init__(self, index: VectorIndex) -> None:
        self._index = index              # Private attribute
        self._cache: dict[str, Result] = {}  # Private attribute

    def search(self, query: str) -> list[Result]:  # Public API
        return self._perform_search(query)

    def _perform_search(self, query: str) -> list[Result]:  # Private method
        ...

# CORRECT
JsonValue = dict[str, Any] | list[Any] | str | int | float | bool | None
Embedding = list[float]
UserId = int

# INCORRECT
json_value = dict[str, Any] | list[Any] | str | int | float | bool | None  # Wrong case

name	naming-conventions
description	Python naming conventions for this codebase. Apply when writing or reviewing Python code including functions, classes, variables, and constants.
user-invocable	false

Element	Case	Pattern	Example
Function	`snake_case`	`<verb>_<noun>`	`fetch_user`, `validate_input`
Async function	`snake_case`	`async_<verb>_<noun>`	`async_fetch_user`
Variable	`snake_case`	descriptive	`user_count`, `is_valid`
Class	`PascalCase`	noun	`SearchIndex`, `UserSession`
Constant	`SCREAMING_SNAKE_CASE`	+ `Final[type]`	`MAX_RETRIES: Final[int] = 3`
Private	`_snake_case`	`_` prefix

name	naming-conventions
description	Python naming conventions for this codebase. Apply when writing or reviewing Python code including functions, classes, variables, and constants.
user-invocable	false

Element	Case	Pattern	Example
Function	`snake_case`	`<verb>_<noun>`	`fetch_user`, `validate_input`
Async function	`snake_case`	`async_<verb>_<noun>`	`async_fetch_user`
Variable	`snake_case`	descriptive	`user_count`, `is_valid`
Class	`PascalCase`	noun	`SearchIndex`, `UserSession`
Constant	`SCREAMING_SNAKE_CASE`	+ `Final[type]`	`MAX_RETRIES: Final[int] = 3`
Private	`_snake_case`	`_` prefix

naming-conventions

Installationsoptionen

Quelldateien prüfen

Python Naming Conventions

Quick Reference

Python Naming Conventions

Quick Reference

Functions and Methods

Required Verb Prefixes

Async Functions

Variables

Required Patterns

Forbidden Variable Names

Classes

Constants

Private Members

Type Aliases

naming-conventions

Quellinformationen

Installationsoptionen

Quelldateien prüfen

Mehr aus diesem Repository

Mehr aus diesem Repository

Python Naming Conventions

Quick Reference

Python Naming Conventions

Quick Reference

Functions and Methods

Required Verb Prefixes

Async Functions

Variables

Required Patterns

Forbidden Variable Names

Classes

Constants

Private Members

Type Aliases