gyomu-schema 0.1.1__tar.gz

gyomu_schema-0.1.1/.gitignore

@@ -0,0 +1,19 @@
+venv/
+.idea/
+
+/build/
+/dist/
+/src/gyomu.egg-info/
+/.coverage
+/htmlcov/
+__pycache__/
+*.py[cod]
+
+.env
+.env.*
+!.env.example
+
+.mypy_cache/
+.ruff_cache/
+htmlcov/
+*.egg-info/

gyomu_schema-0.1.1/PKG-INFO

@@ -0,0 +1,12 @@
+Metadata-Version: 2.5
+Name: gyomu-schema
+Version: 0.1.1
+Summary: Gyomu canonical schemas
+Requires-Python: >=3.14
+Requires-Dist: pydantic<3,>=2
+Requires-Dist: returns>=0.29.0
+Description-Content-Type: text/markdown
+
+# gyomu-schema
+
+Canonical schemas and common types for Gyomu Python.

gyomu_schema-0.1.1/README.md

@@ -0,0 +1,3 @@
+# gyomu-schema
+
+Canonical schemas and common types for Gyomu Python.

gyomu_schema-0.1.1/pyproject.toml

@@ -0,0 +1,17 @@
+[project]
+name = "gyomu-schema"
+dynamic = ["version"]
+description = "Gyomu canonical schemas"
+readme = "README.md"
+requires-python = ">=3.14"
+dependencies = [
+    "pydantic>=2,<3",
+    "returns>=0.29.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+path = "../../version/__about__.py"

gyomu_schema-0.1.1/src/gyomu_schema/config/config_loader_option.py

@@ -0,0 +1,35 @@
+from collections.abc import Mapping
+from dataclasses import dataclass
+from pathlib import Path
+
+
+@dataclass(frozen=True)
+class EnvironmentLoaderOption:
+    variables: Mapping[str, str]
+    use_dot_env: bool = False
+    dot_env_path: Path | None = None
+
+
+@dataclass(frozen=True)
+class BaseFileLoaderOption:
+    file_path: Path
+
+
+@dataclass(frozen=True)
+class JsonLoaderOption(BaseFileLoaderOption):
+    pass
+
+
+@dataclass(frozen=True)
+class YamlLoaderOption(BaseFileLoaderOption):
+    pass
+
+
+@dataclass(frozen=True)
+class TomlLoaderOption(BaseFileLoaderOption):
+    pass
+
+
+type ConfigLoaderOption = (
+    EnvironmentLoaderOption | JsonLoaderOption | YamlLoaderOption | TomlLoaderOption
+)

gyomu_schema-0.1.1/src/gyomu_schema/convert.py

@@ -0,0 +1,38 @@
+import json
+
+from pydantic import BaseModel
+from pydantic import ValidationError as PydanticValidationError
+from returns.result import Failure, Result, Success
+
+from gyomu_schema.error.io import GyomuIOError
+from gyomu_schema.error.validation import ValidationError
+
+
+def convert[T: BaseModel](
+    schema: type[T],
+    value: object,
+) -> Result[T, ValidationError]:
+    try:
+        return Success(schema.model_validate(value))
+    except PydanticValidationError as exc:
+        return Failure(
+            ValidationError(
+                message="Schema validation failed",
+                input=value,
+                details={
+                    "issues": exc.errors(),
+                },
+            ).chain(exc)
+        )
+
+
+def convert_json[T: BaseModel](
+    schema: type[T],
+    content: str,
+) -> Result[T, GyomuIOError | ValidationError]:
+    try:
+        value = json.loads(content)
+    except json.JSONDecodeError as exc:
+        return Failure(GyomuIOError("Fail to load JSON").chain(exc))
+
+    return convert(schema, value)

gyomu_schema-0.1.1/src/gyomu_schema/db/config.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel
+
+
+class DbConfig(BaseModel):
+    connection_string: str

gyomu_schema-0.1.1/src/gyomu_schema/error/__init__.py

@@ -0,0 +1,16 @@
+from gyomu_schema.error.base import BaseError
+from gyomu_schema.error.config import ConfigError
+from gyomu_schema.error.database import DatabaseError
+from gyomu_schema.error.gyomu import GyomuError, GyomuErrorReason
+from gyomu_schema.error.io import GyomuIOError
+from gyomu_schema.error.validation import ValidationError
+
+__all__ = [
+    "BaseError",
+    "ConfigError",
+    "DatabaseError",
+    "GyomuError",
+    "GyomuErrorReason",
+    "GyomuIOError",
+    "ValidationError",
+]

gyomu_schema-0.1.1/src/gyomu_schema/error/base.py

@@ -0,0 +1,56 @@
+from collections.abc import Mapping
+from typing import Self
+
+
+class BaseError(Exception):
+    """Base class for Gyomu application errors.
+
+    Provides common contextual information for errors in addition to the
+    information already provided by Python's :class:`Exception`.
+
+    Args:
+        message: A human-readable description of the error.
+        context: An error context identifier.
+        details: Additional structured diagnostic information.
+
+    Attributes:
+        context: The error context identifier.
+        details: Additional structured diagnostic information.
+
+    Gyomu Context:
+        context identifies the operation or location where the error occurred.
+        It describes what the application was doing when the error occurred
+        and does not replace the Python traceback.
+
+        details contains additional structured information useful for
+        diagnosing the error, such as relevant input values, configuration
+        metadata, or other operational information.
+
+        The original cause of an error is represented by Python's exception
+        chaining mechanism (__cause__). The :meth:`chain` method can be used
+        to explicitly associate an underlying exception as the cause.
+    """
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        context: str | None = None,
+        details: Mapping[str, object] | None = None,
+    ) -> None:
+        """Initialize a BaseError."""
+        super().__init__(message)
+        self.context = context
+        self.details = details
+
+    def chain(self, cause: BaseException) -> Self:
+        """Associate an exception as the explicit cause of this error.
+
+        Args:
+            cause: The underlying exception that caused this error.
+
+        Returns:
+            This error instance.
+        """
+        self.__cause__ = cause
+        return self

gyomu_schema-0.1.1/src/gyomu_schema/error/config.py

@@ -0,0 +1,30 @@
+from collections.abc import Mapping
+from typing import Literal
+
+from gyomu_schema.error.base import BaseError
+
+type ConfigPhase = Literal["load", "parse", "decode", "validate"]
+type ConfigSource = Literal["env", "yaml", "json", "toml"]
+
+
+class ConfigError(BaseError):
+    """Configuration error."""
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        source: ConfigSource,
+        schema: object,
+        phase: ConfigPhase,
+        context: str | None = None,
+        details: Mapping[str, object] | None = None,
+    ) -> None:
+        super().__init__(
+            message,
+            context=context,
+            details=details,
+        )
+        self.source = source
+        self.schema = schema
+        self.phase = phase

gyomu_schema-0.1.1/src/gyomu_schema/error/database.py

@@ -0,0 +1,5 @@
+from gyomu_schema.error.io import GyomuIOError
+
+
+class DatabaseError(GyomuIOError):
+    """Database access error."""

gyomu_schema-0.1.1/src/gyomu_schema/error/gyomu.py

@@ -0,0 +1,38 @@
+from collections.abc import Mapping
+from typing import Literal
+
+from gyomu_schema.error.base import BaseError
+
+GyomuErrorReason = Literal[
+    "invalid_input",
+    "not_found",
+    "external_failure",
+    "unexpected",
+    "concurrent_modification",
+    "out_of_bounds",
+]
+
+
+class GyomuError(BaseError):
+    """Application-level Gyomu error."""
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        operation: str,
+        domain: str,
+        reason: GyomuErrorReason,
+        retryable: bool = False,
+        context: str | None = None,
+        details: Mapping[str, object] | None = None,
+    ) -> None:
+        super().__init__(
+            message,
+            context=context,
+            details=details,
+        )
+        self.operation = operation
+        self.domain = domain
+        self.reason = reason
+        self.retryable = retryable

gyomu_schema-0.1.1/src/gyomu_schema/error/io.py

@@ -0,0 +1,5 @@
+from gyomu_schema.error.base import BaseError
+
+
+class GyomuIOError(BaseError):
+    """I/O related error."""

gyomu_schema-0.1.1/src/gyomu_schema/error/timeout.py

@@ -0,0 +1,28 @@
+from collections.abc import Mapping
+
+from gyomu_schema.error.base import BaseError
+
+
+class GyomuTimeoutError(BaseError):
+    """Timeout related error."""
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        action: str,
+        timeout_seconds: float,
+        interval_seconds: float | None = None,
+        elapsed_seconds: float | None = None,
+        context: str | None = None,
+        details: Mapping[str, object] | None = None,
+    ) -> None:
+        super().__init__(
+            message,
+            context=context,
+            details=details,
+        )
+        self.action = action
+        self.timeout_seconds = timeout_seconds
+        self.interval_seconds = interval_seconds
+        self.elapsed_seconds = elapsed_seconds

gyomu_schema-0.1.1/src/gyomu_schema/error/validation.py

@@ -0,0 +1,24 @@
+from collections.abc import Mapping
+
+from gyomu_schema.error.base import BaseError
+
+
+class ValidationError(BaseError):
+    """Validation error."""
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        location: tuple[str | int, ...] | None = None,
+        input: object | None = None,
+        context: str | None = None,
+        details: Mapping[str, object] | None = None,
+    ) -> None:
+        super().__init__(
+            message,
+            context=context,
+            details=details,
+        )
+        self.location = location
+        self.input = input

gyomu_schema-0.1.1/src/gyomu_schema/filesystem/file.py

@@ -0,0 +1,213 @@
+from datetime import UTC, datetime
+from enum import Enum
+from os import path
+from pathlib import Path
+
+
+class FileInfo:
+    @staticmethod
+    def epoch_to_datetimeutc(epoch: float) -> datetime:
+        return datetime.fromtimestamp(epoch, tz=UTC)
+
+    file_name: str
+    full_path: Path
+    dir_name: str
+    dir_path: Path
+    size: int
+    extension: str
+    create_time_utc: datetime
+    update_time_utc: datetime
+    last_access_time_utc: datetime
+
+    def __init__(self, file_path: Path):
+        p = file_path
+        self.file_name = p.name
+        self.full_path = p.resolve()
+        self.dir_name = p.parent.name
+        self.dir_path = p.parent
+        self.size = path.getsize(file_path)
+        self.extension = "".join(p.suffix)
+        self.create_time_utc = FileInfo.epoch_to_datetimeutc(path.getctime(p))
+        self.update_time_utc = FileInfo.epoch_to_datetimeutc(path.getmtime(p))
+        self.last_access_time_utc = FileInfo.epoch_to_datetimeutc(path.getatime(p))
+
+
+class FileFilterType(Enum):
+    FILE_NAME = "file_name"
+    CREATE_TIME_UTC = "create_time_utc"
+    LAST_ACCESS_TIME_UTC = "last_access_time_utc"
+    LAST_WRITE_TIME_UTC = "last_write_time_utc"
+
+
+class FileCompareType(Enum):
+    EQUAL = "equal"
+    LARGER = "larger"
+    LESS = "less"
+    LARGER_OR_EQUAL = "larger_or_equal"
+    LESS_OR_EQUAL = "less_or_equal"
+
+
+class FileFilterInfo:
+    name_filter: str
+    target_date: datetime
+
+    def __init__(
+        self,
+        kind: FileFilterType,
+        operator: FileCompareType,
+        value: object,
+    ):
+        self.kind = kind
+        self.operator = operator
+
+        if self.kind == FileFilterType.FILE_NAME:
+            self.name_filter = str(value)
+        elif isinstance(value, datetime):
+            self.target_date = value
+        elif isinstance(value, str):
+            try:
+                self.target_date = datetime.strptime(value, "%Y%m%d")
+            except ValueError as e:
+                raise ValueError(f"Date Parameter is invalid: {value}") from e
+        else:
+            raise ValueError(f"Date Parameter is invalid: {value}")
+
+
+class FileTransportInfo:
+    """
+    Base	Sdir	Sname	Ddir	Dname		(S)full+base	    (S)Full	    (S)path (S)name (D)full	    (D)path (D)name
+    x   	x	    x	    x	    x		    base/SDir/Sname	    SDir/Sname	SDir    Sname   Ddir/Dname	Ddir    Dname
+    x   	x   	x	    x	    	    	base/SDir/Sname	    SDir/Sname	SDir    Sname   Ddir/Sname	Ddir    Sname
+    x   	x	    x   	    	x	    	base/SDir/Sname	    SDir/Sname	SDir    Sname   SDir/Dname	Sdir    Dname
+    x   	x	    x	    	    	    	base/SDir/Sname	    SDir/Sname	SDir    Sname   SDir/Sname	SDir    Sname
+    x   	x   	    	x   	    		base/SDir	          SDir	      SDir		        Ddir	      Ddir
+    x   	x	                				base/SDir	          SDir	      SDir		        SDir	      SDir
+    x                   						base
+    x	            		x	        		base				                                    Ddir	      Ddir
+    x   	    	x   	x   	x	    	base/Sname	        Sname		            Sname	  Ddir/Dname	Ddir	  Dname
+    x   	    	x	    x	        		base/Sname	        Sname		            Sname	  Ddir/Sname	Ddir	  Sname
+    x       		x	        	x	    	base/Sname	        Sname		            Sname	  Dname		            Dname
+    x	        	x	            			base/Sname	        Sname		            Sname	  Sname		            Sname
+          x   	x   	x	    x	                          SDir/Sname	SDir	  Sname	  Ddir/Dname	Ddir	  Dname
+          x	    x	    x				                          SDir/Sname	SDir	  Sname	  Ddir/Sname	Ddir	  Sname
+          x	    x		        x			                      SDir/Sname	SDir	  Sname	  SDir/Dname	SDir	  Dname
+          x	    x					                              SDir/Sname	SDir	  Sname	  SDir/Sname	SDir	  Sname
+          x	        	x				                          SDir	      SDir	    	    Ddir	      Ddir
+          x						                                  SDir	      SDir		        SDir	      SDir
+                x	    x	    x			                      Sname		            Sname	  Ddir/Dname	Ddir	  Dname
+                x	    x				                          Sname		            Sname	  Ddir/Sname	Ddir	  Sname
+                x		        x			                      Sname		            Sname	  Dname		            Dname
+                x					                              Sname		            Sname	  Sname		            Sname
+    """  # noqa: E501
+
+    __source_filename: str
+    __source_folder_name: str
+    __base_path: str
+    __destination_filename: str
+    __destination_folder_name: str
+    delete_sourcefile_after_completion: bool = False
+    overwrite_destination: bool = False
+    filter_conditions: list[FileFilterInfo] | None = None
+
+    @property
+    def is_source_directory(self) -> bool:
+        return not self.source_filename
+
+    @property
+    def is_destination_directory(self) -> bool:
+        return not self.destination_filename
+
+    @property
+    def is_destination_root(self) -> bool:
+        return bool(
+            not self.__source_folder_name and not self.__destination_folder_name
+        )
+
+    @property
+    def source_fullname(self) -> str:
+        if not self.__source_folder_name:
+            return self.__source_filename
+        if not self.__source_filename:
+            return self.__source_folder_name
+        return path.join(self.__source_folder_name, self.__source_filename)
+
+    @property
+    def source_fullname_with_basepath(self) -> str:
+        if not self.source_fullname:
+            return self.__base_path
+        return (
+            self.source_fullname
+            if not self.__base_path
+            else path.join(self.__base_path, self.source_fullname)
+        )
+
+    @property
+    def source_path(self) -> str:
+        return self.__source_folder_name
+
+    @property
+    def source_filename(self) -> str:
+        return self.__source_filename
+
+    @property
+    def destination_filename(self) -> str:
+        return (
+            self.__source_filename
+            if not self.__destination_filename
+            else self.__destination_filename
+        )
+
+    @property
+    def destination_path(self) -> str:
+        return (
+            self.__source_folder_name
+            if not self.__destination_folder_name
+            else self.__destination_folder_name
+        )
+
+    @property
+    def destination_fullname(self) -> str:
+        if not self.destination_path:
+            return self.destination_filename
+        if not self.destination_filename:
+            return self.destination_path
+        return path.join(self.destination_path, self.destination_filename)
+
+    def __init__(
+        self,
+        base_path: str = "",
+        source_filename: str = "",
+        source_folder_name: str = "",
+        destination_filename: str = "",
+        destination_foldername: str = "",
+        delete_sourcefile_after_completion: bool = False,
+        overwrite_destination: bool = False,
+        filter_conditions: list[FileFilterInfo] | None = None,
+    ):
+        self.__base_path = base_path
+        self.__source_filename = source_filename
+        self.__source_folder_name = source_folder_name
+        self.__destination_filename = destination_filename
+        self.__destination_folder_name = destination_foldername
+        self.delete_sourcefile_after_completion = delete_sourcefile_after_completion
+        self.overwrite_destination = overwrite_destination
+        self.filter_conditions = filter_conditions
+
+        if not self.__source_filename and self.__destination_filename:
+            raise ValueError("Invalid Parameter")
+
+        if (
+            not self.__base_path
+            and not self.__source_folder_name
+            and not self.__source_filename
+        ):
+            raise ValueError("Invalid Parameter")
+
+
+class FileArchiveType(Enum):
+    ZIP = ("zip",)
+    TGZ = ("tgz",)
+    BZIP2 = ("bz2",)
+    GZIP = ("gz",)
+    TAR = ("tar",)
+    GuessFromFileName = "unknown"

gyomu_schema-0.1.1/src/gyomu_schema/gyomu/holiday/business_calendar.py

@@ -0,0 +1,68 @@
+from datetime import date
+from typing import Protocol
+
+
+class BusinessCalendar(Protocol):
+    def is_business_day(
+        self,
+        target_date: date,
+    ) -> bool: ...
+
+    def business_day(
+        self,
+        target_date: date,
+        day_offset: int,
+    ) -> date: ...
+
+    def get_holidays(
+        self,
+        start_date: date,
+        end_date: date,
+    ) -> list[date]: ...
+
+    def business_day_of_beginning_month_with_offset(
+        self,
+        target_date: date,
+        day_offset: int = 1,
+    ) -> date: ...
+
+    def business_day_of_beginning_of_next_month_with_offset(
+        self,
+        target_date: date,
+        day_offset: int = 1,
+    ) -> date: ...
+
+    def business_day_of_beginning_of_previous_month_with_offset(
+        self,
+        target_date: date,
+        day_offset: int = 1,
+    ) -> date: ...
+    def business_day_of_end_month_with_offset(
+        self,
+        target_date: date,
+        day_offset: int,
+    ) -> date: ...
+
+    def business_day_of_end_of_next_month_with_offset(
+        self,
+        target_date: date,
+        day_offset: int,
+    ) -> date: ...
+
+    def business_day_of_end_of_previous_month_with_offset(
+        self,
+        target_date: date,
+        day_offset: int,
+    ) -> date: ...
+
+    def business_day_of_beginning_of_year(
+        self,
+        target_date: date,
+        day_offset: int,
+    ) -> date: ...
+
+    def business_day_of_end_of_year(
+        self,
+        target_date: date,
+        day_offset: int,
+    ) -> date: ...