From e7546a4e645337d9fe50bea4184a737b83ee2b00 Mon Sep 17 00:00:00 2001 From: Philipp Temminghoff Date: Tue, 10 Dec 2024 14:26:45 +0100 Subject: [PATCH] chore: module docstrings --- src/llmling/config/store.py | 2 ++ src/llmling/core/__init__.py | 1 + src/llmling/core/baseregistry.py | 3 ++- src/llmling/monitors/implementations/__init__.py | 1 + src/llmling/monitors/utils.py | 2 ++ src/llmling/processors/base.py | 2 ++ src/llmling/processors/jinjaprocessor.py | 2 ++ src/llmling/processors/registry.py | 2 ++ src/llmling/prompts/__init__.py | 4 ++++ src/llmling/resources/loaders/callable.py | 2 ++ src/llmling/resources/loaders/path.py | 2 ++ src/llmling/resources/loaders/repository.py | 2 ++ src/llmling/resources/loaders/source.py | 2 ++ src/llmling/resources/loaders/text.py | 2 ++ src/llmling/tools/base.py | 2 ++ src/llmling/utils/calling.py | 2 +- src/llmling/utils/importing.py | 2 +- 17 files changed, 32 insertions(+), 3 deletions(-) diff --git a/src/llmling/config/store.py b/src/llmling/config/store.py index 64a8897..a2a3cdf 100644 --- a/src/llmling/config/store.py +++ b/src/llmling/config/store.py @@ -1,3 +1,5 @@ +"""Manages stored config mappings.""" + from __future__ import annotations from dataclasses import dataclass diff --git a/src/llmling/core/__init__.py b/src/llmling/core/__init__.py index e69de29..fef773b 100644 --- a/src/llmling/core/__init__.py +++ b/src/llmling/core/__init__.py @@ -0,0 +1 @@ +"""Module for LLMling core classes.""" diff --git a/src/llmling/core/baseregistry.py b/src/llmling/core/baseregistry.py index 7928915..bb6716a 100644 --- a/src/llmling/core/baseregistry.py +++ b/src/llmling/core/baseregistry.py @@ -1,4 +1,5 @@ -# llmling/core/registry.py +"""Base class for component registries.""" + from __future__ import annotations from abc import ABC, abstractmethod diff --git a/src/llmling/monitors/implementations/__init__.py b/src/llmling/monitors/implementations/__init__.py index e69de29..591ccd8 100644 --- a/src/llmling/monitors/implementations/__init__.py +++ b/src/llmling/monitors/implementations/__init__.py @@ -0,0 +1 @@ +"""Monitor implementations.""" diff --git a/src/llmling/monitors/utils.py b/src/llmling/monitors/utils.py index b3ac88c..656256c 100644 --- a/src/llmling/monitors/utils.py +++ b/src/llmling/monitors/utils.py @@ -1,3 +1,5 @@ +"""Utility functions for the watcher.""" + from __future__ import annotations from typing import TYPE_CHECKING diff --git a/src/llmling/processors/base.py b/src/llmling/processors/base.py index 3246d9f..3b4609f 100644 --- a/src/llmling/processors/base.py +++ b/src/llmling/processors/base.py @@ -1,3 +1,5 @@ +"""Base classes for content processors.""" + from __future__ import annotations from abc import ABC, abstractmethod diff --git a/src/llmling/processors/jinjaprocessor.py b/src/llmling/processors/jinjaprocessor.py index 026c8cb..8f6166a 100644 --- a/src/llmling/processors/jinjaprocessor.py +++ b/src/llmling/processors/jinjaprocessor.py @@ -1,3 +1,5 @@ +"""Builtin Jinja2 processor..""" + from __future__ import annotations from typing import TYPE_CHECKING diff --git a/src/llmling/processors/registry.py b/src/llmling/processors/registry.py index 10c8f99..93e12df 100644 --- a/src/llmling/processors/registry.py +++ b/src/llmling/processors/registry.py @@ -1,3 +1,5 @@ +"""Registry for content processors.""" + from __future__ import annotations import asyncio diff --git a/src/llmling/prompts/__init__.py b/src/llmling/prompts/__init__.py index fdb71b1..6126b20 100644 --- a/src/llmling/prompts/__init__.py +++ b/src/llmling/prompts/__init__.py @@ -1,3 +1,7 @@ +"""Prompt classes and registry for defining and managing prompts.""" + +from __future__ import annotations + from llmling.prompts.models import ( BasePrompt, DynamicPrompt, diff --git a/src/llmling/resources/loaders/callable.py b/src/llmling/resources/loaders/callable.py index 9312590..7aa61dd 100644 --- a/src/llmling/resources/loaders/callable.py +++ b/src/llmling/resources/loaders/callable.py @@ -1,3 +1,5 @@ +"""Callable resource loader implementation.""" + from __future__ import annotations from typing import TYPE_CHECKING, ClassVar diff --git a/src/llmling/resources/loaders/path.py b/src/llmling/resources/loaders/path.py index 44aaf01..6e3df2f 100644 --- a/src/llmling/resources/loaders/path.py +++ b/src/llmling/resources/loaders/path.py @@ -1,3 +1,5 @@ +"""Resource loader for files and URLs.""" + from __future__ import annotations from typing import TYPE_CHECKING, Any, ClassVar diff --git a/src/llmling/resources/loaders/repository.py b/src/llmling/resources/loaders/repository.py index 6414e23..46c4cbf 100644 --- a/src/llmling/resources/loaders/repository.py +++ b/src/llmling/resources/loaders/repository.py @@ -1,3 +1,5 @@ +"""Resource loader for Git repositories.""" + from __future__ import annotations import tempfile diff --git a/src/llmling/resources/loaders/source.py b/src/llmling/resources/loaders/source.py index 2bd3f8f..b554f55 100644 --- a/src/llmling/resources/loaders/source.py +++ b/src/llmling/resources/loaders/source.py @@ -1,3 +1,5 @@ +"""Loader for Python source code.""" + from __future__ import annotations import sys diff --git a/src/llmling/resources/loaders/text.py b/src/llmling/resources/loaders/text.py index 86ab8fa..2a40f8b 100644 --- a/src/llmling/resources/loaders/text.py +++ b/src/llmling/resources/loaders/text.py @@ -1,3 +1,5 @@ +"""Resource loader for text content.""" + from __future__ import annotations from typing import TYPE_CHECKING, ClassVar diff --git a/src/llmling/tools/base.py b/src/llmling/tools/base.py index 85177b4..520f6ed 100644 --- a/src/llmling/tools/base.py +++ b/src/llmling/tools/base.py @@ -1,3 +1,5 @@ +"""Base class for implementing tools callable by an LLM via tool calling.""" + from __future__ import annotations from abc import ABC, abstractmethod diff --git a/src/llmling/utils/calling.py b/src/llmling/utils/calling.py index b7e27d8..012a9dc 100644 --- a/src/llmling/utils/calling.py +++ b/src/llmling/utils/calling.py @@ -1,4 +1,4 @@ -"""Callable context loader.""" +"""Callable execution utilities.""" from __future__ import annotations diff --git a/src/llmling/utils/importing.py b/src/llmling/utils/importing.py index 67aa84b..31a2171 100644 --- a/src/llmling/utils/importing.py +++ b/src/llmling/utils/importing.py @@ -1,4 +1,4 @@ -"""Source code context loader.""" +"""Utilities for importing callables and classes from dotted paths.""" from __future__ import annotations