Skip to content

Generator

Implementations of generators for the V3 and V4 specifications.

Attributes

Classes

Generator

Bases: ABC

Abstract generator.

In Pact, a generator is used by Pact to generate data on-the-fly during the contract verification process. Generators are used in combination with matchers to provide more flexible matching of data.

This class is abstract and should not be used directly. Instead, use one of the concrete generator classes. Alternatively, you can create your own generator by subclassing this class

The matcher provides methods to convert into an integration JSON object and a matching rule. These methods are used internally by the Pact library when communicating with the FFI and generating the Pact file.

Functions

to_generator_json() -> dict[str, Any] abstractmethod

Convert the generator to a generator JSON object.

This method is used internally to convert the generator to a JSON object which can be embedded directly in a number of places in the Pact FFI.

For more information about this format, see the docs:

https://github.com/pact-foundation/pact-specification/tree/version-4

and

https://github.com/pact-foundation/pact-specification/tree/version-2?tab=readme-ov-file#matchers

RETURNS DESCRIPTION
dict[str, Any]

The generator as a generator JSON object.
Source code in src/pact/v3/generate/generator.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
@abstractmethod
def to_generator_json(self) -> dict[str, Any]:
    """
    Convert the generator to a generator JSON object.

    This method is used internally to convert the generator to a JSON object
    which can be embedded directly in a number of places in the Pact FFI.

    For more information about this format, see the docs:

    > https://github.com/pact-foundation/pact-specification/tree/version-4

    and

    > https://github.com/pact-foundation/pact-specification/tree/version-2?tab=readme-ov-file#matchers

    Returns:
        The generator as a generator JSON object.
    """
to_integration_json() -> dict[str, Any] abstractmethod

Convert the matcher to an integration JSON object.

This method is used internally to convert the matcher to a JSON object which can be embedded directly in a number of places in the Pact FFI.

For more information about this format, see the docs:

https://docs.pact.io/implementation_guides/rust/pact_ffi/integrationjson

RETURNS DESCRIPTION
dict[str, Any]

The matcher as an integration JSON object.
Source code in src/pact/v3/generate/generator.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
@abstractmethod
def to_integration_json(self) -> dict[str, Any]:
    """
    Convert the matcher to an integration JSON object.

    This method is used internally to convert the matcher to a JSON object
    which can be embedded directly in a number of places in the Pact FFI.

    For more information about this format, see the docs:

    > https://docs.pact.io/implementation_guides/rust/pact_ffi/integrationjson

    Returns:
        The matcher as an integration JSON object.
    """

GenericGenerator(type: GeneratorType, /, extra_fields: Mapping[str, Any] | None = None, **kwargs: Any)

Bases: Generator

Generic generator.

A generic generator, with the ability to specify the generator type and additional configuration elements.

PARAMETER DESCRIPTION
type

The type of the generator.

TYPE: GeneratorType

extra_fields

Additional configuration elements to pass to the generator. These fields will be used when converting the generator to both an integration JSON object and a generator JSON object.

TYPE: Mapping[str, Any] | None DEFAULT: None

**kwargs

Alternative way to pass additional configuration elements to the generator. See the extra_fields argument for more information.

TYPE: Any DEFAULT: {}

Source code in src/pact/v3/generate/generator.py 
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
def __init__(
    self,
    type: GeneratorType,  # noqa: A002
    /,
    extra_fields: Mapping[str, Any] | None = None,
    **kwargs: Any,  # noqa: ANN401
) -> None:
    """
    Instantiate the generator class.

    Args:
        type:
            The type of the generator.

        extra_fields:
            Additional configuration elements to pass to the generator.
            These fields will be used when converting the generator to both an
            integration JSON object and a generator JSON object.

        **kwargs:
            Alternative way to pass additional configuration elements to the
            generator. See the `extra_fields` argument for more information.
    """
    self.type = type
    """
    The type of the generator.
    """

    self._extra_fields = dict(chain((extra_fields or {}).items(), kwargs.items()))

Attributes

type = type instance-attribute

The type of the generator.

Functions

to_generator_json() -> dict[str, Any]

Convert the generator to a generator JSON object.

This method is used internally to convert the generator to a JSON object which can be embedded directly in a number of places in the Pact FFI.

For more information about this format, see the docs:

https://github.com/pact-foundation/pact-specification/tree/version-4

and

https://github.com/pact-foundation/pact-specification/tree/version-2?tab=readme-ov-file#matchers

RETURNS DESCRIPTION
dict[str, Any]

The generator as a generator JSON object.
Source code in src/pact/v3/generate/generator.py 
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
def to_generator_json(self) -> dict[str, Any]:
    """
    Convert the generator to a generator JSON object.

    This method is used internally to convert the generator to a JSON object
    which can be embedded directly in a number of places in the Pact FFI.

    For more information about this format, see the docs:

    > https://github.com/pact-foundation/pact-specification/tree/version-4

    and

    > https://github.com/pact-foundation/pact-specification/tree/version-2?tab=readme-ov-file#matchers

    Returns:
        The generator as a generator JSON object.
    """
    return {
        "type": self.type,
        **self._extra_fields,
    }
to_integration_json() -> dict[str, Any]

Convert the matcher to an integration JSON object.

This method is used internally to convert the matcher to a JSON object which can be embedded directly in a number of places in the Pact FFI.

For more information about this format, see the docs:

https://docs.pact.io/implementation_guides/rust/pact_ffi/integrationjson

RETURNS DESCRIPTION
dict[str, Any]

The matcher as an integration JSON object.
Source code in src/pact/v3/generate/generator.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
def to_integration_json(self) -> dict[str, Any]:
    """
    Convert the matcher to an integration JSON object.

    This method is used internally to convert the matcher to a JSON object
    which can be embedded directly in a number of places in the Pact FFI.

    For more information about this format, see the docs:

    > https://docs.pact.io/implementation_guides/rust/pact_ffi/integrationjson

    Returns:
        The matcher as an integration JSON object.
    """
    return {
        "pact:generator:type": self.type,
        **self._extra_fields,
    }