Skip to content

Commit

Permalink
linting and python version fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@valkolovos
valkolovos committed Sep 17, 2024
1 parent ecce6cc commit 33e3b8d
Show file tree
Hide file tree
Showing 9 changed files with 758 additions and 665 deletions.
6 changes: 6 additions & 0 deletions examples/tests/v3/basic_flask_server.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,12 @@ def hello_world(test_id: int) -> Response:
for _ in range(randint(3, 5)) # noqa: S311
],
"arrayContainingMatches": [randint(1, 100), randint(1, 100)], # noqa: S311
"numbers": {
"intMatches": 42,
"floatMatches": 3.1415,
"intGeneratorMatches": randint(1, 100), # noqa: S311,
"decimalGeneratorMatches": round(uniform(10, 99), 2), # noqa: S311
},
"dateMatches": "1999-12-31",
"randomDateMatches": "1999-12-31",
"timeMatches": "12:34:56",
Expand Down
6 changes: 6 additions & 0 deletions examples/tests/v3/test_matchers.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,12 @@ def test_matchers() -> None:
matchers.integer(1),
matchers.integer(2),
]),
"numbers": {
"intMatches": matchers.number(42),
"floatMatches": matchers.number(3.1415),
"intGeneratorMatches": matchers.number(max_val=10),
"decimalGeneratorMatches": matchers.number(digits=4),
},
"dateMatches": matchers.date("yyyy-MM-dd", "2024-01-01"),
"randomDateMatches": matchers.date("yyyy-MM-dd"),
"timeMatches": matchers.time("HH:mm:ss", "12:34:56"),
Expand Down
242 changes: 19 additions & 223 deletions src/pact/v3/generators/__init__.py
View file
Original file line number Diff line number Diff line change
@@ -1,229 +1,25 @@
"""
Generator implementations for pact-python.
Generator module.
"""

from __future__ import annotations

from typing import Any, Literal, Optional, Union

type GeneratorTypeV3 = Literal[
"RandomInt",
"RandomDecimal",
"RandomHexadecimal",
"RandomString",
"Regex",
"Uuid",
"Date",
"Time",
"DateTime",
"RandomBoolean",
]

type GeneratorTypeV4 = Union[GeneratorTypeV3, Literal["ProviderState", "MockServerURL"]]

type GeneratorTypes = Union[GeneratorTypeV3, GeneratorTypeV4]


class Generator:
"""
Generator interface for exporting.
"""


class ConcreteGenerator(Generator):
"""
ConcreteGenerator class.
A generator is used to generate values for a field in a response.
"""

def __init__(
self,
generator_type: GeneratorTypeV4,
extra_args: Optional[dict[str, Any]] = None,
) -> None:
"""
Instantiate the generator class.
Args:
generator_type (GeneratorTypeV4):
The type of generator to use.
extra_args (dict[str, Any], optional):
Additional configuration elements to pass to the generator.
"""
self.type = generator_type
self.extra_args = extra_args if extra_args is not None else {}

def to_dict(self) -> str:
"""
Convert the generator to a dictionary for json serialization.
"""
data = {
"pact:generator:type": self.type,
}
data.update({k: v for k, v in self.extra_args.items() if v is not None})
return data


def random_int(
min_val: Optional[int] = None, max_val: Optional[int] = None
) -> Generator:
"""
Create a random integer generator.
Args:
min_val (Optional[int], optional):
The minimum value for the integer.
max_val (Optional[int], optional):
The maximum value for the integer.
"""
return ConcreteGenerator("RandomInt", {"min": min_val, "max": max_val})


def random_decimal(digits: Optional[int] = None) -> Generator:
"""
Create a random decimal generator.
Args:
digits (Optional[int], optional):
The number of digits to generate.
"""
return ConcreteGenerator("RandomDecimal", {"digits": digits})


def random_hexadecimal(digits: Optional[int] = None) -> Generator:
"""
Create a random hexadecimal generator.
Args:
digits (Optional[int], optional):
The number of digits to generate.
"""
return ConcreteGenerator("RandomHexadecimal", {"digits": digits})


def random_string(size: Optional[int] = None) -> Generator:
"""
Create a random string generator.
Args:
size (Optional[int], optional):
The size of the string to generate.
"""
return ConcreteGenerator("RandomString", {"size": size})


def regex(regex: str) -> Generator:
"""
Create a regex generator.
This will generate a string that matches the given regex.
Args:
regex (str):
The regex pattern to match.
"""
return ConcreteGenerator("Regex", {"regex": regex})


def uuid(
format_str: Optional[
Literal["simple", "lower-case-hyphenated", "upper-case-hyphenated", "URN"]
] = None,
) -> Generator:
"""
Create a UUID generator.
Args:
format_str (Optional[Literal[]], optional):
The format of the UUID to generate. This parameter is only supported
under the V4 specification.
"""
return ConcreteGenerator("Uuid", {"format": format_str})


def date(format_str: str) -> Generator:
"""
Create a date generator.
This will generate a date string that matches the given format. See
[Java SimpleDateFormat](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html)
for more information on the format string.
Args:
format_str (str):
The format string to use for the date.
"""
return ConcreteGenerator("Date", {"format": format_str})


def time(format_str: str) -> Generator:
"""
Create a time generator.
This will generate a time string that matches the given format. See
[Java SimpleDateFormat](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html)
for more information on the format string.
Args:
format_str (str):
The format string to use for the time.
"""
return ConcreteGenerator("Time", {"format": format_str})


def date_time(format_str: str) -> Generator:
"""
Create a date-time generator.
This will generate a date-time string that matches the given format. See
[Java SimpleDateFormat](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html)
for more information on the format string.
Args:
format_str (str):
The format string to use for the date-time.
"""
return ConcreteGenerator("DateTime", {"format": format_str})


def random_boolean() -> Generator:
"""
Create a random boolean generator.
"""
return ConcreteGenerator("RandomBoolean")


def provider_state(expression: Optional[str] = None) -> Generator:
"""
Create a provider state generator.
Generates a value that is looked up from the provider state context
using the given expression.
Args:
expression (Optional[str], optional):
The expression to use to look up the provider state.
"""
return ConcreteGenerator("ProviderState", {"expression": expression})


def mock_server_url(
regex: Optional[str] = None, example: Optional[str] = None
) -> Generator:
"""
Create a mock server URL generator.
Generates a URL with the mock server as the base URL.
Args:
regex (Optional[str], optional):
The regex pattern to match.
example (Optional[str], optional):
An example URL to use.
"""
return ConcreteGenerator("MockServerURL", {"regex": regex, "example": example})

from pact.v3.generators.generators import (
Generator,
GeneratorTypes,
GeneratorTypeV3,
GeneratorTypeV4,
date,
date_time,
mock_server_url,
provider_state,
random_boolean,
random_decimal,
random_hexadecimal,
random_int,
random_string,
regex,
time,
uuid,
)

__all__ = [
"Generator",
Expand Down
Loading

0 comments on commit 33e3b8d

Please sign in to comment.