cryoflow-plugin-collections 0.2.0__tar.gz

cryoflow_plugin_collections-0.2.0/.gitignore

@@ -0,0 +1,227 @@
+# Python.gitignore
+# @see: https://github.com/github/gitignore/blob/main/Python.gitignore
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# Nix.gitignore
+# @see: https://github.com/github/gitignore/blob/main/Nix.gitignore
+# Ignore build outputs from performing a nix-build or `nix build` command
+result
+result-*
+
+# Ignore automatically generated direnv output
+.direnv

cryoflow_plugin_collections-0.2.0/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: cryoflow-plugin-collections
+Version: 0.2.0
+Summary: Sample plugin for cryoflow
+Project-URL: Homepage, https://github.com/yasunori0418/cryoflow
+Project-URL: Repository, https://github.com/yasunori0418/cryoflow
+Project-URL: Issues, https://github.com/yasunori0418/cryoflow/issues
+Author-email: yasunori0418 <yasunori.kirin0418@gmail.com>
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: cryoflow-core
+Requires-Dist: polars>=1.37.1
+Requires-Dist: returns>=0.23.0

cryoflow_plugin_collections-0.2.0/cryoflow_plugin_collections/__init__.py

@@ -0,0 +1,41 @@
+"""cryoflow plugin collections.
+
+This package provides:
+1. Built-in sample plugins for cryoflow
+   - ColumnMultiplierPlugin: Multiply numeric columns by a factor
+   - ParquetWriterPlugin: Write data to Parquet files
+
+2. Library re-exports for external plugin development (libs subpackage)
+   - Reduces additional dependencies for external plugin developers
+   - Ensures version compatibility with cryoflow-core
+
+For External Plugin Developers:
+    # Recommended: Import from libs to reduce dependencies
+    from cryoflow_plugin_collections.libs.polars import pl
+    from cryoflow_plugin_collections.libs.returns import Result, Success, Failure
+    from cryoflow_plugin_collections.libs.core import TransformPlugin, FrameData
+
+    class MyCustomPlugin(TransformPlugin):
+        def execute(self, df: FrameData) -> Result[FrameData, Exception]:
+            # Your implementation
+            pass
+
+For Built-in Sample Plugins:
+    # Sample plugins use direct imports (internal implementation detail)
+    import polars as pl
+    from returns.result import Result, Success, Failure
+    from cryoflow_core.plugin import TransformPlugin, FrameData
+"""
+
+from importlib.metadata import version, PackageNotFoundError
+
+from cryoflow_plugin_collections.output import ParquetWriterPlugin
+from cryoflow_plugin_collections.transform import ColumnMultiplierPlugin
+
+try:
+    __version__ = version('cryoflow-plugin-collections')
+except PackageNotFoundError:
+    # Fallback for development environment
+    __version__ = 'unknown'
+
+__all__ = ['ColumnMultiplierPlugin', 'ParquetWriterPlugin']

cryoflow_plugin_collections-0.2.0/cryoflow_plugin_collections/input/__init__.py

@@ -0,0 +1 @@
+"""Input plugins for cryoflow."""

cryoflow_plugin_collections-0.2.0/cryoflow_plugin_collections/input/csv_scan.py

@@ -0,0 +1,52 @@
+"""CSV input plugin for cryoflow."""
+
+import polars as pl
+from returns.result import Failure, Result, Success
+
+from cryoflow_core.plugin import FrameData, InputPlugin
+
+
+class CsvScanPlugin(InputPlugin):
+    """Load data from a CSV file using lazy evaluation.
+
+    Options:
+        input_path (str | Path): Path to the input CSV file.
+    """
+
+    def name(self) -> str:
+        """Return the plugin identifier name."""
+        return 'csv_scan'
+
+    def execute(self) -> Result[FrameData, Exception]:
+        """Load data from a CSV file.
+
+        Returns:
+            Result containing LazyFrame on success or Exception on failure.
+        """
+        try:
+            input_path_opt = self.options.get('input_path')
+            if input_path_opt is None:
+                return Failure(ValueError("Option 'input_path' is required"))
+            input_path = self.resolve_path(input_path_opt)
+            if not input_path.exists():
+                return Failure(FileNotFoundError(f'Input file not found: {input_path}'))
+            return Success(pl.scan_csv(input_path))
+        except Exception as e:
+            return Failure(e)
+
+    def dry_run(self) -> Result[dict[str, pl.DataType], Exception]:
+        """Return the schema of the CSV file without loading data.
+
+        Returns:
+            Result containing schema dict on success or Exception on failure.
+        """
+        try:
+            input_path_opt = self.options.get('input_path')
+            if input_path_opt is None:
+                return Failure(ValueError("Option 'input_path' is required"))
+            input_path = self.resolve_path(input_path_opt)
+            if not input_path.exists():
+                return Failure(FileNotFoundError(f'Input file not found: {input_path}'))
+            return Success(dict(pl.scan_csv(input_path).collect_schema()))
+        except Exception as e:
+            return Failure(e)

cryoflow_plugin_collections-0.2.0/cryoflow_plugin_collections/input/ipc_scan.py

@@ -0,0 +1,52 @@
+"""IPC (Arrow) input plugin for cryoflow."""
+
+import polars as pl
+from returns.result import Failure, Result, Success
+
+from cryoflow_core.plugin import FrameData, InputPlugin
+
+
+class IpcScanPlugin(InputPlugin):
+    """Load data from an IPC (Arrow) file using lazy evaluation.
+
+    Options:
+        input_path (str | Path): Path to the input IPC file.
+    """
+
+    def name(self) -> str:
+        """Return the plugin identifier name."""
+        return 'ipc_scan'
+
+    def execute(self) -> Result[FrameData, Exception]:
+        """Load data from an IPC file.
+
+        Returns:
+            Result containing LazyFrame on success or Exception on failure.
+        """
+        try:
+            input_path_opt = self.options.get('input_path')
+            if input_path_opt is None:
+                return Failure(ValueError("Option 'input_path' is required"))
+            input_path = self.resolve_path(input_path_opt)
+            if not input_path.exists():
+                return Failure(FileNotFoundError(f'Input file not found: {input_path}'))
+            return Success(pl.scan_ipc(input_path))
+        except Exception as e:
+            return Failure(e)
+
+    def dry_run(self) -> Result[dict[str, pl.DataType], Exception]:
+        """Return the schema of the IPC file without loading data.
+
+        Returns:
+            Result containing schema dict on success or Exception on failure.
+        """
+        try:
+            input_path_opt = self.options.get('input_path')
+            if input_path_opt is None:
+                return Failure(ValueError("Option 'input_path' is required"))
+            input_path = self.resolve_path(input_path_opt)
+            if not input_path.exists():
+                return Failure(FileNotFoundError(f'Input file not found: {input_path}'))
+            return Success(dict(pl.scan_ipc(input_path).collect_schema()))
+        except Exception as e:
+            return Failure(e)

cryoflow_plugin_collections-0.2.0/cryoflow_plugin_collections/input/parquet_scan.py

@@ -0,0 +1,52 @@
+"""Parquet input plugin for cryoflow."""
+
+import polars as pl
+from returns.result import Failure, Result, Success
+
+from cryoflow_core.plugin import FrameData, InputPlugin
+
+
+class ParquetScanPlugin(InputPlugin):
+    """Load data from a Parquet file using lazy evaluation.
+
+    Options:
+        input_path (str | Path): Path to the input Parquet file.
+    """
+
+    def name(self) -> str:
+        """Return the plugin identifier name."""
+        return 'parquet_scan'
+
+    def execute(self) -> Result[FrameData, Exception]:
+        """Load data from a Parquet file.
+
+        Returns:
+            Result containing LazyFrame on success or Exception on failure.
+        """
+        try:
+            input_path_opt = self.options.get('input_path')
+            if input_path_opt is None:
+                return Failure(ValueError("Option 'input_path' is required"))
+            input_path = self.resolve_path(input_path_opt)
+            if not input_path.exists():
+                return Failure(FileNotFoundError(f'Input file not found: {input_path}'))
+            return Success(pl.scan_parquet(input_path))
+        except Exception as e:
+            return Failure(e)
+
+    def dry_run(self) -> Result[dict[str, pl.DataType], Exception]:
+        """Return the schema of the Parquet file without loading data.
+
+        Returns:
+            Result containing schema dict on success or Exception on failure.
+        """
+        try:
+            input_path_opt = self.options.get('input_path')
+            if input_path_opt is None:
+                return Failure(ValueError("Option 'input_path' is required"))
+            input_path = self.resolve_path(input_path_opt)
+            if not input_path.exists():
+                return Failure(FileNotFoundError(f'Input file not found: {input_path}'))
+            return Success(dict(pl.scan_parquet(input_path).collect_schema()))
+        except Exception as e:
+            return Failure(e)

cryoflow_plugin_collections-0.2.0/cryoflow_plugin_collections/libs/__init__.py

@@ -0,0 +1,21 @@
+"""Library re-exports for external cryoflow plugin development.
+
+This subpackage provides convenient re-exports of commonly used libraries
+for external plugin developers. By importing from this package, you can
+reduce additional dependencies and ensure version compatibility.
+
+Available modules:
+- polars: Data processing with Polars
+- returns: Error handling with Result monad
+- core: cryoflow_core base classes and types
+
+Usage (for external plugin developers):
+    from cryoflow_plugin_collections.libs.polars import pl
+    from cryoflow_plugin_collections.libs.returns.result import Result, Success, Failure
+    from cryoflow_plugin_collections.libs.core import TransformPlugin, FrameData
+
+Note: Built-in sample plugins (transform/multiplier, output/parquet_writer)
+use direct imports and do not rely on this re-export mechanism.
+"""
+
+# Intentionally minimal - import specific modules as needed

cryoflow_plugin_collections-0.2.0/cryoflow_plugin_collections/libs/core.py

@@ -0,0 +1,32 @@
+"""Cryoflow core types re-export for plugin development.
+
+Provides base classes and type definitions from cryoflow_core that are
+commonly used when developing plugins.
+
+Usage:
+    from cryoflow_plugin_collections.libs.core import (
+        FrameData,
+        InputPlugin,
+        TransformPlugin,
+        OutputPlugin,
+    )
+
+    class MyPlugin(TransformPlugin):
+        def execute(self, df: FrameData) -> Result[FrameData, Exception]:
+            # Your implementation
+            pass
+"""
+
+from cryoflow_core.plugin import (
+    FrameData as FrameData,
+    InputPlugin as InputPlugin,
+    OutputPlugin as OutputPlugin,
+    TransformPlugin as TransformPlugin,
+)
+
+__all__ = [
+    'FrameData',  # Type alias: LazyFrame | DataFrame
+    'InputPlugin',  # Base class for input plugins
+    'TransformPlugin',  # Base class for transform plugins
+    'OutputPlugin',  # Base class for output plugins
+]

cryoflow_plugin_collections-0.2.0/cryoflow_plugin_collections/libs/polars.py

@@ -0,0 +1,26 @@
+"""Polars re-export for plugin development.
+
+Provides complete polars API re-export for external plugin developers.
+This module transparently re-exports all 228+ public APIs from polars,
+ensuring version compatibility and reducing dependency management overhead.
+
+Usage:
+    # Import as module (enables pl.col(), pl.DataFrame(), etc.)
+    from cryoflow_plugin_collections.libs import polars as pl
+    pl.col("name")
+
+    # Import the polars module object
+    from cryoflow_plugin_collections.libs.polars import pl
+    pl.col("name")
+
+    # Import individual functions/types
+    from cryoflow_plugin_collections.libs.polars import col, lit, when, DataFrame, LazyFrame
+
+All imports provide full type hints and IDE autocomplete support.
+"""
+
+import polars as pl
+from polars import *  # noqa: F403, F401 # pyright: ignore[reportWildcardImportFromLibrary]
+
+# Build __all__ dynamically to include all polars public APIs plus 'pl'
+__all__ = [name for name in dir(pl) if not name.startswith('_')]  # pyright: ignore[reportUnsupportedDunderAll]

cryoflow_plugin_collections-0.2.0/cryoflow_plugin_collections/libs/returns/__init__.py

@@ -0,0 +1,7 @@
+"""`returns` library re-export for plugin development.
+
+Submodules:
+- result: Result, Success, Failure, ResultE, safe
+- maybe: Maybe, Some, Nothing, maybe
+
+"""

cryoflow_plugin_collections-0.2.0/cryoflow_plugin_collections/libs/returns/maybe.py

@@ -0,0 +1,13 @@
+from returns.maybe import (
+    Maybe as Maybe,
+    Nothing as Nothing,
+    Some as Some,
+    maybe as maybe,
+)
+
+__all__ = [
+    'maybe',
+    'Maybe',
+    'Nothing',
+    'Some',
+]

cryoflow_plugin_collections-0.2.0/cryoflow_plugin_collections/libs/returns/result.py

@@ -0,0 +1,15 @@
+from returns.result import (
+    Failure as Failure,
+    Result as Result,
+    ResultE as ResultE,
+    Success as Success,
+    safe as safe,
+)
+
+__all__ = [
+    'Failure',
+    'Result',
+    'ResultE',
+    'Success',
+    'safe',
+]

cryoflow_plugin_collections-0.2.0/cryoflow_plugin_collections/output/__init__.py

@@ -0,0 +1,5 @@
+"""Output plugins for cryoflow."""
+
+from cryoflow_plugin_collections.output.parquet_writer import ParquetWriterPlugin
+
+__all__ = ['ParquetWriterPlugin']

cryoflow_plugin_collections-0.2.0/cryoflow_plugin_collections/output/parquet_writer.py

@@ -0,0 +1,75 @@
+"""Sample output plugin for cryoflow."""
+
+from pathlib import Path
+
+import polars as pl
+from returns.result import Failure, Result, Success
+
+from cryoflow_core.plugin import FrameData, OutputPlugin
+
+
+class ParquetWriterPlugin(OutputPlugin):
+    """Write data frame to Parquet file.
+
+    Options:
+        output_path (str | Path): Path to the output Parquet file.
+    """
+
+    def name(self) -> str:
+        """Return the plugin identifier name."""
+        return 'parquet_writer'
+
+    def execute(self, df: FrameData) -> Result[None, Exception]:
+        """Write the data frame to a Parquet file.
+
+        Args:
+            df: Input LazyFrame or DataFrame.
+
+        Returns:
+            Result containing None on success or Exception on failure.
+        """
+        try:
+            output_path_opt = self.options.get('output_path')
+            if output_path_opt is None:
+                return Failure(ValueError("Option 'output_path' is required"))
+
+            output_path = self.resolve_path(output_path_opt)
+
+            # Create parent directory if needed
+            output_path.parent.mkdir(parents=True, exist_ok=True)
+
+            # Write based on frame type
+            if isinstance(df, pl.LazyFrame):
+                df.sink_parquet(output_path)
+            else:  # DataFrame
+                df.write_parquet(output_path)
+
+            return Success(None)
+        except Exception as e:
+            return Failure(e)
+
+    def dry_run(self, schema: dict[str, pl.DataType]) -> Result[dict[str, pl.DataType], Exception]:
+        """Validate that output path is writable.
+
+        Args:
+            schema: Input schema (not modified by output plugin).
+
+        Returns:
+            Result containing schema unchanged or Exception on failure.
+        """
+        try:
+            output_path_opt = self.options.get('output_path')
+            if output_path_opt is None:
+                return Failure(ValueError("Option 'output_path' is required"))
+
+            output_path = self.resolve_path(output_path_opt)
+
+            # Check if parent directory can be created
+            try:
+                output_path.parent.mkdir(parents=True, exist_ok=True)
+            except Exception as e:
+                return Failure(ValueError(f'Cannot create parent directory for {output_path}: {e}'))
+
+            return Success(schema)
+        except Exception as e:
+            return Failure(e)

cryoflow_plugin_collections-0.2.0/cryoflow_plugin_collections/transform/__init__.py

@@ -0,0 +1,5 @@
+"""Transform plugins for cryoflow."""
+
+from cryoflow_plugin_collections.transform.multiplier import ColumnMultiplierPlugin
+
+__all__ = ['ColumnMultiplierPlugin']