pyrig 2.2.6__py3-none-any.whl

pyrig/dev/configs/python/subcommands.py

@@ -0,0 +1,27 @@
+"""Configuration for the subcommands.py CLI extension file.
+
+This module provides the SubcommandsConfigFile class for creating
+a subcommands.py file where users can define custom CLI subcommands.
+"""
+
+from types import ModuleType
+
+from pyrig.dev.cli import subcommands
+from pyrig.dev.configs.base.base import CopyModuleOnlyDocstringConfigFile
+
+
+class SubcommandsConfigFile(CopyModuleOnlyDocstringConfigFile):
+    """Configuration file manager for subcommands.py.
+
+    Creates a subcommands.py file with only the docstring from pyrig's
+    subcommands module, allowing users to add custom CLI subcommands.
+    """
+
+    @classmethod
+    def get_src_module(cls) -> ModuleType:
+        """Get the source module to copy docstring from.
+
+        Returns:
+            The pyrig.dev.cli.subcommands module.
+        """
+        return subcommands

pyrig/dev/configs/testing/__init__.py

@@ -0,0 +1,5 @@
+"""Test configuration file management.
+
+This package provides ConfigFile subclasses for creating and managing
+test infrastructure files like conftest.py and test skeleton files.
+"""

pyrig/dev/configs/testing/conftest.py

@@ -0,0 +1,64 @@
+"""Configuration for the pytest conftest.py file.
+
+This module provides the ConftestConfigFile class for creating
+the tests/conftest.py file that configures pytest plugins.
+"""
+
+from pyrig.dev.configs.base.base import PythonTestsConfigFile
+from pyrig.src.modules.module import make_obj_importpath
+from pyrig.src.os.os import run_subprocess
+from pyrig.src.project.mgt import PROJECT_MGT_RUN_ARGS
+
+
+class ConftestConfigFile(PythonTestsConfigFile):
+    """Configuration file manager for conftest.py.
+
+    Creates a conftest.py that imports pyrig's test fixtures and
+    plugins for consistent test infrastructure.
+    """
+
+    @classmethod
+    def get_content_str(cls) -> str:
+        """Get the conftest.py content.
+
+        Returns:
+            Python code that imports pyrig's conftest as a pytest plugin.
+        """
+        from pyrig.dev.tests import conftest  # noqa: PLC0415
+
+        return f'''"""Pytest configuration for tests.
+
+This module configures pytest plugins for the test suite, setting up the necessary
+fixtures and hooks for the different
+test scopes (function, class, module, package, session).
+It also import custom plugins from tests/base/scopes.
+This file should not be modified manually.
+"""
+
+pytest_plugins = ["{make_obj_importpath(conftest)}"]
+'''
+
+    @classmethod
+    def is_correct(cls) -> bool:
+        """Check if the conftest.py file is valid.
+
+        Allows modifications as long as the file contains the required import.
+
+        Returns:
+            True if the file has required structure.
+        """
+        from pyrig.dev.tests import conftest  # noqa: PLC0415
+
+        return super().is_correct() or (
+            f'pytest_plugins = ["{make_obj_importpath(conftest)}"]'
+            in cls.get_file_content()
+        )
+
+    @classmethod
+    def run_tests(cls, *, check: bool = True) -> None:
+        """Run the project's test suite using pytest.
+
+        Args:
+            check: Whether to raise on test failure.
+        """
+        run_subprocess([*PROJECT_MGT_RUN_ARGS, "pytest"], check=check)

pyrig/dev/configs/testing/fixtures_init.py

@@ -0,0 +1,27 @@
+"""Configuration for the fixture.py base fixture file.
+
+This module provides the FixtureConfigFile class for creating
+a fixture.py file where users can define custom test fixtures.
+"""
+
+from types import ModuleType
+
+from pyrig.dev.configs.base.base import InitConfigFile
+from pyrig.dev.tests import fixtures
+
+
+class FixturesInitConfigFile(InitConfigFile):
+    """Configuration file manager for fixture.py.
+
+    Creates a fixture.py file with only the docstring from pyrig's
+    fixture module, allowing users to add custom fixtures.
+    """
+
+    @classmethod
+    def get_src_module(cls) -> ModuleType:
+        """Get the source module to copy docstring from.
+
+        Returns:
+            The pyrig.dev.tests.fixtures.fixture module.
+        """
+        return fixtures

pyrig/dev/configs/testing/main_test.py

@@ -0,0 +1,74 @@
+"""Configuration for the test_main.py test file.
+
+This module provides the MainTestConfigFile class for creating
+a test file that verifies the CLI entry point works correctly.
+"""
+
+from pathlib import Path
+
+from pyrig import main
+from pyrig.dev.configs.base.base import PythonPackageConfigFile
+from pyrig.dev.configs.pyproject import PyprojectConfigFile
+from pyrig.src.modules.module import to_path
+from pyrig.src.testing.convention import make_test_obj_importpath_from_obj
+
+
+class MainTestConfigFile(PythonPackageConfigFile):
+    """Configuration file manager for test_main.py.
+
+    Creates a test file that verifies the CLI entry point
+    responds correctly to --help.
+    """
+
+    @classmethod
+    def get_parent_path(cls) -> Path:
+        """Get the test directory path.
+
+        Returns:
+            Path to the tests/pkg_name/src directory.
+        """
+        test_module_path = to_path(
+            make_test_obj_importpath_from_obj(main), is_package=False
+        ).parent
+        # replace pyrig with project name
+
+        package_name = PyprojectConfigFile.get_package_name()
+        test_module_path = Path(
+            test_module_path.as_posix().replace("pyrig", package_name, 1)
+        )
+        return Path(test_module_path)
+
+    @classmethod
+    def get_filename(cls) -> str:
+        """Get the test filename.
+
+        Returns:
+            The string "test_main".
+        """
+        return "test_main"
+
+    @classmethod
+    def get_content_str(cls) -> str:
+        """Get the test file content.
+
+        Returns:
+            Python code with a test that verifies CLI --help works.
+        """
+        return '''"""test module."""
+
+
+def test_main(main_test_fixture: None) -> None:
+    """Test func for main."""
+    assert main_test_fixture is None
+'''
+
+    @classmethod
+    def is_correct(cls) -> bool:
+        """Check if the test file is valid.
+
+        Allows modifications as long as test_main function exists.
+
+        Returns:
+            True if the file contains a test_main function.
+        """
+        return super().is_correct() or "def test_main" in cls.get_file_content()

pyrig/dev/configs/testing/zero_test.py

@@ -0,0 +1,43 @@
+"""Configuration for the test_zero.py placeholder test.
+
+This module provides the ZeroTestConfigFile class for creating
+a minimal test file that ensures pytest runs even when no other
+tests exist.
+"""
+
+from pyrig.dev.configs.base.base import PythonTestsConfigFile
+
+
+class ZeroTestConfigFile(PythonTestsConfigFile):
+    """Configuration file manager for test_zero.py.
+
+    Creates a placeholder test file that ensures pytest runs
+    successfully even when no other tests have been written.
+    """
+
+    @classmethod
+    def get_filename(cls) -> str:
+        """Get the test filename with reversed prefix.
+
+        Returns:
+            The string "test_zero" (reversed from "zero_test").
+        """
+        filename = super().get_filename()
+        return "_".join(reversed(filename.split("_")))
+
+    @classmethod
+    def get_content_str(cls) -> str:
+        """Get the placeholder test content.
+
+        Returns:
+            Python code with an empty test function.
+        """
+        return '''"""Contains an empty test."""
+
+
+def test_zero() -> None:
+    """Empty test.
+
+    Exists so that when no tests are written yet the base fixtures are executed.
+    """
+'''

pyrig/dev/configs/workflows/__init__.py

@@ -0,0 +1,5 @@
+"""GitHub Actions workflow configuration management.
+
+This package provides ConfigFile subclasses for creating and managing
+GitHub Actions workflow files for CI/CD automation.
+"""

pyrig/dev/configs/workflows/base/__init__.py

@@ -0,0 +1,5 @@
+"""Base workflow configuration utilities.
+
+This package provides the Workflow base class for creating
+GitHub Actions workflow configuration files.
+"""