Skip to content

fixtures/__init__.py Configuration

The FixturesInitConfigFile manages the {package_name}/dev/tests/fixtures/__init__.py file.

Overview

Creates a fixtures package that:

  • Mirrors the structure of pyrig.dev.tests.fixtures
  • Copies only the docstring from the source module
  • Ensures the fixtures directory exists with proper package structure
  • Provides a place for custom test fixtures

Inheritance

graph TD A[ConfigFile] --> B[ListConfigFile] B --> C[StringConfigFile] C --> D[PythonConfigFile] D --> E[PythonPackageConfigFile] E --> F[CopyModuleConfigFile] F --> G[CopyModuleOnlyDocstringConfigFile] G --> H[InitConfigFile] H --> I[FixturesInitConfigFile] style A fill:#a8dadc,stroke:#333,stroke-width:2px,color:#000 style B fill:#457b9d,stroke:#333,stroke-width:2px,color:#fff style C fill:#f4a261,stroke:#333,stroke-width:2px,color:#000 style D fill:#e76f51,stroke:#333,stroke-width:2px,color:#000 style E fill:#9d84b7,stroke:#333,stroke-width:2px,color:#000 style F fill:#90be6d,stroke:#333,stroke-width:2px,color:#000 style G fill:#a8dadc,stroke:#333,stroke-width:2px,color:#000 style H fill:#f4a261,stroke:#333,stroke-width:2px,color:#000 style I fill:#e76f51,stroke:#333,stroke-width:2px,color:#000

Inherits from: InitConfigFile

What this means:

  • Creates __init__.py files for package initialization
  • Copies only the docstring from pyrig.dev.tests.fixtures
  • Automatically determines target path
  • Ensures parent directory is a valid Python package

File Location

Path: {package_name}/dev/tests/fixtures/__init__.py

Source module: pyrig.dev.tests.fixtures

Path transformation: pyrig.dev.tests.fixtures → {package_name}.dev.tests.fixtures → {package_name}/dev/tests/fixtures/__init__.py

How It Works

Automatic Generation

When initialized via uv run pyrig mkroot, the file is created with:

  1. Docstring copy: Only the docstring from pyrig.dev.tests.fixtures.__init__.py is copied
  2. Package structure: The dev/tests/fixtures/ directory is created
  3. Package initialization: Parent directories get __init__.py files

Generated Content

The file contains only the docstring, allowing you to add custom fixture modules.

Usage

Automatic Creation

uv run pyrig mkroot

Purpose

This package is where you can add custom test fixtures for your project. Fixtures defined here are automatically discovered and available to all tests.

See the Fixtures documentation for details on creating custom fixtures.

Best Practices

  1. Don't modify the docstring: Keep the copied docstring intact
  2. Add fixture modules: Create fixture files in this directory
  3. Use pytest decorators: Decorate fixtures with @pytest.fixture or pyrig's scope decorators
  4. Follow naming conventions: Use descriptive names for fixture modules