Python Template Copilot Standards

Instructions for GitHub Copilot to enforce coding standards and best practices in Python projects.

What This Skill Does

Configures GitHub Copilot to follow consistent coding standards including naming conventions, error handling patterns, and code organization practices. Based on the python_template kitchensink project by floppyinfant.

Instructions for AI Agent

When using this skill in a project, apply the following standards:

1. Naming Conventions

- Examples: `UserProfile`, `DatabaseConnection`, `ResponseType`

- Examples: `userData`, `getUserById()`, `calculateTotal()`

- Examples: `_internalState`, `_privateMethod()`

- Examples: `MAX_RETRIES`, `DEFAULT_TIMEOUT`, `API_VERSION`

2. Error Handling

Implement robust error handling throughout the codebase:

```python

try:

result = await async_operation()

except Exception as e:

logger.error(f"Operation failed: {e}")

```

- Include operation name, input parameters, timestamp

- Use appropriate log levels (ERROR, WARNING, INFO)

3. Code Organization

4. Additional Best Practices

Usage Examples

Example 1: Class with Naming Standards

```python

class UserManager:

MAX_LOGIN_ATTEMPTS = 3 # Constant in ALL_CAPS

def __init__(self):

self._userCache = {} # Private member with underscore

def getUserData(self, userId): # Method in camelCase

try:

return self._fetchFromCache(userId)

except KeyError as e:

logger.error(f"User {userId} not found in cache: {e}")

raise

```

Example 2: Error Handling Pattern

```python

async def processRequest(requestData):

try:

result = await apiClient.send(requestData)

return result

except ConnectionError as e:

logger.error(f"Connection failed for request {requestData.id}: {e}")

raise

except Exception as e:

logger.error(f"Unexpected error processing request {requestData.id}: {e}")

raise

```

Resources

Constraints