lazyscribe-joblib 0.1.0__tar.gz

lazyscribe_joblib-0.1.0/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.3
+Name: lazyscribe-joblib
+Version: 0.1.0
+Summary: Joblib-based artifact handlers for Lazyscribe
+Author: Akshay Gupta
+Author-email: Akshay Gupta <akgcodes@gmail.com>
+License: MIT license
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: attrs>=21.2.0,<=25.3.0
+Requires-Dist: joblib>=1.2.0,<=1.5.2
+Requires-Dist: lazyscribe>=1.0.0,<2
+Requires-Dist: python-slugify>=5.0.0,<=8.0.4
+Requires-Dist: build ; extra == 'build'
+Requires-Dist: commitizen ; extra == 'build'
+Requires-Dist: twine ; extra == 'build'
+Requires-Dist: wheel ; extra == 'build'
+Requires-Dist: lazyscribe-joblib[build] ; extra == 'dev'
+Requires-Dist: lazyscribe-joblib[qa] ; extra == 'dev'
+Requires-Dist: lazyscribe-joblib[tests] ; extra == 'dev'
+Requires-Dist: edgetest ; extra == 'qa'
+Requires-Dist: mypy ; extra == 'qa'
+Requires-Dist: pre-commit ; extra == 'qa'
+Requires-Dist: pyproject-fmt ; extra == 'qa'
+Requires-Dist: ruff ; extra == 'qa'
+Requires-Dist: types-python-slugify ; extra == 'qa'
+Requires-Dist: uv ; extra == 'qa'
+Requires-Dist: pytest ; extra == 'tests'
+Requires-Dist: pytest-cov ; extra == 'tests'
+Requires-Dist: scikit-learn ; extra == 'tests'
+Requires-Dist: time-machine ; extra == 'tests'
+Requires-Python: >=3.10.0
+Project-URL: Documentation, https://github.com/lazyscribe/lazyscribe-joblib
+Project-URL: Repository, https://github.com/lazyscribe/lazyscribe-joblib
+Provides-Extra: build
+Provides-Extra: dev
+Provides-Extra: qa
+Provides-Extra: tests
+Description-Content-Type: text/markdown
+
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![PyPI](https://img.shields.io/pypi/v/lazyscribe-joblib)](https://pypi.org/project/lazyscribe-joblib/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/lazyscribe-joblib)](https://pypi.org/project/lazyscrib-joblib/) [![codecov](https://codecov.io/gh/lazyscribe/lazyscribe-joblib/graph/badge.svg?token=W5TPK7GX7G)](https://codecov.io/gh/lazyscribe/lazyscribe-joblib)
+
+# Joblib-based artifact handling for lazyscribe
+
+`lazyscribe-joblib` is a lightweight package that adds the following artifact handlers for `lazyscribe`:
+
+* `joblib`
+
+Any object that can be written with `joblib.dump` and read with `joblib.load` is compatible with this
+handler. Note that we do persist the `joblib` version for runtime environment validation.

lazyscribe_joblib-0.1.0/README.md

@@ -0,0 +1,10 @@
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![PyPI](https://img.shields.io/pypi/v/lazyscribe-joblib)](https://pypi.org/project/lazyscribe-joblib/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/lazyscribe-joblib)](https://pypi.org/project/lazyscrib-joblib/) [![codecov](https://codecov.io/gh/lazyscribe/lazyscribe-joblib/graph/badge.svg?token=W5TPK7GX7G)](https://codecov.io/gh/lazyscribe/lazyscribe-joblib)
+
+# Joblib-based artifact handling for lazyscribe
+
+`lazyscribe-joblib` is a lightweight package that adds the following artifact handlers for `lazyscribe`:
+
+* `joblib`
+
+Any object that can be written with `joblib.dump` and read with `joblib.load` is compatible with this
+handler. Note that we do persist the `joblib` version for runtime environment validation.

lazyscribe_joblib-0.1.0/lazyscribe_joblib/__init__.py

@@ -0,0 +1,168 @@
+"""Joblib-based handler for pickle-serializable objects."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Any, ClassVar
+
+import joblib
+from attrs import define, field
+from importlib_metadata import packages_distributions
+from importlib_metadata import version as importlib_version
+from lazyscribe._utils import utcnow
+from lazyscribe.artifacts.base import Artifact
+from slugify import slugify
+
+__all__: list[str] = ["JoblibArtifact"]
+
+
+@define(auto_attribs=True)
+class JoblibArtifact(Artifact):
+    """Handler for pickle-serializable objects through ``joblib`` package.
+
+    .. important::
+
+        ``joblib`` package should be installed to use this handler.
+
+    This handler will store the ``joblib`` version and the package (or the root module
+    of the ``value``) name and version as attributes to ensure compatibility between
+    the runtime environment and the artifacts.
+
+    .. important::
+
+        This class is not meant to be initialized directly. Please use the ``construct``
+        method.
+
+    Parameters
+    ----------
+    package : str
+        The root module name of the python object to be serialized.
+    package_version : str
+        The installed version of the package pertaining to the python object to be
+        serialized.
+    joblib_version : str
+        The version of ``joblib`` installed.
+    """
+
+    alias: ClassVar[str] = "joblib"
+    suffix: ClassVar[str] = "joblib"
+    binary: ClassVar[bool] = True
+    output_only: ClassVar[bool] = False
+    package: str = field()
+    package_version: str = field()
+    joblib_version: str = field()
+
+    @classmethod
+    def construct(
+        cls,
+        name: str,
+        value: Any = None,
+        fname: str | None = None,
+        created_at: datetime | None = None,
+        writer_kwargs: dict | None = None,
+        version: int = 0,
+        dirty: bool = True,
+        package: str | None = None,
+        **kwargs,
+    ):
+        """Construct the class with the version information.
+
+        Parameters
+        ----------
+        name : str
+            The name of the artifact.
+        value : object, optional (default None)
+            The value for the artifact. The default value of ``None`` is used when
+            an experiment is loaded from the project JSON.
+        fname : str, optional (default None)
+            The filename of the artifact. If not provided, this value will be derived from
+            the name of the artifact and the suffix for the class.
+        created_at : datetime, optional (default None)
+            When the artifact was created. If not supplied, :py:meth:`datetime.now` will be used.
+        package: str, optional (default None)
+            The package name or root module name of the serializable python object.
+            Note: this may be different from the distribution name. e.g ``scikit-learn`` is
+            a distribution name, where as ``sklearn`` is the corresponding package name.
+        writer_kwargs : dict, optional (default None)
+            Keyword arguments for writing an artifact to the filesystem. Provided when an artifact
+            is logged to an experiment.
+        version : int, optional (default 0)
+            Integer version to be used for versioning artifacts.
+        dirty : bool, optional (default True)
+            Whether or not this artifact should be saved when :py:meth:`lazyscribe.project.Project.save`
+            or :py:meth:`lazyscribe.repository.Repository.save` is called. This decision is based
+            on whether the artifact is new or has been updated.
+        **kwargs : dict
+            Other keyword arguments.
+            Usually class attributes obtained from a project JSON.
+        """
+        if package is None:
+            if value is None:
+                raise ValueError(
+                    "If no ``package`` is specified, you must supply a ``value``."
+                )
+            try:
+                package = value.__module__.split(".")[0]
+            except AttributeError as err:
+                raise AttributeError(
+                    "Unable to identify the package based on the supplied ``value``. "
+                    "Please provide an argument for ``package``."
+                ) from err
+
+        try:
+            distribution = packages_distributions()[package][0]
+        except KeyError as err:
+            raise ValueError(f"{package} was not found.") from err
+
+        created_at = created_at or utcnow()
+        return cls(  # type: ignore[call-arg]
+            name=name,
+            value=value,
+            fname=fname
+            or f"{slugify(name)}-{slugify(created_at.strftime('%Y%m%d%H%M%S'))}.{cls.suffix}",
+            created_at=created_at,
+            writer_kwargs=writer_kwargs or {},
+            version=version,
+            dirty=dirty,
+            package=package,
+            package_version=kwargs.get("package_version")
+            or importlib_version(distribution),
+            joblib_version=kwargs.get("joblib_version") or joblib.__version__,
+        )
+
+    @classmethod
+    def read(cls, buf, **kwargs):
+        """Read the python object.
+
+        Parameters
+        ----------
+        buf : file-like object
+            The buffer from the ``fsspec`` filesystem.
+        **kwargs : dict
+            Keyword arguments for ``joblib.load``.
+
+        Returns
+        -------
+        Any
+            The python object.
+        """
+        from joblib import load
+
+        return load(buf, **kwargs)
+
+    @classmethod
+    def write(cls, obj, buf, **kwargs):
+        """Write the python object to the filesystem.
+
+        Parameters
+        ----------
+        obj : object
+            The python object to write.
+        buf : file-like object
+            The buffer from the ``fsspec`` filesystem.
+        **kwargs : dict
+            Keyword arguments for :py:meth:`joblib.load`.
+        """
+        from joblib import dump
+
+        dump(obj, buf, **kwargs)

lazyscribe_joblib-0.1.0/lazyscribe_joblib/_meta.py

@@ -0,0 +1,3 @@
+"""Version."""
+
+__version__ = "0.1.0"

lazyscribe_joblib-0.1.0/pyproject.toml

@@ -0,0 +1,113 @@
+[build-system]
+build-backend = "uv_build"
+
+requires = [ "uv-build>=0.8.0,<0.9.0" ]
+
+[project]
+name = "lazyscribe-joblib"
+version = "0.1.0"
+
+description = "Joblib-based artifact handlers for Lazyscribe"
+readme = { file = "README.md", content-type = "text/markdown" }
+license = { text = "MIT license" }
+authors = [
+    { name = "Akshay Gupta", email = "akgcodes@gmail.com" },
+]
+requires-python = ">=3.10.0"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "License :: OSI Approved :: MIT License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "attrs>=21.2.0,<=25.3.0",
+    "joblib>=1.2.0,<=1.5.2",
+    "lazyscribe>=1.0.0,<2",
+    "python-slugify>=5.0.0,<=8.0.4",
+]
+
+optional-dependencies.build = [ "build", "commitizen", "twine", "wheel" ]
+optional-dependencies.dev = [
+    "lazyscribe-joblib[build]",
+    "lazyscribe-joblib[qa]",
+    "lazyscribe-joblib[tests]",
+]
+optional-dependencies.qa = [
+    "edgetest",
+    "mypy",
+    "pre-commit",
+    "pyproject-fmt",
+    "ruff",
+    "types-python-slugify",
+    "uv",
+]
+optional-dependencies.tests = [ "pytest", "pytest-cov", "scikit-learn", "time-machine" ]
+urls."Documentation" = "https://github.com/lazyscribe/lazyscribe-joblib"
+urls."Repository" = "https://github.com/lazyscribe/lazyscribe-joblib"
+entry-points."lazyscribe.artifact_type".joblib = "lazyscribe_joblib:JoblibArtifact"
+
+[tool.ruff]
+target-version = "py310"
+
+lint.select = [
+    "B",      # flake8-bugbear
+    "C",      # flake8-comprehensions
+    "D",      # pydocstyle
+    "E",      # pycodestyle errors
+    "F",      # pyflakes
+    "I",      # isort
+    "LOG",    # flake8-logging
+    "RUF",    # Ruff errors
+    "SIM",    # flake8-simplify
+    "T20",    # flake8-print
+    "TID252", # flake8-tidy-imports ban relative imports
+    "UP",     # pyupgrade
+    "W",      # pycodestyle warnings
+]
+lint.ignore = [
+    "C901", # Function/method is too complex. (Add back in later.)
+    "E501", # Line too long. Using formatter instead.
+]
+lint.per-file-ignores."**/{tests,docs}/*" = [ "ARG", "D", "E402", "F841" ]
+lint.per-file-ignores."__init__.py" = [ "E402" ]
+lint.per-file-ignores."tutorials/*" = [ "D", "T201" ]
+lint.flake8-tidy-imports.ban-relative-imports = "all"
+lint.pydocstyle.convention = "numpy"
+lint.preview = true
+
+[tool.pyproject-fmt]
+column_width = 88
+indent = 4
+keep_full_version = true
+max_supported_python = "3.13"
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true
+ignore_missing_imports = true
+allow_redefinition = true
+check_untyped_defs = true
+
+[tool.commitizen]
+version_provider = "pep621"
+tag_format = "v$version"
+bump_message = "chore: version $current_version -> $new_version"
+update_changelog_on_bump = true
+version_files = [
+    "lazyscribe_joblib/_meta.py:__version__",
+]
+
+[edgetest.envs.core]
+extras = [ "tests" ]
+upgrade = [ "attrs", "lazyscribe", "joblib", "python-slugify" ]
+command = "pytest tests"
+
+[tool.uv.build-backend]
+module-name = "lazyscribe_joblib"
+module-root = ""