[project]
authors = [{ name = "Na'aman Hirschfeld", email = "nhirschfeld@gmail.com" }]
maintainers = [
  { name = "Visakh Unnikrishnan", email = "guacs@litestar.dev" },
  { name = "Cody Fincher", email = "cody@litestar.dev" },
  { name = "Janek Nouvertné", email = "janek@litestar.dev" },
  { name = "Jacob Coffee", email = "jacob@litestar.dev" },
  { name = "Peter Schutt", email = "peter@litestar.dev" },
  { name = "Alc", email = "alc@litestar.dev" },
  { name = 'Andy', email = 'adh.truong@gmail.com' },
]
keywords = ["dataclasses", "msgspec", "pydantic", "attrs", "sqlalchemy"]
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Environment :: Web Environment",
  "Framework :: Pytest",
  "Intended Audience :: Developers",
  "License :: OSI Approved :: MIT License",
  "Natural Language :: English",
  "Operating System :: OS Independent",
  "Programming Language :: Python :: 3.8",
  "Programming Language :: Python :: 3.9",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python",
  "Topic :: Software Development :: Libraries",
  "Topic :: Software Development :: Testing :: Unit",
  "Topic :: Software Development :: Testing",
  "Topic :: Software Development",
  "Topic :: Utilities",
  "Typing :: Typed",
]
name = "polyfactory"
version = "2.22.2"
description = "Mock data generation factories"
readme = "docs/PYPI_README.md"
license = { text = "MIT" }
requires-python = ">=3.8,<4.0"
dependencies = ["faker>=5.0.0", "typing-extensions>=4.6.0"]

[project.optional-dependencies]
sqlalchemy = ["sqlalchemy>=1.4.29"]
pydantic = ["pydantic[email]>=1.10"]
msgspec = ["msgspec"]
odmantic = ["odmantic<1.0.0", "pydantic[email]"]
beanie = ["beanie", "pydantic[email]", "pymongo<4.9"]
attrs = ["attrs>=22.2.0"]
full = ["pydantic", "odmantic", "msgspec", "beanie", "attrs", "sqlalchemy"]

[project.urls]
"Issue Tracker" = "https://github.com/litestar-org/polyfactory/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc"
Changelog = "https://github.com/litestar-org/polyfactory/releases/"
Twitter = "https://twitter.com/LitestarAPI"
Reddit = "https://www.reddit.com/r/LitestarAPI"
Discord = "https://discord.gg/MmcwxztmQb"
Blog = "https://blog.litestar.dev"
homepage = "https://github.com/litestar-org/polyfactory"
repository = "https://github.com/litestar-org/polyfactory"
documentation = "https://github.com/litestar-org/polyfactory"

[build-system]
build-backend = "hatchling.build"
requires = ["hatchling"]

[tool.uv]
default-groups = ["dev", "lint", "test", "docs"]

[tool.uv.sources]
polyfactory = { workspace = true }

[dependency-groups]
docs = [
  "sphinx>=7.1.2",
  "sphinx-autobuild>=2021.3.14",
  "auto-pytabs>=0.4.0",
  "sphinx-copybutton>=0.5.2",
  "sphinx-toolbox>=3.5.0",
  "sphinx-design>=0.5.0",
  "sphinxcontrib-mermaid>=0.9.2",
  "sphinx-paramlinks>=0.6.0",
  "sphinx-togglebutton>=0.3.2",
  #    "litestar-sphinx-theme @ {root:uri}/../litestar-sphinx-theme", # only needed when working on the theme
  "litestar-sphinx-theme @ git+https://github.com/litestar-org/litestar-sphinx-theme.git@v3",
  "git-cliff>=2.2.1",
]
lint = [
  "ruff>=0.0.290",
  "codespell>=2.2.5",
  "mypy>=1.5.1",
  "pre-commit>=3.4.0",
  "shellcheck-py>=0.9.0.5",
  "pyright>=1.1.327",
  "sourcery>=1.9.0",
]
test = [
  "pytest>=7.4.2",
  "pytest-asyncio>=0.21.1",
  "pytest-cov>=4.1.0",
  "hypothesis>=6.86.2",
  "annotated-types>=0.5.0",
]
dev = [
  "polyfactory[full]",
  "mongomock-motor>=0.0.21",
  "aiosqlite>=0.19.0",
  "sqlalchemy[asyncio]>=1.4.29",
]
pydantic = ["pydantic[email]>=2.10.4"]

[tool.bumpversion]
allow_dirty = true
commit = true
commit_args = "--no-verify"
current_version = "2.22.2"
ignore_missing_files = false
ignore_missing_version = false
message = "chore(release): bump to v{new_version}"
parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
regex = false
replace = "{new_version}"
search = "{current_version}"
serialize = ["{major}.{minor}.{patch}"]
sign_tags = false
tag = false
tag_message = "chore(release): v{new_version}"
tag_name = "v{new_version}"
pre_commit_hooks = ["uv sync", "git add uv.lock docs/changelog.rst"]

[tool.mypy]
exclude = "^tools/.*"
plugins = ["pydantic.mypy"]

warn_unused_ignores = true
warn_redundant_casts = true
warn_unused_configs = true
warn_unreachable = true
warn_return_any = true
strict = true
disallow_untyped_decorators = true
disallow_any_generics = false
implicit_reexport = false
show_error_codes = true

[tool.pydantic-mypy]
init_forbid_extra = true
init_typed = true
warn_required_dynamic_aliases = true
warn_untyped_fields = true

[tool.mypy-tests.typing_test_strict]
disallow_any_generics = true

[tool.pyright]
include = ["polyfactory", "tests", "examples"]
exclude = ["tools/**/*.*"]

[tool.coverage.run]
omit = ["*/tests/*"]

[tool.pytest.ini_options]
addopts = "--strict-config --strict-markers"
asyncio_mode = "auto"
filterwarnings = [
  "ignore:.*pkg_resources.declare_namespace\\('sphinxcontrib'\\).*:DeprecationWarning",
  "ignore:pkg_resources is deprecated as an API:DeprecationWarning",
  # Get rid those above once sphinxcontrib-mermaid doesn't use pkg_resources anymore
  # https://github.com/mgaitan/sphinxcontrib-mermaid/issues/119
]
markers = [
  # Marks tests that use `attrs` library
  "attrs",
]
asyncio_default_fixture_loop_scope = "function"

[tool.coverage.report]
exclude_lines = [
  'pragma: no cover',
  'if TYPE_CHECKING:',
  'except ImportError:',
  'except ImportError as e:',
  '\.\.\.',
]

[tool.ruff]
line-length = 120
src = ["polyfactory", "tests", "docs/examples"]
target-version = "py38"

[tool.ruff.format]
docstring-code-format = true
docstring-code-line-length = 88

[tool.ruff.lint]
select = ["ALL"]
ignore = [
  "A003",   # flake8-builtins - class attribute {name} is shadowing a python builtin
  "B010",   # flake8-bugbear - do not call setattr with a constant attribute value
  "D100",   # pydocstyle - missing docstring in public module
  "D101",   # pydocstyle - missing docstring in public class
  "D102",   # pydocstyle - missing docstring in public method
  "D103",   # pydocstyle - missing docstring in public function
  "D104",   # pydocstyle - missing docstring in public package
  "D105",   # pydocstyle - missing docstring in magic method
  "D106",   # pydocstyle - missing docstring in public nested class
  "D107",   # pydocstyle - missing docstring in __init__
  "D202",   # pydocstyle - no blank lines allowed after function docstring
  "D205",   # pydocstyle - 1 blank line required between summary line and description
  "D415",   # pydocstyle - first line should end with a period, question mark, or exclamation point
  "E501",   # pycodestyle line too long, handled by black
  "N818",   # pep8-naming - exception name should be named with an Error suffix
  "S311",   # flake8-bandit - Standard pseudo-random generators are not suitable for security/cryptographic purposes
  "UP037",  # pyupgrade - removes quotes from type annotation
  "COM812", # conflict with formatter
  "ISC001", # conflict with formatter
]

[tool.ruff.lint.flake8-builtins]
builtins-allowed-modules = ["types"]

[tool.ruff.lint.pydocstyle]
convention = "google"

[tool.ruff.lint.pep8-naming]
classmethod-decorators = [
  "classmethod",
  "pydantic.validator",
  "pydantic.root_validator",
  "sqlalchemy.ext.declarative.declared_attr",
]

[tool.ruff.lint.isort]
known-first-party = ["polyfactory", "tests"]
section-order = [
  "future",
  "standard-library",
  "third-party",
  "pydantic",
  "pydantic_v1",
  "first-party",
  "local-folder",
]

[tool.ruff.lint.isort.sections]
pydantic = ["pydantic", "pydantic_core"]
pydantic_v1 = ["pydantic.v1"]

[tool.ruff.lint.per-file-ignores]
"**/*.*" = ["ANN401", "TD"]
"polyfactory/**/*.*" = [
  "PLR0913",
  "ARG005",  # Investigate @guacs
  "FBT001",  # Investigate @guacs
  "FBT002",  # Investigate @guacs
  "SLF001",  # Ignore use of private member access
]
"polyfactory/field_meta.py" = ["N806"]
"tests/**/*.*" = [
  "S101",
  "D",
  "ARG",
  "PGH",
  "B",
  "FBT",
  "PTH",
  "A",
  "TC",
  "DTZ",
  "TRY",
  "EM",
  "S",
  "N",
  "SIM",
  "PLR",
  "BLE",
  "RSE",
  "C901",
  "PLW",
  "G",
  "PIE",
  "RUF012",
  "FA",
  "ANN",
  "SLF",
  "PT",
  "INP",
  "TD",
  "FIX",
  "FBT",
  "PLR0913", # too many arguments
  "PT",
  "ARG002",  # Investigate @guacs
  "PERF203", # Investigate @guacs
]
"docs/examples/**/*.*" = [
  "PLR2004", # Investigate @guacs
  "INP001",  # Add __init__.py
]
"docs/examples/tests/**/*.*" = [
  "S101",
  "D",
  "ARG",
  "PGH",
  "B",
  "FBT",
  "PTH",
  "A",
  "TC",
  "DTZ",
  "TRY",
  "EM",
  "S",
  "N",
  "SIM",
  "PLR",
  "BLE",
  "RSE",
  "C901",
  "PLW",
  "G",
  "PIE",
]
"docs/**/*.*" = [
  "S",
  "B",
  "DTZ",
  "A",
  "TC",
  "ERA",
  "D",
  "RET",
  "E731",
  "RUF012",
  "FA100",
  "ARG001",
]
"docs/conf.py" = ["FIX002", "ARG001"]
"tools/**/*.*" = ["D", "ARG", "EM", "TRY", "G", "FBT", "INP"]

[tool.git-cliff.changelog]
trim = true
header = """
=========
Changelog
=========\n
All commits to this project will be documented in this file.\n
"""
# TODO: Fix footers for co-authors
body = """
{% if version %}\
    `Release [v{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} <https://github.com/litestar-org/polyfactory/releases/tag/v{{ version | trim_start_matches(pat="v") }}>`_
    ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
    * `See All commits in v{{ version | trim_start_matches(pat="v") }} <https://github.com/litestar-org/polyfactory/commits/v{{ version | trim_start_matches(pat="v") }}>`_
{% else %}\
    [unreleased]
    ------------
    {% if previous %}\
        {% if previous.commit_id %}
            `{{ previous.commit_id | default(value='') | truncate(length=7, end='') }} <https://github.com/litestar-org/polyfactory/commit/{{ previous.commit_id }}>`_ is the last commit in the changelog before unreleased changes.
        {% endif %}\
    {% else %}
        `Initial commit`
    {% endif %}
{% endif %}\
{% if previous %}\
    {% if previous.commit_id and version %}
        `{{ previous.commit_id | default(value='') | truncate(length=7, end='') }} <https://github.com/litestar-org/polyfactory/commit/{{ previous.commit_id }}>`_ ... \
            `{{ commit_id | default(value='') | truncate(length=7, end='') }} <https://github.com/litestar-org/polyfactory/commit/{{ commit_id }}>`_ \
            | `See diff for {{ version | trim_start_matches(pat="v") }} <https://github.com/litestar-org/polyfactory/compare/{{ previous.commit_id }}...{{ commit_id }}>`_
    {% endif %}\
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
    {{ group | upper_first }}
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    {% for commit in commits %}
        * (`{{ commit.id | default(value='') | truncate(length=7, end='') }} <https://github.com/litestar-org/polyfactory/commit/{{ commit.id }}>`_) {% if commit.breaking %}[**breaking**] {% endif %} - {{ commit.message | upper_first }} {% if commit.github.username %} by `@{{ commit.github.username }} <https://github.com/{{ commit.github.username }}>`_ {%- endif %}\
          {% if commit.github.pr_number %} in `#{{ commit.github.pr_number }} <https://github.com/litestar-org/polyfactory/pull/{{ commit.github.pr_number }}>`_ {%- endif %}\
    {% endfor %}
{% endfor %}\n
"""
footer = """
Polyfactory Changelog
"""

[tool.git-cliff.git]
commit_parsers = [
  { message = "^feat", group = "Features" },
  { message = "^fix", group = "Bug Fixes" },
  { message = "^doc", group = "Documentation" },
  { message = "^perf", group = "Performance" },
  { message = "^refactor", group = "Refactor" },
  { message = "^style", group = "Styling" },
  { message = "^test", group = "Testing" },
  { message = "^chore\\(release\\): prepare for", skip = true },
  { message = "^chore", group = "Miscellaneous Tasks" },
  { body = ".*security", group = "Security" },
]
conventional_commits = true
filter_commits = false
filter_unconventional = true
ignore_tags = ""
protect_breaking_commits = false
skip_tags = "v0.1.0-beta.1"
sort_commits = "oldest"
split_commits = false
tag_pattern = "v[0-9]*"
topo_order = false
commit_preprocessors = [
  # Matches a single backtick that is not preceded by another backtick (negative lookbehind)
  # and not followed by another backtick (negative lookahead).. but these aren't supported
  # in git cliff regexes. So we have to do it in 3 steps:
  # Step 1: Replace pairs of backticks with a placeholder (e.g., "DOUBLEBACKTICK")
  { pattern = "``", replace = "DOUBLEBACKTICK" },
  # Step 2: Replace single backticks with double backticks
  { pattern = "`", replace = "``" },
  # Step 3: Replace the placeholder back to double backticks
  { pattern = "DOUBLEBACKTICK", replace = "``" },
  # TODO: Fix Co-authored commits
]
link_parsers = [
  # TODO: Supposedly matches on #1234 but doesn't work?
  { pattern = "\\(#(\\d+)\\)", href = "https://github.com/litestar-org/polyfactory/issues/$1" },
]

[tool.git-cliff.remote.github]
owner = "litestar-org"
repo = "polyfactory"