@litfamily/litcodex 1.0.0

package/marketplace/plugins/litcodex/skills/lit-code/references/python/pydantic-ai.md

@@ -0,0 +1,285 @@
+# PydanticAI Reference (v1.x, 2026)
+
+> Canonical patterns for wiring PydanticAI agents. Target: production usage, late-2025 / 2026.
+> Source: [ai.pydantic.dev](https://ai.pydantic.dev) and [pydantic/pydantic-ai@`cad9569`](https://github.com/pydantic/pydantic-ai/blob/cad956910079737ea0886b50cef15777208f92e6).
+
+---
+
+## 1. Agent Constructor
+
+```python
+from pydantic_ai import Agent
+
+agent = Agent(
+    'openai:gpt-5.5',               # model (str | Model | None)
+    output_type=MyOutputModel,       # structured output type; default=str
+    instructions='You are a...',     # static or callable instructions
+    system_prompt='Be concise.',     # static system prompt(s)
+    deps_type=MyDeps,                # dependency type for type-checking only
+    name='my-agent',                 # optional, inferred from var name if omitted
+    retries=1,                       # default retries for tools + output validation
+    output_retries=None,             # override retries for output validation only
+    tools=[my_tool],                 # list of Tool objects or plain functions
+    defer_model_check=False,         # set True to skip env-var check at init time
+    end_strategy='early',            # 'early' | 'graceful' | 'exhaustive'
+)
+```
+
+**Breaking change (v1.88.0)**: `result_type` was renamed to `output_type`. Use `output_type`.
+
+---
+
+## 2. Model Strings
+
+Format: `provider:model-name`. The framework infers the provider from the prefix.
+
+| Provider prefix | Example |
+|---|---|
+| `openai:` | `'openai:gpt-5.5'`, `'openai:gpt-4o'` |
+| `anthropic:` | `'anthropic:claude-sonnet-4-6'`, `'anthropic:claude-opus-4-1'` |
+| `google-gla:` | `'google-gla:gemini-3-flash-preview'` |
+| `google-vertex:` | `'google-vertex:gemini-3-pro-preview'` |
+| `bedrock:` | `'bedrock:anthropic.claude-sonnet-4-6'` |
+| `xai:` / `grok:` | `'xai:grok-3'`, `'grok:grok-3-fast'` |
+| `deepseek:` | `'deepseek:deepseek-chat'` |
+| `cohere:` | `'cohere:command-r-08-2024'` |
+| `gateway/...` | `'gateway/openai:gpt-5.5'` (PydanticAI Gateway) |
+
+Model can also be omitted at construction and passed per-run: `agent.run(prompt, model='openai:gpt-5.5')`.
+
+---
+
+## 3. Tools
+
+### Decorator syntax
+
+```python
+from pydantic_ai import Agent, RunContext
+
+agent = Agent('openai:gpt-5.5', deps_type=str)
+
+@agent.tool                    # default: receives RunContext as first arg
+async def greet(ctx: RunContext[str], name: str) -> str:
+    return f"Hello {ctx.deps}, {name}!"
+
+@agent.tool_plain              # no context needed
+async def roll_dice(sides: int) -> int:
+    import random
+    return random.randint(1, sides)
+```
+
+### `RunContext[Deps]`
+
+First parameter of `@agent.tool` functions. Carries:
+
+- `ctx.deps` — the dependency instance
+- `ctx.model` — the model being used
+- `ctx.usage` — token usage so far
+- `ctx.messages` — conversation history
+- `ctx.retry` / `ctx.max_retries` — current retry count
+- `ctx.agent` — the running agent instance
+
+Use `@agent.tool_plain` when the tool does **not** need any of the above.
+
+---
+
+## 4. Structured Output
+
+Pass a Pydantic `BaseModel` (or `bool`, `int`, `list[str]`, etc.) as `output_type`. The result is accessed via `.output`.
+
+```python
+from pydantic import BaseModel
+from pydantic_ai import Agent
+
+class City(BaseModel):
+    name: str
+    country: str
+    population_millions: float
+
+agent = Agent('openai:gpt-5.5', output_type=City)
+result = agent.run_sync('Tell me about Tokyo')
+print(result.output)            # City(name='Tokyo', country='Japan', ...)
+print(result.output.name)       # 'Tokyo'
+```
+
+**Note**: `result.data` was renamed; the canonical accessor is `result.output`.
+
+---
+
+## 5. Async vs Sync
+
+| Method | Mode | Returns |
+|---|---|---|
+| `await agent.run(prompt, ...)` | async | `AgentRunResult[OutputDataT]` |
+| `agent.run_sync(prompt, ...)` | sync | `AgentRunResult[OutputDataT]` |
+| `async with agent.run_stream(prompt, ...) as response:` | async streaming | `StreamedRunResult` |
+
+```python
+# Sync
+result = agent.run_sync('What is the capital of Italy?')
+print(result.output)
+
+# Async
+result = await agent.run('What is the capital of France?')
+print(result.output)
+
+# Streaming
+async with agent.run_stream('What is the capital of the UK?') as response:
+    async for text in response.stream_text():
+        print(text, end='')
+    # After streaming finishes:
+    print(response.output)
+```
+
+`run_sync()` is a convenience wrapper over `loop.run_until_complete(self.run(...))`. Do not use it inside an active async context.
+
+---
+
+## 6. Dependencies
+
+Use a `@dataclass` container, pass the **type** to `deps_type`, and pass an **instance** to `deps` at run time.
+
+```python
+from dataclasses import dataclass
+import httpx
+from pydantic_ai import Agent, RunContext
+
+@dataclass
+class Deps:
+    api_key: str
+    http_client: httpx.AsyncClient
+
+agent = Agent(
+    'openai:gpt-5.5',
+    deps_type=Deps,
+)
+
+@agent.tool
+async def fetch_data(ctx: RunContext[Deps], endpoint: str) -> str:
+    r = await ctx.deps.http_client.get(
+        endpoint,
+        headers={'Authorization': f'Bearer {ctx.deps.api_key}'},
+    )
+    r.raise_for_status()
+    return r.text
+
+async def main():
+    async with httpx.AsyncClient() as client:
+        deps = Deps(api_key='sk-...', http_client=client)
+        result = await agent.run('Get /users', deps=deps)
+        print(result.output)
+```
+
+---
+
+## 7. Error Types & Retrying from a Tool
+
+```python
+from pydantic_ai import Agent, ModelRetry, UnexpectedModelBehavior, capture_run_messages
+
+agent = Agent('openai:gpt-5.5', retries=3)
+
+@agent.tool_plain
+def calc_volume(size: int) -> int:
+    if size == 42:
+        return size ** 3
+    raise ModelRetry('Please try again with size 42.')
+
+with capture_run_messages() as messages:
+    try:
+        result = agent.run_sync('Get the volume of a box with size 6.')
+    except UnexpectedModelBehavior as e:
+        print('Error:', e)          # "Tool 'calc_volume' exceeded max retries count of 3"
+        print('Cause:', e.__cause__)  # ModelRetry('Please try again...')
+        print('Messages:', messages)
+```
+
+- **`ModelRetry`** — raise from a tool, output validator, or capability hook to ask the model to retry.
+- **`UnexpectedModelBehavior`** — raised when the retry limit is exceeded or the model API returns an unrecoverable error.
+- **`capture_run_messages()`** — context manager that records all messages exchanged during a run for debugging.
+
+---
+
+## 8. Logfire Integration
+
+One-line setup if the `logfire` extra is installed (included in the default `pydantic-ai` package):
+
+```python
+import logfire
+
+logfire.configure()               # reads token from .logfire directory
+logfire.instrument_pydantic_ai()  # auto-traces all agent runs
+```
+
+Alternatively, set `instrument=True` on the agent:
+
+```python
+agent = Agent('openai:gpt-5.5', instrument=True)
+```
+
+---
+
+## 9. Minimal Complete Snippets
+
+### (a) Basic agent with structured output
+
+```python
+from pydantic import BaseModel
+from pydantic_ai import Agent
+
+class City(BaseModel):
+    name: str
+    country: str
+
+agent = Agent('openai:gpt-5.5', output_type=City)
+result = agent.run_sync('Tell me about Paris')
+print(result.output)   # City(name='Paris', country='France')
+```
+
+### (b) Agent with tools and dependencies
+
+```python
+from dataclasses import dataclass
+from pydantic_ai import Agent, RunContext
+
+@dataclass
+class Deps:
+    api_key: str
+
+agent = Agent('openai:gpt-5.5', deps_type=Deps)
+
+@agent.tool
+async def get_secret(ctx: RunContext[Deps], code: str) -> str:
+    if code == '1234':
+        return f'secret-for-{ctx.deps.api_key}'
+    return 'wrong code'
+
+result = agent.run_sync('My code is 1234', deps=Deps(api_key='sk-abc'))
+print(result.output)
+```
+
+### (c) Async streaming
+
+```python
+import anyio
+from pydantic_ai import Agent
+
+agent = Agent('openai:gpt-5.5')
+
+async def main() -> None:
+    async with agent.run_stream('Write a haiku about Python') as response:
+        async for text in response.stream_text():
+            print(text, end='')
+        print('\n---')
+        print('Final:', response.output)
+
+anyio.run(main)
+```
+
+---
+
+## Version Notes
+
+- **V1** reached API stability in September 2025. Breaking changes are reserved for V2 (earliest April 2026).
+- **v1.88.0** renamed `result_type` → `output_type` and `result_tool_name` / `result_tool_description` were removed. Use `output_type`.
+- The canonical accessor for run results is `result.output` (not `result.data`).

package/marketplace/plugins/litcodex/skills/lit-code/references/python/pyproject-strict.md

@@ -0,0 +1,232 @@
+# Strict pyproject.toml (basedpyright + ruff + uv)
+
+The canonical "super strict but sane" config for modern Python projects. Copy-paste, then add your own dependencies.
+
+## Bootstrap
+
+```bash
+# Application
+uv init --app myproject
+cd myproject
+
+# Library (publishable to PyPI)
+uv init --lib mylibrary
+cd mylibrary
+
+# Add dev tools
+uv add --dev basedpyright ruff pytest
+```
+
+`uv init` creates `pyproject.toml`, `.python-version`, and `src/` layout. Replace its `pyproject.toml` `[tool.*]` sections with the block below.
+
+## The full pyproject.toml
+
+```toml
+[project]
+name = "myproject"
+version = "0.1.0"
+description = "..."
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = []
+
+[dependency-groups]
+dev = [
+    "basedpyright>=1.21",
+    "ruff>=0.8",
+    "pytest>=8",
+    "pytest-cov>=5",
+]
+
+# ─────────────────────────────────────────────────────────────────
+# basedpyright - typeCheckingMode = "all" sets every report flag to error
+# Source: https://docs.basedpyright.com/latest/configuration/config-files/
+# ─────────────────────────────────────────────────────────────────
+[tool.basedpyright]
+typeCheckingMode = "all"
+pythonVersion = "3.13"
+pythonPlatform = "All"          # default in basedpyright; explicit for clarity
+include = ["src", "tests"]
+exclude = ["**/__pycache__", "**/.venv", "**/build", "**/dist"]
+
+# Strict enforcement extras (most are already "error" under "all" mode,
+# but listing them explicitly documents the intent)
+reportUnusedCallResult = "warning"       # flag ignored return values
+reportUnnecessaryTypeIgnoreComment = "error"  # stale type: ignore comments must die
+reportUnusedVariable = "error"           # unused variables are errors
+reportMissingParameterType = "error"     # every parameter must have a type
+reportMissingReturnType = "error"        # every function must declare its return type
+reportPrivateUsage = "error"             # respect _private convention
+
+# Optional: gradual adoption baseline
+# baselineFile = "./.basedpyright/baseline.json"
+
+# ─────────────────────────────────────────────────────────────────
+# ruff - select = ["ALL"] enables every rule, then we ignore the
+# small set that conflicts with the formatter or is not useful.
+# Source: https://docs.astral.sh/ruff/linter/#rule-selection
+# ─────────────────────────────────────────────────────────────────
+[tool.ruff]
+target-version = "py313"
+line-length = 88                # ruff/black default; 100 or 120 also fine
+src = ["src", "tests"]
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    # Formatter conflicts (ruff itself tells you to ignore these)
+    "COM812",   # missing trailing comma
+    "ISC001",   # implicit string concat
+    # Docstyle conflicts (pick D211 over D203, D212 over D213)
+    "D203",
+    "D213",
+    # Project-specific noise
+    "CPY001",   # missing copyright notice
+    "FBT001",   # boolean positional arg in def
+    "FBT002",   # boolean positional default in def
+    "TD002",    # missing TODO author
+    "TD003",    # missing TODO link
+    "FIX002",   # line contains TODO (TODOs are allowed)
+]
+fixable = ["ALL"]
+unfixable = []
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**/*.py" = [
+    "S101",     # `assert` is the entire point of pytest
+    "ARG",      # unused args (fixtures appear unused)
+    "PLR2004",  # magic numbers in test data
+    "SLF001",   # tests need access to private members
+    "D",        # docstrings not required in tests
+]
+"scripts/**/*.py" = [
+    "T201",     # `print` allowed in scripts
+    "INP001",   # implicit namespace package
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"  # or "numpy" / "pep257"
+
+[tool.ruff.lint.flake8-bugbear]
+# typer / fastapi rely on call-as-default for parameter metadata.
+# Without this, ruff B008 ("function call in default") fires on every typer/fastapi route.
+extend-immutable-calls = [
+    "typer.Argument",
+    "typer.Option",
+    "fastapi.Depends",
+    "fastapi.Query",
+    "fastapi.Path",
+    "fastapi.Body",
+    "fastapi.Header",
+    "fastapi.Cookie",
+    "fastapi.File",
+    "fastapi.Form",
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+docstring-code-format = true
+docstring-code-line-length = "dynamic"
+
+# ─────────────────────────────────────────────────────────────────
+# pytest
+# ─────────────────────────────────────────────────────────────────
+[tool.pytest.ini_options]
+minversion = "8.0"
+testpaths = ["tests"]
+addopts = [
+    "-ra",
+    "--strict-config",
+    "--strict-markers",
+]
+filterwarnings = ["error"]
+
+# ─────────────────────────────────────────────────────────────────
+# coverage
+# ─────────────────────────────────────────────────────────────────
+[tool.coverage.run]
+source = ["src"]
+branch = true
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "if TYPE_CHECKING:",
+    "if typing.TYPE_CHECKING:",
+    "raise NotImplementedError",
+    "@(abc\\.)?abstractmethod",
+]
+```
+
+## Why these settings
+
+### basedpyright `typeCheckingMode = "all"`
+
+basedpyright's modes, strictest first:
+
+| Mode | Behavior |
+|---|---|
+| `"all"` | Every diagnostic at `error` |
+| `"recommended"` | Same rules; less severe ones at `warning`; `failOnWarnings = true` makes CI still fail |
+| `"strict"` | pyright's strict mode |
+| `"standard"` | Default |
+| `"basic"` / `"off"` | Loose / disabled |
+
+`"all"` enables basedpyright-exclusive rules pyright lacks: `reportImplicitOverride`, `reportImplicitStringConcatenation`, `reportIncompatibleUnannotatedOverride`, `reportUnannotatedClassAttribute`. No need to opt-in to additional flags.
+
+`pythonPlatform = "All"` is basedpyright's default (better than pyright's host-OS default) - it errors on platform-specific imports that fail on other OSes.
+
+### ruff `select = ["ALL"]`
+
+The official docs say *"Use ALL with discretion. Enabling ALL will implicitly enable new rules whenever you upgrade."* For a strict skill that is the intended behavior - every new ruff rule should be considered an error until you justify ignoring it.
+
+The minimal ignore set:
+
+| Rule | Reason |
+|---|---|
+| `COM812`, `ISC001` | Conflict with `ruff format` (ruff itself documents this) |
+| `D203` vs `D211`, `D213` vs `D212` | Mutually-exclusive docstring conventions; pick the modern one |
+| `CPY001` | Most projects don't need a copyright header on every file |
+| `FBT001`, `FBT002` | Boolean flags are ergonomic for CLI/typer; ban makes typer awkward |
+| `TD002`, `TD003`, `FIX002` | TODOs without a JIRA link are fine in solo / internal code |
+
+`ANN101` and `ANN102` were **removed in ruff 0.8.0** (Nov 2024). Do NOT include them in `ignore` - ruff errors on unknown rule codes.
+
+`per-file-ignores` for `tests/**` is the standard pattern from real-world repos like `community-of-python/auto-typing-final` and `Preston-Landers/concurrent-log-handler`.
+
+## CI gate
+
+```bash
+# In CI, fail on any violation:
+uv run basedpyright
+uv run ruff check
+uv run ruff format --check
+uv run pytest
+```
+
+A single `make ci` target combining the four works fine.
+
+## Enforcement summary
+
+The config above, combined with `scripts/check-no-excuse-rules.py`, enforces:
+
+| What | How |
+|---|---|
+| Exhaustive match | basedpyright `all` mode + `assert_never` |
+| No `Any` | basedpyright `all` mode + script `cast-any` rule |
+| Ignored return values | `reportUnusedCallResult = "warning"` |
+| Immutable default | Script `mutable-dataclass` + `missing-slots` rules |
+| No null surprise | basedpyright strict `None` analysis |
+| Constants are const | basedpyright catches `Final` reassignment |
+| Unused variables | `reportUnusedVariable = "error"` |
+
+## Sources
+
+- basedpyright modes: <https://docs.basedpyright.com/latest/configuration/config-files/#type-check-diagnostics-settings>
+- basedpyright `"all"` vs `"recommended"`: <https://docs.basedpyright.com/latest/configuration/config-files/#recommended-and-all>
+- basedpyright better defaults: <https://docs.basedpyright.com/latest/benefits-over-pyright/better-defaults/>
+- ruff rule selection: <https://docs.astral.sh/ruff/linter/#rule-selection>
+- ruff ANN101/ANN102 removed: <https://github.com/astral-sh/ruff/pull/14384>
+- Real-world ALL config: <https://github.com/community-of-python/auto-typing-final/blob/main/pyproject.toml>
+- PEP 735 dependency-groups: <https://peps.python.org/pep-0735/>