hammad-python 0.0.11__py3-none-any.whl → 0.0.13__py3-none-any.whl

hammad/cli/styles/__init__.py

@@ -3,3 +3,53 @@
 Contains resources, types and other utilities in context of
 styling rendered content in the CLI. Most resources within this
 submodule are not meant for direct use."""
+
+from typing import TYPE_CHECKING
+from ..._core._utils._import_utils import _auto_create_getattr_loader
+
+if TYPE_CHECKING:
+    from .settings import (
+        CLIStyleRenderableSettings,
+        CLIStyleLiveSettings,
+        CLIStyleBackgroundSettings,
+    )
+    from .types import (
+        CLIStyleBackgroundType,
+        CLIStyleBoxName,
+        CLIStyleColorName,
+        CLIStyleError,
+        CLIStyleJustifyMethod,
+        CLIStyleOverflowMethod,
+        CLIStyleStyleName,
+        CLIStyleType,
+        CLIStyleVerticalOverflowMethod,
+    )
+    from .utils import live_render, style_renderable
+
+
+__all__ = (
+    # hammad.cli.styles.settings
+    "CLIStyleRenderableSettings",
+    "CLIStyleLiveSettings",
+    "CLIStyleBackgroundSettings",
+    # hammad.cli.styles.types
+    "CLIStyleBackgroundType",
+    "CLIStyleBoxName",
+    "CLIStyleColorName",
+    "CLIStyleError",
+    "CLIStyleJustifyMethod",
+    "CLIStyleOverflowMethod",
+    "CLIStyleStyleName",
+    "CLIStyleType",
+    "CLIStyleVerticalOverflowMethod",
+    # hammad.cli.styles.utils
+    "live_render",
+    "style_renderable",
+)
+
+
+__getattr__ = _auto_create_getattr_loader(__all__)
+
+
+def __dir__() -> list[str]:
+    return list(__all__)

hammad/cli/styles/settings.py

@@ -4,6 +4,7 @@ from typing import Any
 from typing_extensions import TypedDict, NotRequired
 
 from .types import (
+    CLIStyleColorName,
     CLIStyleBoxName,
     CLIStyleJustifyMethod,
     CLIStyleOverflowMethod,
@@ -28,6 +29,9 @@ class CLIStyleRenderableSettings(TypedDict, total=False):
     tag with a color / style name. or apply the `style_settings`
     parameter with these settings."""
 
+    color: NotRequired[CLIStyleColorName]
+    """The color of the renderable output or content."""
+
     # rich.text
 
     justify: NotRequired[CLIStyleJustifyMethod]

hammad/configuration/__init__.py

@@ -0,0 +1,35 @@
+"""hammad.configuration
+
+Contains the `Configuration` class and related functions for parsing configurations
+from various sources.
+"""
+
+from typing import TYPE_CHECKING
+from .._core._utils._import_utils import _auto_create_getattr_loader
+
+if TYPE_CHECKING:
+    from .configuration import (
+        Configuration,
+        read_configuration_from_file,
+        read_configuration_from_url,
+        read_configuration_from_os_vars,
+        read_configuration_from_os_prefix,
+        read_configuration_from_dotenv,
+    )
+
+
+__all__ = (
+    "Configuration",
+    "read_configuration_from_file",
+    "read_configuration_from_url",
+    "read_configuration_from_os_vars",
+    "read_configuration_from_os_prefix",
+    "read_configuration_from_dotenv",
+)
+
+
+__getattr__ = _auto_create_getattr_loader(__all__)
+
+
+def __dir__() -> list[str]:
+    return list(__all__)

hammad/{data/types/files → configuration}/configuration.py

@@ -7,11 +7,19 @@ from typing import Any, Self
 from dotenv import load_dotenv, dotenv_values
 import httpx
 import msgspec
+import yaml
 
-from .file import File, FileSource
-from ....based.fields import basedfield
+from ..types.file import File, FileSource
+from ..base.fields import field
 
-__all__ = ("Configuration",)
+__all__ = (
+    "Configuration",
+    "read_configuration_from_file",
+    "read_configuration_from_url",
+    "read_configuration_from_os_vars",
+    "read_configuration_from_os_prefix",
+    "read_configuration_from_dotenv",
+)
 
 
 class Configuration(File):
@@ -24,10 +32,10 @@ class Configuration(File):
     with configuration-specific functionality."""
 
     # Configuration-specific fields
-    config_data: dict[str, Any] = basedfield(default_factory=dict)
+    config_data: dict[str, Any] = field(default_factory=dict)
     """The actual configuration key-value pairs."""
 
-    format_type: str | None = basedfield(default=None)
+    format_type: str | None = field(default=None)
     """The format type of the configuration (json, toml, yaml, ini, env)."""
 
     def __post_init__(self):
@@ -54,7 +62,13 @@ class Configuration(File):
             elif format_type == "toml":
                 self.config_data = msgspec.toml.decode(content.encode("utf-8"))
             elif format_type == "yaml":
-                self.config_data = msgspec.yaml.decode(content.encode("utf-8"))
+                # Use PyYAML with unsafe_load for YAML tags like !!python/name:
+                # This is needed for files like mkdocs.yml that use custom constructors
+                try:
+                    self.config_data = yaml.unsafe_load(content)
+                except yaml.constructor.ConstructorError:
+                    # Fallback to safe_load if unsafe_load fails
+                    self.config_data = yaml.safe_load(content)
             elif format_type == "ini":
                 parser = configparser.ConfigParser()
                 parser.read_string(content)
@@ -129,7 +143,9 @@ class Configuration(File):
         elif format_type == "toml":
             return msgspec.toml.encode(self.config_data).decode("utf-8")
         elif format_type == "yaml":
-            return msgspec.yaml.encode(self.config_data).decode("utf-8")
+            return yaml.dump(
+                self.config_data, default_flow_style=False, allow_unicode=True
+            )
         elif format_type == "ini":
             parser = configparser.ConfigParser()
             for section_name, section_data in self.config_data.items():
@@ -473,3 +489,76 @@ class Configuration(File):
     def items(self):
         """Return configuration key-value pairs."""
         return self.config_data.items()
+
+
+# HELPERS
+
+
+def read_configuration_from_file(path: str | Path) -> Configuration:
+    """Parse a filepath into a `Configuration` object.
+
+    Valid file types:
+    - json
+    - toml
+    - yaml
+    - ini
+    - env
+
+    Args:
+        path: The path to the file to parse.
+
+    Returns:
+        A `Configuration` object.
+    """
+    file_obj = File.from_path(path, lazy=False)
+    return Configuration.from_file(file_obj)
+
+
+def read_configuration_from_url(url: str) -> Configuration:
+    """Parse a URL into a `Configuration` object.
+
+    Args:
+        url: The URL to parse.
+
+    Returns:
+        A `Configuration` object.
+    """
+    return Configuration.from_url(url)
+
+
+def read_configuration_from_os_vars(vars: list[str]) -> Configuration:
+    """Parse a list of environment variables into a `Configuration` object.
+
+    Args:
+        vars: The list of environment variables to parse.
+
+    Returns:
+        A `Configuration` object.
+    """
+    return Configuration.from_os_vars(vars)
+
+
+def read_configuration_from_os_prefix(prefix: str) -> Configuration:
+    """Parse a list of environment variables into a `Configuration` object.
+
+    Args:
+        prefix: The prefix to use to filter the variables.
+
+    Returns:
+        A `Configuration` object.
+    """
+    return Configuration.from_os_prefix(prefix)
+
+
+def read_configuration_from_dotenv(path: str | Path = ".env") -> Configuration:
+    """Parse a .env file into a `Configuration` object.
+
+    NOTE: Defaults to `.env` in the current working directory.
+
+    Args:
+        path: The path to the .env file to parse.
+
+    Returns:
+        A `Configuration` object.
+    """
+    return Configuration.from_dotenv(path)

hammad/data/__init__.py

@@ -1,49 +1,37 @@
 """hammad.data"""
 
 from typing import TYPE_CHECKING
-from ..based.utils import auto_create_lazy_loader
+from .._core._utils._import_utils import _auto_create_getattr_loader
 
 if TYPE_CHECKING:
-    from .collections.base_collection import BaseCollection
-    from .collections.searchable_collection import SearchableCollection
-    from .collections.vector_collection import (
+    from .collections import (
+        Collection,
+        BaseCollection,
         VectorCollection,
-    )
-    from .collections.collection import (
-        create_collection,
         VectorCollectionSettings,
+        SearchableCollection,
         SearchableCollectionSettings,
+        create_collection,
     )
-    from .databases.database import (
-        Database,
-        create_database,
-    )
-    from .types.files.file import File, FileSource
-    from .types.files.audio import Audio
-    from .types.files.image import Image
-    from .types.files.configuration import Configuration
-    from .types.files.document import Document
+    from .databases import Database, create_database
 
 
 __all__ = (
-    "create_collection",
+    # hammad.data.collections
+    "Collection",
+    "BaseCollection",
     "VectorCollection",
     "VectorCollectionSettings",
     "SearchableCollection",
     "SearchableCollectionSettings",
-    "BaseCollection",
-    "create_database",
+    "create_collection",
+    # hammad.data.databases
     "Database",
-    "File",
-    "FileSource",
-    "Audio",
-    "Image",
-    "Configuration",
-    "Document",
+    "create_database",
 )
 
 
-__getattr__ = auto_create_lazy_loader(__all__)
+__getattr__ = _auto_create_getattr_loader(__all__)
 
 
 def __dir__() -> list[str]:

hammad/data/collections/__init__.py

@@ -1,7 +1,7 @@
 """hammad.data.collections"""
 
 from typing import TYPE_CHECKING
-from ...based.utils import auto_create_lazy_loader
+from ..._core._utils._import_utils import _auto_create_getattr_loader
 
 if TYPE_CHECKING:
     from .base_collection import BaseCollection
@@ -11,6 +11,7 @@ if TYPE_CHECKING:
         create_collection,
         VectorCollectionSettings,
         SearchableCollectionSettings,
+        Collection,
     )
 
 
@@ -21,10 +22,11 @@ __all__ = (
     "create_collection",
     "VectorCollectionSettings",
     "SearchableCollectionSettings",
+    "Collection",
 )
 
 
-__getattr__ = auto_create_lazy_loader(__all__)
+__getattr__ = _auto_create_getattr_loader(__all__)
 
 
 def __dir__() -> list[str]: