pax_global_header 0000666 0000000 0000000 00000000064 15000423051 0014500 g ustar 00root root 0000000 0000000 52 comment=203310bfa4a8054efb59c1bda34715d4196a7954
python-polyfactory-2.21.0/ 0000775 0000000 0000000 00000000000 15000423051 0015454 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/.all-contributorsrc 0000664 0000000 0000000 00000027267 15000423051 0021323 0 ustar 00root root 0000000 0000000 {
"files": [
"README.md"
],
"imageSize": 100,
"commit": false,
"commitConvention": "angular",
"contributors": [
{
"login": "Goldziher",
"name": "Na'aman Hirschfeld",
"avatar_url": "https://avatars.githubusercontent.com/u/30733348?v=4",
"profile": "https://github.com/Goldziher",
"contributions": [
"maintenance",
"infra",
"test",
"code",
"doc"
]
},
{
"login": "JacobCoffee",
"name": "Jacob Coffee",
"avatar_url": "https://avatars.githubusercontent.com/u/45884264?v=4",
"profile": "https://scriptr.dev/",
"contributions": [
"maintenance",
"doc",
"test"
]
},
{
"login": "provinzkraut",
"name": "Janek Nouvertné",
"avatar_url": "https://avatars.githubusercontent.com/u/25355197?v=4",
"profile": "https://github.com/provinzkraut",
"contributions": [
"maintenance",
"doc",
"test",
"code"
]
},
{
"login": "peterschutt",
"name": "Peter Schutt",
"avatar_url": "https://avatars.githubusercontent.com/u/20659309?v=4",
"profile": "https://schutt.io",
"contributions": [
"maintenance",
"test",
"code",
"doc"
]
},
{
"login": "mdczaplicki",
"name": "Marek Czaplicki",
"avatar_url": "https://avatars.githubusercontent.com/u/9108586?v=4",
"profile": "https://czaplicki.it/",
"contributions": [
"code",
"test"
]
},
{
"login": "przybylop",
"name": "Piotr Przybyło",
"avatar_url": "https://avatars.githubusercontent.com/u/82805821?v=4",
"profile": "https://github.com/przybylop",
"contributions": [
"code"
]
},
{
"login": "sygutss",
"name": "sygutss",
"avatar_url": "https://avatars.githubusercontent.com/u/48909366?v=4",
"profile": "https://github.com/sygutss",
"contributions": [
"bug",
"code"
]
},
{
"login": "chrisbeardy",
"name": "chrisbeardy",
"avatar_url": "https://avatars.githubusercontent.com/u/20585410?v=4",
"profile": "https://github.com/chrisbeardy",
"contributions": [
"doc"
]
},
{
"login": "guacs",
"name": "guacs",
"avatar_url": "https://avatars.githubusercontent.com/u/126393040?v=4",
"profile": "https://github.com/guacs",
"contributions": [
"code",
"infra",
"doc",
"test",
"maintenance"
]
},
{
"login": "VSHUMILIN97",
"name": "Vadim",
"avatar_url": "https://avatars.githubusercontent.com/u/27234763?v=4",
"profile": "https://github.com/VSHUMILIN97",
"contributions": [
"code"
]
},
{
"login": "Simske",
"name": "Simske",
"avatar_url": "https://avatars.githubusercontent.com/u/2445660?v=4",
"profile": "https://github.com/Simske",
"contributions": [
"code"
]
},
{
"login": "sondrelg",
"name": "Sondre Lillebø Gundersen",
"avatar_url": "https://avatars.githubusercontent.com/u/25310870?v=4",
"profile": "https://github.com/sondrelg",
"contributions": [
"code"
]
},
{
"login": "mciszczon",
"name": "Mateusz Ciszczoń",
"avatar_url": "https://avatars.githubusercontent.com/u/1078369?v=4",
"profile": "https://mciszczon.pl/",
"contributions": [
"code"
]
},
{
"login": "phbernardes",
"name": "Pedro Bernardes",
"avatar_url": "https://avatars.githubusercontent.com/u/18899993?v=4",
"profile": "https://www.linkedin.com/in/pedro-bernardes/",
"contributions": [
"code"
]
},
{
"login": "lindycoder",
"name": "Martin Roy",
"avatar_url": "https://avatars.githubusercontent.com/u/12926519?v=4",
"profile": "https://github.com/lindycoder",
"contributions": [
"code"
]
},
{
"login": "Butch78",
"name": "Matthew Aylward ",
"avatar_url": "https://avatars.githubusercontent.com/u/19205392?v=4",
"profile": "http://matthewtyleraylward.com",
"contributions": [
"code"
]
},
{
"login": "EltonChou",
"name": "Elton H.Y. Chou",
"avatar_url": "https://avatars.githubusercontent.com/u/12560310?v=4",
"profile": "https://github.com/EltonChou",
"contributions": [
"code"
]
},
{
"login": "nguyent",
"name": "Thang",
"avatar_url": "https://avatars.githubusercontent.com/u/576848?v=4",
"profile": "https://github.com/nguyent",
"contributions": [
"code"
]
},
{
"login": "DaanRademaker",
"name": "Daan",
"avatar_url": "https://avatars.githubusercontent.com/u/29598493?v=4",
"profile": "https://github.com/DaanRademaker",
"contributions": [
"code"
]
},
{
"login": "lyz-code",
"name": "Lyz",
"avatar_url": "https://avatars.githubusercontent.com/u/24810987?v=4",
"profile": "https://lyz-code.github.io/blue-book/",
"contributions": [
"code"
]
},
{
"login": "thorin-schiffer",
"name": "Thorin Schiffer",
"avatar_url": "https://avatars.githubusercontent.com/u/3502492?v=4",
"profile": "https://portfolio.schiffer.pro/",
"contributions": [
"code"
]
},
{
"login": "Iipin",
"name": "Iipin",
"avatar_url": "https://avatars.githubusercontent.com/u/52832022?v=4",
"profile": "https://github.com/Iipin",
"contributions": [
"code"
]
},
{
"login": "avihai-yosef",
"name": "avihai-yosef",
"avatar_url": "https://avatars.githubusercontent.com/u/79567307?v=4",
"profile": "https://github.com/avihai-yosef",
"contributions": [
"code"
]
},
{
"login": "anthonyh209",
"name": "anthonyh209",
"avatar_url": "https://avatars.githubusercontent.com/u/33107540?v=4",
"profile": "https://github.com/anthonyh209",
"contributions": [
"code"
]
},
{
"login": "ReznikovRoman",
"name": "Roman Reznikov",
"avatar_url": "https://avatars.githubusercontent.com/u/44291988?v=4",
"profile": "http://linkedin.com/in/roman-reznikov",
"contributions": [
"code"
]
},
{
"login": "gigelu",
"name": "gigelu",
"avatar_url": "https://avatars.githubusercontent.com/u/270697?v=4",
"profile": "https://github.com/gigelu",
"contributions": [
"code"
]
},
{
"login": "roeeyn",
"name": "Rodrigo Medina",
"avatar_url": "https://avatars.githubusercontent.com/u/13385000?v=4",
"profile": "https://github.com/roeeyn",
"contributions": [
"code"
]
},
{
"login": "gegnew",
"name": "Gerrit Egnew",
"avatar_url": "https://avatars.githubusercontent.com/u/35822787?v=4",
"profile": "https://gerritegnew.info/",
"contributions": [
"code"
]
},
{
"login": "danielkatzan",
"name": "danielkatzan",
"avatar_url": "https://avatars.githubusercontent.com/u/9249066?v=4",
"profile": "https://github.com/danielkatzan",
"contributions": [
"doc"
]
},
{
"login": "abdulhaq-e",
"name": "Abdulhaq Emhemmed",
"avatar_url": "https://avatars.githubusercontent.com/u/2532125?v=4",
"profile": "https://github.com/abdulhaq-e",
"contributions": [
"code"
]
},
{
"login": "klimantje",
"name": "klimantje",
"avatar_url": "https://avatars.githubusercontent.com/u/20017047?v=4",
"profile": "https://github.com/klimantje",
"contributions": [
"code"
]
},
{
"login": "tcrasset",
"name": "Tom Crasset",
"avatar_url": "https://avatars.githubusercontent.com/u/25140344?v=4",
"profile": "https://github.com/tcrasset",
"contributions": [
"code"
]
},
{
"login": "185504a9",
"name": "cătălin",
"avatar_url": "https://avatars.githubusercontent.com/u/45485069?v=4",
"profile": "https://git.roboces.dev/catalin",
"contributions": [
"code"
]
},
{
"login": "adhtruong",
"name": "Andrew Truong",
"avatar_url": "https://avatars.githubusercontent.com/u/40660973?v=4",
"profile": "https://github.com/adhtruong",
"contributions": [
"code",
"doc"
]
},
{
"login": "anthonyjgraff",
"name": "Anthony",
"avatar_url": "https://avatars.githubusercontent.com/u/59455370?v=4",
"profile": "https://github.com/anthonyjgraff",
"contributions": [
"code",
"doc",
"test"
]
},
{
"login": "johnraz",
"name": "Jonathan Liuti",
"avatar_url": "https://avatars.githubusercontent.com/u/304164?v=4",
"profile": "https://github.com/johnraz",
"contributions": [
"code",
"doc",
"test"
]
},
{
"login": "julioolvr",
"name": "Julio Olivera",
"avatar_url": "https://avatars.githubusercontent.com/u/1302493?v=4",
"profile": "https://julio.li/",
"contributions": [
"code",
"test"
]
},
{
"login": "g0di",
"name": "Benoît Godard",
"avatar_url": "https://avatars.githubusercontent.com/u/2545380?v=4",
"profile": "https://github.com/g0di",
"contributions": [
"code",
"doc",
"test"
]
},
{
"login": "hsorsky",
"name": "Henry Sorsky",
"avatar_url": "https://avatars.githubusercontent.com/u/36887638?v=4",
"profile": "https://github.com/hsorsky",
"contributions": [
"infra"
]
},
{
"login": "wer153",
"name": "Kim Minki",
"avatar_url": "https://avatars.githubusercontent.com/u/23370765?v=4",
"profile": "https://github.com/wer153",
"contributions": [
"doc"
]
},
{
"login": "TimDumol",
"name": "Tim Joseph Dumol",
"avatar_url": "https://avatars.githubusercontent.com/u/49169?v=4",
"profile": "https://www.timdumol.com/",
"contributions": [
"doc"
]
},
{
"login": "wangxin688",
"name": "jeffry",
"avatar_url": "https://avatars.githubusercontent.com/u/36665036?v=4",
"profile": "https://github.com/wangxin688",
"contributions": [
"code"
]
},
{
"login": "Reskov",
"name": "Sergey Kovalev",
"avatar_url": "https://avatars.githubusercontent.com/u/4832451?v=4",
"profile": "https://github.com/Reskov",
"contributions": [
"code"
]
},
{
"login": "Vegemash",
"name": "Isaac Jackson",
"avatar_url": "https://avatars.githubusercontent.com/u/2470379?v=4",
"profile": "https://github.com/Vegemash",
"contributions": [
"code"
]
},
{
"login": "nisemenov",
"name": "Nikita Semenov",
"avatar_url": "https://avatars.githubusercontent.com/u/117774141?v=4",
"profile": "https://github.com/nisemenov",
"contributions": [
"code",
"doc"
]
},
{
"login": "iloveitaly",
"name": "Michael Bianco",
"avatar_url": "https://avatars.githubusercontent.com/u/150855?v=4",
"profile": "https://mikebian.co/",
"contributions": [
"code",
"doc"
]
}
],
"contributorsPerLine": 7,
"skipCi": true,
"repoType": "github",
"repoHost": "https://github.com",
"projectName": "polyfactory",
"projectOwner": "litestar-org",
"commitType": "docs"
}
python-polyfactory-2.21.0/.github/ 0000775 0000000 0000000 00000000000 15000423051 0017014 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/.github/CODEOWNERS 0000664 0000000 0000000 00000001126 15000423051 0020407 0 ustar 00root root 0000000 0000000 # Code owner settings for `litestar`
# @maintainers should be assigned to all reviews.
# Most specific assignment takes precedence though, so if you add a more specific thing than the `*` glob, you must also add @maintainers
# For more info about code owners see https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#codeowners-file-example
# Global Assignment
* @litestar-org/maintainers @litestar-org/members
# Documentation
docs/* @litestar-org/maintainers @JacobCoffee @provinzkraut
# Polyfactory
* @guacs
python-polyfactory-2.21.0/.github/ISSUE_TEMPLATE/ 0000775 0000000 0000000 00000000000 15000423051 0021177 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/.github/ISSUE_TEMPLATE/BUG.yaml 0000664 0000000 0000000 00000004476 15000423051 0022513 0 ustar 00root root 0000000 0000000 name: "Bug Report"
description: Create an issue for a bug.
title: "Bug: "
labels: ["bug", "triage required"]
body:
- type: textarea
id: description
attributes:
label: "Description"
description: Please enter an description of the bug you are encountering
placeholder:
validations:
required: true
- type: input
id: reprod-url
attributes:
label: "URL to code causing the issue"
description: Please enter the URL to provide a reproduction of the issue, if applicable
placeholder: ex. https://github.com/USERNAME/REPO-NAME
validations:
required: false
- type: textarea
id: mcve
attributes:
label: "MCVE"
description: "Please provide a minimal, complete, and verifiable example of the issue."
value: |
```py
# Your MCVE code here
```
render: python
validations:
required: false
- type: textarea
id: reprod
attributes:
label: "Steps to reproduce"
description: Please enter the exact steps to reproduce the issue
value: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
render: bash
validations:
required: false
- type: textarea
id: screenshot
attributes:
label: "Screenshots"
description: If applicable, add screenshots to help explain your problem.
value: |
"In the format of: ``"
validations:
required: false
- type: textarea
id: logs
attributes:
label: "Logs"
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: bash
validations:
required: false
- type: textarea
id: version
attributes:
label: "Release Version"
description: What version of the project are you using when encountering this issue?
validations:
required: true
- type: checkboxes
id: platform
attributes:
label: "Platform"
description: What platform are you encountering the issue on?
options:
- label: "Linux"
- label: "Mac"
- label: "Windows"
- label: "Other (Please specify in the description above)"
validations:
required: false
python-polyfactory-2.21.0/.github/ISSUE_TEMPLATE/DOCS.yaml 0000664 0000000 0000000 00000000576 15000423051 0022623 0 ustar 00root root 0000000 0000000 name: "Documentation Update"
description: Create an issue for documentation changes
title: "Docs: <title>"
labels: ["documentation"]
body:
- type: textarea
id: summary
attributes:
label: "Summary"
description: Provide a brief summary of your feature request
placeholder: Describe in a few lines your feature request
validations:
required: true
python-polyfactory-2.21.0/.github/ISSUE_TEMPLATE/REQUEST.yaml 0000664 0000000 0000000 00000002301 15000423051 0023207 0 ustar 00root root 0000000 0000000 name: "Feature Request"
description: Create an issue for a new feature request
title: "Enhancement: <title>"
labels: ["enhancement"]
body:
- type: textarea
id: summary
attributes:
label: "Summary"
description: Provide a brief summary of your feature request
placeholder: Describe in a few lines your feature request
validations:
required: true
- type: textarea
id: basic_example
attributes:
label: "Basic Example"
description: Indicate here some basic examples of your feature.
placeholder: Provide some basic example of your feature request
validations:
required: false
- type: textarea
id: drawbacks
attributes:
label: "Drawbacks and Impact"
description: What are the drawbacks or impacts of your feature request?
placeholder: Describe any the drawbacks or impacts of your feature request
validations:
required: false
- type: textarea
id: unresolved_question
attributes:
label: "Unresolved questions"
description: What, if any, unresolved questions do you have about your feature request?
placeholder: Identify any unresolved issues.
validations:
required: false
python-polyfactory-2.21.0/.github/ISSUE_TEMPLATE/config.yml 0000664 0000000 0000000 00000001201 15000423051 0023161 0 ustar 00root root 0000000 0000000 blank_lines_enabled: true
contact_links:
- name: Polyfactory Documentation
url: https://polyfactory.litestar.dev/
about: Official Polyfactory documentation - please check here before opening an issue.
- name: Litestar Documentation
url: https://docs.litestar.dev/
about: Official Litestar documentation - please check here before opening an issue.
- name: Litestar Website
url: https://litestar.dev/
about: Main Litestar website - for details about Litestar's projects.
- name: Discord
url: https://discord.gg/MmcwxztmQb
about: Join our Discord community to chat or get in touch with the maintainers.
python-polyfactory-2.21.0/.github/dependabot.yaml 0000664 0000000 0000000 00000000165 15000423051 0022007 0 ustar 00root root 0000000 0000000 version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
python-polyfactory-2.21.0/.github/workflows/ 0000775 0000000 0000000 00000000000 15000423051 0021051 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/.github/workflows/ci.yml 0000664 0000000 0000000 00000011625 15000423051 0022174 0 ustar 00root root 0000000 0000000 name: Tests And Linting
on:
pull_request:
push:
branches:
- main
jobs:
validate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: Install Pre-Commit
run: python -m pip install pre-commit && pre-commit install
- name: Load cached Pre-Commit Dependencies
id: cached-pre-commit-dependencies
uses: actions/cache@v4
with:
path: ~/.cache/pre-commit/
key: pre-commit|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}
- name: Execute Pre-Commit
run: pre-commit run --show-diff-on-failure --color=always --all-files
test:
runs-on: ubuntu-latest
strategy:
fail-fast: true
matrix:
python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
pydantic-version: ["1.10", "2.0"]
sqla-version: ["1.4", "2"]
exclude:
- pydantic-version: "1.10"
sqla-version: "1.4"
steps:
- name: Check out repository
uses: actions/checkout@v4
- name: Set up python ${{ matrix.python-version }}
id: checkout-python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Create cache file
run: echo '${{ matrix.pydantic-version }}-${{ matrix.sqla-version }}' > ./matrix-file.txt
- name: Set up python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.5.4"
enable-cache: true
cache-dependency-glob: |
uv.lock
matrix-file.txt
- name: Install pydantic
if: matrix.pydantic-version == '1.10'
run: uv add --group pydantic "pydantic[email]==1.10.17"
- name: Install SQLAlchemy
if: matrix.sqla-version == '1.4'
run: uv add --group sqlalchemy "sqlalchemy[asyncio]==1.4.49"
- name: Sync
run: uv sync --all-extras
- name: Test
if: matrix.python-version != '3.13' || matrix.pydantic-version != '2.0' || matrix.sqla-version != '2'
run: uv run pytest tests
- name: Test with Coverage
if: matrix.python-version == '3.13' && matrix.pydantic-version == '2.0' && matrix.sqla-version == '2'
run: uv run pytest tests docs/examples --cov=. --cov-report=xml
- uses: actions/upload-artifact@v4
if: matrix.python-version == '3.13' && matrix.pydantic-version == '2.0' && matrix.sqla-version == '2'
with:
name: coverage-data
path: coverage.xml
build-docs:
needs:
- validate
if: github.event_name == 'pull_request'
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.5.4"
enable-cache: true
- name: Install dependencies
run: uv sync --all-extras
- name: Build docs
run: uv run make docs
- name: Save PR number
env:
PR_NUMBER: ${{ github.event.number }}
run: echo $PR_NUMBER > .pr_number
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: docs-preview
include-hidden-files: true
path: |
docs/_build/html
.pr_number
codeql:
needs:
- test
- validate
runs-on: ubuntu-latest
permissions:
security-events: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Initialize CodeQL With Dependencies
if: github.event_name == 'push' && github.ref_name == 'main'
uses: github/codeql-action/init@v3
- name: Initialize CodeQL Without Dependencies
if: github.event_name == 'pull_request'
uses: github/codeql-action/init@v3
with:
setup-python-dependencies: false
- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v3
upload-test-coverage:
runs-on: ubuntu-latest
needs:
- test
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: Download Artifacts
uses: actions/download-artifact@v4
with:
name: coverage-data
- name: Fix coverage file name
run: sed -i "s/home\/runner\/work\/polyfactory\/polyfactory/github\/workspace/g" coverage.xml
- name: Upload coverage reports to Codecov
uses: codecov/codecov-action@v5
with:
files: coverage.xml
token: ${{ secrets.CODECOV_TOKEN }}
python-polyfactory-2.21.0/.github/workflows/docs-preview.yml 0000664 0000000 0000000 00000004444 15000423051 0024211 0 ustar 00root root 0000000 0000000 name: Deploy Documentation Preview
on:
workflow_run:
workflows: [Tests And Linting]
types: [completed]
jobs:
deploy:
if: ${{ github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.event == 'pull_request' }}
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- name: Check out repository
uses: actions/checkout@v4
- name: Download artifact
uses: dawidd6/action-download-artifact@v9
with:
workflow_conclusion: success
run_id: ${{ github.event.workflow_run.id }}
path: docs-preview
name: docs-preview
- name: Set PR number
run: echo "PR_NUMBER=$(cat docs-preview/.pr_number)" >> $GITHUB_ENV
- name: Deploy docs preview
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: docs-preview/docs/_build/html
token: ${{ secrets.DOCS_PREVIEW_DEPLOY_TOKEN }}
repository-name: litestar-org/polyfactory-docs-preview
clean: false
target-folder: ${{ env.PR_NUMBER }}
branch: gh-pages
- uses: actions/github-script@v7
env:
PR_NUMBER: ${{ env.PR_NUMBER }}
with:
script: |
const issue_number = process.env.PR_NUMBER
const body = "Documentation preview will be available shortly at https://litestar-org.github.io/polyfactory-docs-preview/" + issue_number
const opts = github.rest.issues.listComments.endpoint.merge({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue_number,
});
const comments = await github.paginate(opts)
for (const comment of comments) {
if (comment.user.id === 41898282 && comment.body === body) {
await github.rest.issues.deleteComment({
owner: context.repo.owner,
repo: context.repo.repo,
comment_id: comment.id
})
}
}
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issue_number,
body: body,
})
python-polyfactory-2.21.0/.github/workflows/docs.yml 0000664 0000000 0000000 00000001722 15000423051 0022526 0 ustar 00root root 0000000 0000000 name: Documentation Building
on:
release:
types: [published]
push:
branches:
- main
jobs:
docs:
permissions:
contents: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.5.4"
enable-cache: true
- name: Install dependencies
run: uv sync --all-extras
- name: Fetch gh pages
run: git fetch origin gh-pages --depth=1
- name: Build release docs
run: uv run python tools/build_docs.py docs-build
if: github.event_name == 'release'
- name: Build dev docs
run: uv run python tools/build_docs.py docs-build
if: github.event_name == 'push'
- name: Deploy
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: docs-build
python-polyfactory-2.21.0/.github/workflows/pr-title.yml 0000664 0000000 0000000 00000000532 15000423051 0023334 0 ustar 00root root 0000000 0000000 name: "Lint PR Title"
on:
pull_request_target:
types:
- opened
- edited
- synchronize
permissions:
pull-requests: read
jobs:
main:
name: Validate PR title
runs-on: ubuntu-latest
steps:
- uses: amannn/action-semantic-pull-request@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
python-polyfactory-2.21.0/.github/workflows/publish.yml 0000664 0000000 0000000 00000002500 15000423051 0023237 0 ustar 00root root 0000000 0000000 name: Latest Release
on:
release:
types: [published]
workflow_dispatch:
jobs:
publish-release:
name: upload release to PyPI
runs-on: ubuntu-latest
permissions:
id-token: write
environment: release
steps:
- name: Check out repository
uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.5.4"
enable-cache: true
- name: Build package
run: uv build
- name: Publish package distributions to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
build-docs:
permissions:
contents: write
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.5.4"
enable-cache: true
- name: Install dependencies
run: uv sync --all-extras
- name: Build docs
run: uv run make docs
- name: Deploy
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: docs/_build/html
python-polyfactory-2.21.0/.gitignore 0000664 0000000 0000000 00000001314 15000423051 0017443 0 ustar 00root root 0000000 0000000 # folders
__pycache__/
.auto_pytabs_cache/
.hypothesis/
.idea/
.mypy_cache/
.pytest_cache/
.scannerwork/
.venv/
.vscode/
*.egg-info/
build/
dist/
node_modules/
results/
site/
target/
# files
**/*.so
**/*.sqlite
**/*.sqlite*
*.iml
.DS_Store
.coverage
.python-version
.ruff_cache
/docs/_build/
coverage.*
setup.py
# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/
/.pdm-python
python-polyfactory-2.21.0/.pre-commit-config.yaml 0000664 0000000 0000000 00000004103 15000423051 0021733 0 ustar 00root root 0000000 0000000 default_language_version:
python: "3.13"
repos:
- repo: https://github.com/compilerla/conventional-pre-commit
rev: v4.0.0
hooks:
- id: conventional-pre-commit
stages: [commit-msg]
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: check-ast
- id: check-case-conflict
- id: check-merge-conflict
- id: check-toml
- id: debug-statements
- id: end-of-file-fixer
- id: mixed-line-ending
- id: trailing-whitespace
- repo: https://github.com/charliermarsh/ruff-pre-commit
rev: "v0.11.0"
hooks:
- id: ruff
args: ["--fix"]
- id: ruff-format
- repo: https://github.com/crate-ci/typos
rev: v1.30.3
hooks:
- id: typos
- repo: https://github.com/pycontribs/mirrors-prettier
rev: "v3.5.3"
hooks:
- id: prettier
exclude: ".all-contributorsrc"
- repo: https://github.com/ComPWA/taplo-pre-commit
rev: v0.9.3
hooks:
- id: taplo-format
exclude: "uv.lock"
- repo: https://github.com/pre-commit/mirrors-mypy
rev: "v1.15.0"
hooks:
- id: mypy
exclude: "test_decimal_constraints|examples/fields/test_example_2|examples/configuration|tools/"
additional_dependencies:
[
attrs>=22.2.0,
beanie,
faker,
hypothesis,
mongomock_motor,
msgspec,
odmantic<1,
pydantic>=2,
pytest,
sphinx,
sqlalchemy>=2,
]
- repo: https://github.com/RobertCraigie/pyright-python
rev: v1.1.397
hooks:
- id: pyright
exclude: "tests"
additional_dependencies:
[
attrs>=22.2.0,
beanie,
faker,
hypothesis,
mongomock_motor,
msgspec,
odmantic<1,
pydantic>=2,
pytest,
sphinx,
sqlalchemy>=2,
]
- repo: https://github.com/sphinx-contrib/sphinx-lint
rev: "v1.0.0"
hooks:
- id: sphinx-lint
python-polyfactory-2.21.0/.sourcery.yaml 0000664 0000000 0000000 00000001156 15000423051 0020274 0 ustar 00root root 0000000 0000000 ignore:
- .tox/
- .venv/
- dist/
- docs/_build/
- docs/_static/
- node_modules/
- vendor/
- venv/
rule_settings:
enable: [default]
disable: [dont-import-test-modules]
rule_types:
- refactoring
- suggestion
- comment
python_version: "3.8"
rules: []
metrics:
quality_threshold: 25.0
github:
ignore_labels:
- sourcery-ignore
- docs
labels:
- build-ignore
request_review:
origin: owner
forked: author
sourcery_branch: sourcery/{base_branch}
clone_detection:
min_lines: 3
min_duplicates: 2
identical_clones_only: false
proxy:
no_ssl_verify: false
python-polyfactory-2.21.0/CONTRIBUTING.rst 0000664 0000000 0000000 00000010015 15000423051 0020112 0 ustar 00root root 0000000 0000000 Contributing
==================
Setting up the environment
--------------------------
1. Install `uv <https://github.com/astral-sh/uv>`_
2. Run ``uv sync --all-extras`` to create a `virtual environment <https://docs.python.org/3/tutorial/venv.html>`_ and install
the dependencies
3. Install `pre-commit <https://pre-commit.com/>`_
4. Run ``pre-commit install`` to install pre-commit hooks
Code contributions
------------------
Workflow
++++++++
1. `Fork <https://github.com/litestar-org/polyfactory/fork>`_ the `Polyfactory repository <https://github.com/litestar-org/polyfactory>`_
2. Clone your fork locally with git
3. `Set up the environment <#setting-up-the-environment>`_
4. Make your changes
5. (Optional) Run ``pre-commit run --all-files`` to run linters and formatters. This step is optional and will be executed
automatically by git before you make a commit, but you may want to run it manually in order to apply fixes
6. Commit your changes to git
7. Push the changes to your fork
8. Open a `pull request <https://docs.github.com/en/pull-requests>`_. Give the pull request a descriptive title
indicating what it changes. If it has a corresponding open issue.
For example a pull request that fixes issue ``bug: Increased stack size making it impossible to find needle``
could be titled ``fix: Make needles easier to find by applying fire to haystack``
.. tip:: Pull requests and commits all need to follow the
`Conventional Commit format <https://www.conventionalcommits.org>`_
Project documentation
---------------------
The documentation is located in the ``/docs`` directory and is built with `ReST <https://docutils.sourceforge.io/rst.html>`_
and `Sphinx <https://www.sphinx-doc.org/en/master/>`_. If you're unfamiliar with any of those,
`ReStructuredText primer <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_ and
`Sphinx quickstart <https://www.sphinx-doc.org/en/master/usage/quickstart.html>`_ are recommended reads.
Docs theme and appearance
+++++++++++++++++++++++++
We welcome contributions that enhance / improve the appearance and usability of the docs. We use a custom theme that
inherits the `Shibuya theme <https://shibuya.lepture.com/>`_, which comes with a lot of options out of the box.
If you wish to contribute to the docs style / setup, or static site generation, you should consult the theme docs
as a first step.
Running the docs locally
++++++++++++++++++++++++
To run or build the docs locally, you need to first install the required dependencies:
.. code-block:: console
:caption: Installing the docs dependencies
uv sync --all-extras
Then you can serve the documentation with ``make docs-serve``, or build them with ``make docs``
Writing and editing docs
++++++++++++++++++++++++
We welcome contributions that enhance / improve the content of the docs. Feel free to add examples, clarify text,
restructure the docs etc., but make sure to follow these guidelines:
- Write text in idiomatic english, using simple language
- Keep examples simple and self contained
- Provide links where applicable
- Use `intersphinx <https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html>`_ wherever possible when
referencing external libraries
- Provide diagrams using `mermaidjs <https://mermaid.js.org/>`_ where applicable and possible
Creating a new release
----------------------
1. Run `make release` to bump version and commit.
.. note:: The version should follow `semantic versioning <https://semver.org/>`_ and `PEP 440 <https://www.python.org/dev/peps/pep-0440/>`_.
2. Push and create PR.
3. In GitHub go to the `releases tab <https://github.com/litestar-org/polyfactory/releases>`_
4. Pick "`Draft a new release <https://github.com/litestar-org/polyfactory/releases/new>`_"
5. Give it a title and a tag, both ``vX.X.X``
6. Fill in the release description. You can let GitHub do it for you and then edit as needed.
7. Publish the release.
8. Go to `Actions <https://github.com/litestar-org/polyfactory/actions>`_ and approve the workflow
9. Check that the workflow runs successfully
python-polyfactory-2.21.0/LICENSE 0000664 0000000 0000000 00000002104 15000423051 0016456 0 ustar 00root root 0000000 0000000 The MIT License (MIT)
Copyright (c) 2021, 2022, 2023 Litestar Org.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
python-polyfactory-2.21.0/Makefile 0000664 0000000 0000000 00000010403 15000423051 0017112 0 ustar 00root root 0000000 0000000 SHELL := /bin/bash
# =============================================================================
# Variables
# =============================================================================
.DEFAULT_GOAL:=help
.EXPORT_ALL_VARIABLES:
.PHONY: help
help: ## Display this help text for Makefile
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z0-9_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
.PHONY: upgrade
upgrade: ## Upgrade all dependencies to the latest stable versions
@echo "=> Updating all dependencies"
@uv sync --upgrade
@echo "=> Dependencies Updated"
@uv run pre-commit autoupdate
@echo "=> Updated Pre-commit"
# =============================================================================
# Developer Utils
# =============================================================================
.PHONY: install
install: ## Install the project, dependencies, and pre-commit for local development
@if [ "$(VENV_EXISTS)" ]; then echo "=> Removing existing virtual environment"; fi
if [ "$(VENV_EXISTS)" ]; then $(MAKE) destroy; fi
if [ "$(VENV_EXISTS)" ]; then $(MAKE) clean; fi
@uv sync --all-extras
@echo "=> Installing pre-commit hooks"
pre-commit install --install-hooks
@echo "=> Install complete! Note: If you want to re-install re-run 'make install'"
.PHONY: clean
clean: ## Cleanup temporary build artifacts
@echo "=> Cleaning working directory"
@rm -rf .pytest_cache .ruff_cache .hypothesis build/ dist/ .eggs/ .egg/
@find . -name '*.egg-info' -exec rm -rf {} +
@find . -name '*.pyc' -exec rm -f {} +
@find . -name '*.pyo' -exec rm -f {} +
@find . -name '*~' -exec rm -f {} +
@find . -name '__pycache__' -exec rm -rf {} +
@find . -name '.ipynb_checkpoints' -exec rm -rf {} +
@rm -rf .coverage coverage.xml coverage.json htmlcov/ .pytest_cache tests/.pytest_cache tests/**/.pytest_cache .mypy_cache
$(MAKE) docs-clean
.PHONY: destroy
destroy: ## Destroy the virtual environment
@rm -rf .venv
.PHONY: lock
lock: ## Rebuild lockfiles from scratch, updating all dependencies
@uv lock
.PHONY: release
release:
./tools/prepare-release.sh
# =============================================================================
# Tests, Linting, Coverage
# =============================================================================
.PHONY: lint
lint: ## Runs pre-commit hooks; includes ruff linting, ruff formatting, codespell
@echo "=> Running pre-commit process"
@uv run pre-commit run --all-files
@echo "=> Pre-commit complete"
.PHONY: coverage
coverage: ## Run the tests and generate coverage report
@echo "=> Running tests with coverage"
@uv run pytest tests --cov=polyfactory
@uv run coverage html
@uv run coverage xml
@echo "=> Coverage report generated"
.PHONY: test
test: ## Run the tests
@echo "=> Running test cases"
@uv run pytest tests
@echo "=> Tests complete"
.PHONY: test-examples
test-examples: ## Run the examples tests
@uv run pytest docs/examples
.PHONY: test-all
test-all: test test-examples ## Run all tests
.PHONY: check-all
check-all: lint test-all coverage ## Run all linting, tests, and coverage checks
# =============================================================================
# Docs
# =============================================================================
.PHONY: docs-install
docs-install: ## Install docs dependencies
@echo "=> Installing documentation dependencies"
@uv sync --group docs
@echo "=> Installed documentation dependencies"
docs-clean: ## Dump the existing built docs
@echo "=> Cleaning documentation build assets"
@rm -rf docs/_build
@echo "=> Removed existing documentation build assets"
docs-serve: docs-clean ## Serve the docs locally
@echo "=> Serving documentation"
@uv run sphinx-autobuild docs docs/_build/ -j auto --watch polyfactory --watch docs --watch tests --watch CONTRIBUTING.rst --port 8002
docs: docs-clean ## Dump the existing built docs and rebuild them
@echo "=> Building documentation"
@uv run sphinx-build -M html docs docs/_build/ -E -a -j auto --keep-going
python-polyfactory-2.21.0/README.md 0000664 0000000 0000000 00000100210 15000423051 0016725 0 ustar 00root root 0000000 0000000 <!-- markdownlint-disable -->
<p align="center">
<img src="https://github.com/litestar-org/branding/blob/e27cda904e0649e5065ac1c26df6a279ba5d06b5/assets/Branding%20-%20SVG%20-%20Transparent/Polyfactory%20-%20Banner%20-%20Inline%20-%20Light.svg#gh-light-mode-only" alt="Litestar - Polyfactory Logo - Light" width="100%" height="auto" />
<img src="https://github.com/litestar-org/branding/blob/e27cda904e0649e5065ac1c26df6a279ba5d06b5/assets/Branding%20-%20SVG%20-%20Transparent/Polyfactory%20-%20Banner%20-%20Inline%20-%20Dark.svg#gh-dark-mode-only" alt="Litestar - Polyfactory Logo - Dark" width="100%" height="auto" />
</p>
<div align="center">
<!-- prettier-ignore-start -->
| Project | | Status |
| --------- | :-- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CI/CD | | [](https://github.com/litestar-org/polyfactory/actions/workflows/publish.yml) [](https://github.com/litestar-org/polyfactory/actions/workflows/ci.yml) [](https://github.com/litestar-org/polyfactory/actions/workflows/pages/pages-build-deployment) |
| Quality | | [](https://codecov.io/github/litestar-org/polyfactory) |
| Package | | [](https://badge.fury.io/py/polyfactory)    |
| Community | | [](https://reddit.com/r/litestarapi) [](https://discord.gg/X3FJqy8d2j) [](https://matrix.to/#/#litestar:matrix.org) [](https://blog.litestar.dev) [](https://twitter.com/LitestarAPI) [](https://blog.litestar.dev) |
| Meta | | [](https://github.com/litestar-org/polyfactory) [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/sponsors/litestar-org) [](https://pydantic.dev) [](https://github.com/astral-sh/ruff) [](https://github.com/astral-sh/ruff) [](https://sourcery.ai) [](#contributors-) |
<!-- prettier-ignore-end -->
</div>
<!-- markdownlint-restore -->
# Polyfactory
Polyfactory is a simple and powerful mock data generation library, based around type
hints and supporting dataclasses, typed-dicts, pydantic models, msgspec structs and more.
Polyfactory part of the Litestar project and as such actively maintained by a community of maintainers and contributors.
## Example
```python
from dataclasses import dataclass
from polyfactory.factories import DataclassFactory
@dataclass
class Person:
name: str
age: float
height: float
weight: float
class PersonFactory(DataclassFactory[Person]):
...
def test_is_person() -> None:
person_instance = PersonFactory.build()
assert isinstance(person_instance, Person)
```
That's it - with almost no work, we are able to create a mock data object fitting the `Person` class model definition.
This is possible because of the typing information available on the dataclass, which are used as a
source of truth for data generation.
The factory parses the information stored in the dataclass and generates a dictionary of kwargs that are passed to
`Person`.
## Documentation
Usage and API reference documentation is available on https://polyfactory.litestar.dev/.
## Installation
```shell
pip install polyfactory
```
## Relation to Pydantic-Factories
Prior to version 2, this library was known as [pydantic-factories](https://pypi.org/project/pydantic-factories/), a name
under which it gained quite a bit of popularity.
A main motivator for the 2.0 release was that we wanted to support more than just Pydantic models, something which also
required a change to its core architecture. As this library would no longer be directly tied to Pydantic, `polyfactory`
was chosen as its new name to reflect its capabilities; It can generate mock data for dataclasses, typed-dicts,
Pydantic, odmantic, and beanie ODM models, as well as custom factories.
## Contributing
This library is a community driven open source project. We welcome and encourage contributions. Please check out the
GitHub issues, read the contribution guide (at the repository's root), and you're always welcome
to [join our discord server](https://discord.gg/F4jPQzHpBU).
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Goldziher"><img src="https://avatars.githubusercontent.com/u/30733348?v=4?s=100" width="100px;" alt="Na'aman Hirschfeld"/><br /><sub><b>Na'aman Hirschfeld</b></sub></a><br /><a href="#maintenance-Goldziher" title="Maintenance">🚧</a> <a href="#infra-Goldziher" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=Goldziher" title="Tests">⚠️</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=Goldziher" title="Code">💻</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=Goldziher" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://scriptr.dev/"><img src="https://avatars.githubusercontent.com/u/45884264?v=4?s=100" width="100px;" alt="Jacob Coffee"/><br /><sub><b>Jacob Coffee</b></sub></a><br /><a href="#maintenance-JacobCoffee" title="Maintenance">🚧</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=JacobCoffee" title="Documentation">📖</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=JacobCoffee" title="Tests">⚠️</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/provinzkraut"><img src="https://avatars.githubusercontent.com/u/25355197?v=4?s=100" width="100px;" alt="Janek Nouvertné"/><br /><sub><b>Janek Nouvertné</b></sub></a><br /><a href="#maintenance-provinzkraut" title="Maintenance">🚧</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=provinzkraut" title="Documentation">📖</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=provinzkraut" title="Tests">⚠️</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=provinzkraut" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://schutt.io"><img src="https://avatars.githubusercontent.com/u/20659309?v=4?s=100" width="100px;" alt="Peter Schutt"/><br /><sub><b>Peter Schutt</b></sub></a><br /><a href="#maintenance-peterschutt" title="Maintenance">🚧</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=peterschutt" title="Tests">⚠️</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=peterschutt" title="Code">💻</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=peterschutt" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://czaplicki.it/"><img src="https://avatars.githubusercontent.com/u/9108586?v=4?s=100" width="100px;" alt="Marek Czaplicki"/><br /><sub><b>Marek Czaplicki</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=mdczaplicki" title="Code">💻</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=mdczaplicki" title="Tests">⚠️</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/przybylop"><img src="https://avatars.githubusercontent.com/u/82805821?v=4?s=100" width="100px;" alt="Piotr Przybyło"/><br /><sub><b>Piotr Przybyło</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=przybylop" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/sygutss"><img src="https://avatars.githubusercontent.com/u/48909366?v=4?s=100" width="100px;" alt="sygutss"/><br /><sub><b>sygutss</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/issues?q=author%3Asygutss" title="Bug reports">🐛</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=sygutss" title="Code">💻</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/chrisbeardy"><img src="https://avatars.githubusercontent.com/u/20585410?v=4?s=100" width="100px;" alt="chrisbeardy"/><br /><sub><b>chrisbeardy</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=chrisbeardy" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/guacs"><img src="https://avatars.githubusercontent.com/u/126393040?v=4?s=100" width="100px;" alt="guacs"/><br /><sub><b>guacs</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=guacs" title="Code">💻</a> <a href="#infra-guacs" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=guacs" title="Documentation">📖</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=guacs" title="Tests">⚠️</a> <a href="#maintenance-guacs" title="Maintenance">🚧</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/VSHUMILIN97"><img src="https://avatars.githubusercontent.com/u/27234763?v=4?s=100" width="100px;" alt="Vadim"/><br /><sub><b>Vadim</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=VSHUMILIN97" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Simske"><img src="https://avatars.githubusercontent.com/u/2445660?v=4?s=100" width="100px;" alt="Simske"/><br /><sub><b>Simske</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=Simske" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/sondrelg"><img src="https://avatars.githubusercontent.com/u/25310870?v=4?s=100" width="100px;" alt="Sondre Lillebø Gundersen"/><br /><sub><b>Sondre Lillebø Gundersen</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=sondrelg" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://mciszczon.pl/"><img src="https://avatars.githubusercontent.com/u/1078369?v=4?s=100" width="100px;" alt="Mateusz Ciszczoń"/><br /><sub><b>Mateusz Ciszczoń</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=mciszczon" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/pedro-bernardes/"><img src="https://avatars.githubusercontent.com/u/18899993?v=4?s=100" width="100px;" alt="Pedro Bernardes"/><br /><sub><b>Pedro Bernardes</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=phbernardes" title="Code">💻</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/lindycoder"><img src="https://avatars.githubusercontent.com/u/12926519?v=4?s=100" width="100px;" alt="Martin Roy"/><br /><sub><b>Martin Roy</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=lindycoder" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://matthewtyleraylward.com"><img src="https://avatars.githubusercontent.com/u/19205392?v=4?s=100" width="100px;" alt="Matthew Aylward "/><br /><sub><b>Matthew Aylward </b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=Butch78" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/EltonChou"><img src="https://avatars.githubusercontent.com/u/12560310?v=4?s=100" width="100px;" alt="Elton H.Y. Chou"/><br /><sub><b>Elton H.Y. Chou</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=EltonChou" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/nguyent"><img src="https://avatars.githubusercontent.com/u/576848?v=4?s=100" width="100px;" alt="Thang"/><br /><sub><b>Thang</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=nguyent" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/DaanRademaker"><img src="https://avatars.githubusercontent.com/u/29598493?v=4?s=100" width="100px;" alt="Daan"/><br /><sub><b>Daan</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=DaanRademaker" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://lyz-code.github.io/blue-book/"><img src="https://avatars.githubusercontent.com/u/24810987?v=4?s=100" width="100px;" alt="Lyz"/><br /><sub><b>Lyz</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=lyz-code" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://portfolio.schiffer.pro/"><img src="https://avatars.githubusercontent.com/u/3502492?v=4?s=100" width="100px;" alt="Thorin Schiffer"/><br /><sub><b>Thorin Schiffer</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=thorin-schiffer" title="Code">💻</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Iipin"><img src="https://avatars.githubusercontent.com/u/52832022?v=4?s=100" width="100px;" alt="Iipin"/><br /><sub><b>Iipin</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=Iipin" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/avihai-yosef"><img src="https://avatars.githubusercontent.com/u/79567307?v=4?s=100" width="100px;" alt="avihai-yosef"/><br /><sub><b>avihai-yosef</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=avihai-yosef" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/anthonyh209"><img src="https://avatars.githubusercontent.com/u/33107540?v=4?s=100" width="100px;" alt="anthonyh209"/><br /><sub><b>anthonyh209</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=anthonyh209" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://linkedin.com/in/roman-reznikov"><img src="https://avatars.githubusercontent.com/u/44291988?v=4?s=100" width="100px;" alt="Roman Reznikov"/><br /><sub><b>Roman Reznikov</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=ReznikovRoman" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/gigelu"><img src="https://avatars.githubusercontent.com/u/270697?v=4?s=100" width="100px;" alt="gigelu"/><br /><sub><b>gigelu</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=gigelu" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/roeeyn"><img src="https://avatars.githubusercontent.com/u/13385000?v=4?s=100" width="100px;" alt="Rodrigo Medina"/><br /><sub><b>Rodrigo Medina</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=roeeyn" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://gerritegnew.info/"><img src="https://avatars.githubusercontent.com/u/35822787?v=4?s=100" width="100px;" alt="Gerrit Egnew"/><br /><sub><b>Gerrit Egnew</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=gegnew" title="Code">💻</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/danielkatzan"><img src="https://avatars.githubusercontent.com/u/9249066?v=4?s=100" width="100px;" alt="danielkatzan"/><br /><sub><b>danielkatzan</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=danielkatzan" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/abdulhaq-e"><img src="https://avatars.githubusercontent.com/u/2532125?v=4?s=100" width="100px;" alt="Abdulhaq Emhemmed"/><br /><sub><b>Abdulhaq Emhemmed</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=abdulhaq-e" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/klimantje"><img src="https://avatars.githubusercontent.com/u/20017047?v=4?s=100" width="100px;" alt="klimantje"/><br /><sub><b>klimantje</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=klimantje" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/tcrasset"><img src="https://avatars.githubusercontent.com/u/25140344?v=4?s=100" width="100px;" alt="Tom Crasset"/><br /><sub><b>Tom Crasset</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=tcrasset" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://git.roboces.dev/catalin"><img src="https://avatars.githubusercontent.com/u/45485069?v=4?s=100" width="100px;" alt="cătălin"/><br /><sub><b>cătălin</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=185504a9" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/adhtruong"><img src="https://avatars.githubusercontent.com/u/40660973?v=4?s=100" width="100px;" alt="Andrew Truong"/><br /><sub><b>Andrew Truong</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=adhtruong" title="Code">💻</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=adhtruong" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/anthonyjgraff"><img src="https://avatars.githubusercontent.com/u/59455370?v=4?s=100" width="100px;" alt="Anthony"/><br /><sub><b>Anthony</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=anthonyjgraff" title="Code">💻</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=anthonyjgraff" title="Documentation">📖</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=anthonyjgraff" title="Tests">⚠️</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/johnraz"><img src="https://avatars.githubusercontent.com/u/304164?v=4?s=100" width="100px;" alt="Jonathan Liuti"/><br /><sub><b>Jonathan Liuti</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=johnraz" title="Code">💻</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=johnraz" title="Documentation">📖</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=johnraz" title="Tests">⚠️</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://julio.li/"><img src="https://avatars.githubusercontent.com/u/1302493?v=4?s=100" width="100px;" alt="Julio Olivera"/><br /><sub><b>Julio Olivera</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=julioolvr" title="Code">💻</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=julioolvr" title="Tests">⚠️</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/g0di"><img src="https://avatars.githubusercontent.com/u/2545380?v=4?s=100" width="100px;" alt="Benoît Godard"/><br /><sub><b>Benoît Godard</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=g0di" title="Code">💻</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=g0di" title="Documentation">📖</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=g0di" title="Tests">⚠️</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/hsorsky"><img src="https://avatars.githubusercontent.com/u/36887638?v=4?s=100" width="100px;" alt="Henry Sorsky"/><br /><sub><b>Henry Sorsky</b></sub></a><br /><a href="#infra-hsorsky" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/wer153"><img src="https://avatars.githubusercontent.com/u/23370765?v=4?s=100" width="100px;" alt="Kim Minki"/><br /><sub><b>Kim Minki</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=wer153" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://www.timdumol.com/"><img src="https://avatars.githubusercontent.com/u/49169?v=4?s=100" width="100px;" alt="Tim Joseph Dumol"/><br /><sub><b>Tim Joseph Dumol</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=TimDumol" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/wangxin688"><img src="https://avatars.githubusercontent.com/u/36665036?v=4?s=100" width="100px;" alt="jeffry"/><br /><sub><b>jeffry</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=wangxin688" title="Code">💻</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Reskov"><img src="https://avatars.githubusercontent.com/u/4832451?v=4?s=100" width="100px;" alt="Sergey Kovalev"/><br /><sub><b>Sergey Kovalev</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=Reskov" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Vegemash"><img src="https://avatars.githubusercontent.com/u/2470379?v=4?s=100" width="100px;" alt="Isaac Jackson"/><br /><sub><b>Isaac Jackson</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=Vegemash" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/nisemenov"><img src="https://avatars.githubusercontent.com/u/117774141?v=4?s=100" width="100px;" alt="Nikita Semenov"/><br /><sub><b>Nikita Semenov</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=nisemenov" title="Code">💻</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=nisemenov" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://mikebian.co/"><img src="https://avatars.githubusercontent.com/u/150855?v=4?s=100" width="100px;" alt="Michael Bianco"/><br /><sub><b>Michael Bianco</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=iloveitaly" title="Code">💻</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=iloveitaly" title="Documentation">📖</a></td>
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
Contributions of any kind welcome!
python-polyfactory-2.21.0/codecov.yml 0000664 0000000 0000000 00000000255 15000423051 0017623 0 ustar 00root root 0000000 0000000 coverage:
status:
project:
default:
target: auto
threshold: 0.1%
patch:
default:
target: auto
comment:
require_changes: true
python-polyfactory-2.21.0/docs/ 0000775 0000000 0000000 00000000000 15000423051 0016404 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/PYPI_README.md 0000664 0000000 0000000 00000057422 15000423051 0020536 0 ustar 00root root 0000000 0000000 <!-- markdownlint-disable -->
<p align="center">
<img src="https://github.com/litestar-org/branding/blob/473f54621e55cde9acbb6fcab7fc03036173eb3d/assets/Branding%20-%20PNG%20-%20Transparent/Polyfactory%20-%20Banner%20-%20Inline%20-%20Light.png?raw=true" alt="Polyfactory Logo - Light" width="100%" height="auto" />
</p>
<!-- markdownlint-restore -->
<div align="center">
<!-- prettier-ignore-start -->
| Project | | Status |
| --------- | :-- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| CI/CD | | [](https://github.com/litestar-org/polyfactory/actions/workflows/publish.yml) [](https://github.com/litestar-org/polyfactory/actions/workflows/ci.yml) [](https://github.com/litestar-org/polyfactory/actions/workflows/pages/pages-build-deployment) |
| Quality | | [](https://codecov.io/github/litestar-org/polyfactory) |
| Package | | [](https://badge.fury.io/py/polyfactory)    |
| Community | | [](https://reddit.com/r/litestarapi) [](https://discord.gg/X3FJqy8d2j) [](https://matrix.to/#/#litestar:matrix.org) [](https://blog.litestar.dev) [](https://twitter.com/LitestarAPI) [](https://blog.litestar.dev) |
| Meta | | [](https://github.com/litestar-org/polyfactory) [](https://github.com/python/mypy) [](https://spdx.org/licenses/) [](https://github.com/sponsors/litestar-org) [](https://github.com/astral-sh/ruff) [](https://github.com/astral-sh/ruff) [](https://sourcery.ai) [](#contributors-) |
<!-- prettier-ignore-end -->
</div>
<!-- markdownlint-restore -->
# Polyfactory
Polyfactory is a simple and powerful mock data generation library, based around type
hints and supporting dataclasses, typed-dicts, pydantic models, msgspec structs and more.
Polyfactory part of the Litestar project and as such actively maintained by a community of maintainers and contributors.
## Example
```python
from dataclasses import dataclass
from polyfactory.factories import DataclassFactory
@dataclass
class Person:
name: str
age: float
height: float
weight: float
class PersonFactory(DataclassFactory[Person]):
...
def test_is_person() -> None:
person_instance = PersonFactory.build()
assert isinstance(person_instance, Person)
```
That's it - with almost no work, we are able to create a mock data object fitting the `Person` class model definition.
This is possible because of the typing information available on the dataclass, which are used as a
source of truth for data generation.
The factory parses the information stored in the dataclass and generates a dictionary of kwargs that are passed to
`Person`.
## Documentation
Usage and API reference documentation is available on https://polyfactory.litestar.dev/.
## Installation
```shell
pip install polyfactory
```
## Relation to Pydantic-Factories
Prior to version 2, this library was known as [pydantic-factories](https://pypi.org/project/pydantic-factories/), a name
under which it gained quite a bit of popularity.
A main motivator for the 2.0 release was that we wanted to support more than just Pydantic models, something which also
required a change to its core architecture. As this library would no longer be directly tied to Pydantic, `polyfactory`
was chosen as its new name to reflect its capabilities; It can generate mock data for dataclasses, typed-dicts,
Pydantic, odmantic, and beanie ODM models, as well as custom factories.
## Contributing
This library is a community driven open source project. We welcome and encourage contributions. Please checkout the
GitHub issues, read the contribution guide (at the repository's root), and you're always welcome
to [join our discord server](https://discord.gg/F4jPQzHpBU).
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Goldziher"><img src="https://avatars.githubusercontent.com/u/30733348?v=4?s=100" width="100px;" alt="Na'aman Hirschfeld"/><br /><sub><b>Na'aman Hirschfeld</b></sub></a><br /><a href="#maintenance-Goldziher" title="Maintenance">🚧</a> <a href="#infra-Goldziher" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=Goldziher" title="Tests">⚠️</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=Goldziher" title="Code">💻</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=Goldziher" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://scriptr.dev/"><img src="https://avatars.githubusercontent.com/u/45884264?v=4?s=100" width="100px;" alt="Jacob Coffee"/><br /><sub><b>Jacob Coffee</b></sub></a><br /><a href="#maintenance-JacobCoffee" title="Maintenance">🚧</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=JacobCoffee" title="Documentation">📖</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=JacobCoffee" title="Tests">⚠️</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/provinzkraut"><img src="https://avatars.githubusercontent.com/u/25355197?v=4?s=100" width="100px;" alt="Janek Nouvertné"/><br /><sub><b>Janek Nouvertné</b></sub></a><br /><a href="#maintenance-provinzkraut" title="Maintenance">🚧</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=provinzkraut" title="Documentation">📖</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=provinzkraut" title="Tests">⚠️</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=provinzkraut" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://schutt.io"><img src="https://avatars.githubusercontent.com/u/20659309?v=4?s=100" width="100px;" alt="Peter Schutt"/><br /><sub><b>Peter Schutt</b></sub></a><br /><a href="#maintenance-peterschutt" title="Maintenance">🚧</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=peterschutt" title="Tests">⚠️</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=peterschutt" title="Code">💻</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=peterschutt" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://czaplicki.it/"><img src="https://avatars.githubusercontent.com/u/9108586?v=4?s=100" width="100px;" alt="Marek Czaplicki"/><br /><sub><b>Marek Czaplicki</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=mdczaplicki" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/przybylop"><img src="https://avatars.githubusercontent.com/u/82805821?v=4?s=100" width="100px;" alt="Piotr Przybyło"/><br /><sub><b>Piotr Przybyło</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=przybylop" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/sygutss"><img src="https://avatars.githubusercontent.com/u/48909366?v=4?s=100" width="100px;" alt="sygutss"/><br /><sub><b>sygutss</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/issues?q=author%3Asygutss" title="Bug reports">🐛</a> <a href="https://github.com/litestar-org/polyfactory/commits?author=sygutss" title="Code">💻</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/chrisbeardy"><img src="https://avatars.githubusercontent.com/u/20585410?v=4?s=100" width="100px;" alt="chrisbeardy"/><br /><sub><b>chrisbeardy</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=chrisbeardy" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/guacs"><img src="https://avatars.githubusercontent.com/u/126393040?v=4?s=100" width="100px;" alt="guacs"/><br /><sub><b>guacs</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=guacs" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/VSHUMILIN97"><img src="https://avatars.githubusercontent.com/u/27234763?v=4?s=100" width="100px;" alt="Vadim"/><br /><sub><b>Vadim</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=VSHUMILIN97" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Simske"><img src="https://avatars.githubusercontent.com/u/2445660?v=4?s=100" width="100px;" alt="Simske"/><br /><sub><b>Simske</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=Simske" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/sondrelg"><img src="https://avatars.githubusercontent.com/u/25310870?v=4?s=100" width="100px;" alt="Sondre Lillebø Gundersen"/><br /><sub><b>Sondre Lillebø Gundersen</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=sondrelg" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://mciszczon.pl/"><img src="https://avatars.githubusercontent.com/u/1078369?v=4?s=100" width="100px;" alt="Mateusz Ciszczoń"/><br /><sub><b>Mateusz Ciszczoń</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=mciszczon" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/pedro-bernardes/"><img src="https://avatars.githubusercontent.com/u/18899993?v=4?s=100" width="100px;" alt="Pedro Bernardes"/><br /><sub><b>Pedro Bernardes</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=phbernardes" title="Code">💻</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/lindycoder"><img src="https://avatars.githubusercontent.com/u/12926519?v=4?s=100" width="100px;" alt="Martin Roy"/><br /><sub><b>Martin Roy</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=lindycoder" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://matthewtyleraylward.com"><img src="https://avatars.githubusercontent.com/u/19205392?v=4?s=100" width="100px;" alt="Matthew Aylward "/><br /><sub><b>Matthew Aylward </b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=Butch78" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/EltonChou"><img src="https://avatars.githubusercontent.com/u/12560310?v=4?s=100" width="100px;" alt="Elton H.Y. Chou"/><br /><sub><b>Elton H.Y. Chou</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=EltonChou" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/nguyent"><img src="https://avatars.githubusercontent.com/u/576848?v=4?s=100" width="100px;" alt="Thang"/><br /><sub><b>Thang</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=nguyent" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/DaanRademaker"><img src="https://avatars.githubusercontent.com/u/29598493?v=4?s=100" width="100px;" alt="Daan"/><br /><sub><b>Daan</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=DaanRademaker" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://lyz-code.github.io/blue-book/"><img src="https://avatars.githubusercontent.com/u/24810987?v=4?s=100" width="100px;" alt="Lyz"/><br /><sub><b>Lyz</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=lyz-code" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://portfolio.schiffer.pro/"><img src="https://avatars.githubusercontent.com/u/3502492?v=4?s=100" width="100px;" alt="Thorin Schiffer"/><br /><sub><b>Thorin Schiffer</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=thorin-schiffer" title="Code">💻</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/Iipin"><img src="https://avatars.githubusercontent.com/u/52832022?v=4?s=100" width="100px;" alt="Iipin"/><br /><sub><b>Iipin</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=Iipin" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/avihai-yosef"><img src="https://avatars.githubusercontent.com/u/79567307?v=4?s=100" width="100px;" alt="avihai-yosef"/><br /><sub><b>avihai-yosef</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=avihai-yosef" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/anthonyh209"><img src="https://avatars.githubusercontent.com/u/33107540?v=4?s=100" width="100px;" alt="anthonyh209"/><br /><sub><b>anthonyh209</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=anthonyh209" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://linkedin.com/in/roman-reznikov"><img src="https://avatars.githubusercontent.com/u/44291988?v=4?s=100" width="100px;" alt="Roman Reznikov"/><br /><sub><b>Roman Reznikov</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=ReznikovRoman" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/gigelu"><img src="https://avatars.githubusercontent.com/u/270697?v=4?s=100" width="100px;" alt="gigelu"/><br /><sub><b>gigelu</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=gigelu" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/roeeyn"><img src="https://avatars.githubusercontent.com/u/13385000?v=4?s=100" width="100px;" alt="Rodrigo Medina"/><br /><sub><b>Rodrigo Medina</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=roeeyn" title="Code">💻</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://gerritegnew.info/"><img src="https://avatars.githubusercontent.com/u/35822787?v=4?s=100" width="100px;" alt="Gerrit Egnew"/><br /><sub><b>Gerrit Egnew</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=gegnew" title="Code">💻</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/danielkatzan"><img src="https://avatars.githubusercontent.com/u/9249066?v=4?s=100" width="100px;" alt="danielkatzan"/><br /><sub><b>danielkatzan</b></sub></a><br /><a href="https://github.com/litestar-org/polyfactory/commits?author=danielkatzan" title="Documentation">📖</a></td>
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
Contributions of any kind welcome!
python-polyfactory-2.21.0/docs/__init__.py 0000664 0000000 0000000 00000000000 15000423051 0020503 0 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/_static/ 0000775 0000000 0000000 00000000000 15000423051 0020032 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/_static/logo.svg 0000664 0000000 0000000 00000007640 15000423051 0021522 0 ustar 00root root 0000000 0000000 <svg xmlns="http://www.w3.org/2000/svg" width="500" zoomAndPan="magnify" viewBox="0 0 375 374.999991" height="500"
preserveAspectRatio="xMidYMid meet" version="1.0">
<defs>
<clipPath id="9eb7762d41">
<path d="M 15.933594 105 L 328 105 L 328 259 L 15.933594 259 Z M 15.933594 105 " clip-rule="nonzero"/>
</clipPath>
<clipPath id="183d3cc178">
<path d="M 142 78.769531 L 359.433594 78.769531 L 359.433594 296.269531 L 142 296.269531 Z M 142 78.769531 "
clip-rule="nonzero"/>
</clipPath>
</defs>
<g clip-path="url(#9eb7762d41)">
<path fill="#edb641"
d="M 147.625 240.3125 C 161.5 233.984375 173.554688 227.011719 183.425781 220.550781 C 202.304688 208.203125 226.4375 185.242188 227.761719 183.410156 L 218.917969 177.503906 L 211.257812 172.386719 L 235.503906 171.441406 L 243.296875 171.136719 L 245.414062 163.640625 L 252.007812 140.304688 L 260.402344 163.054688 L 263.097656 170.363281 L 270.890625 170.058594 L 295.136719 169.113281 L 276.078125 184.117188 L 269.953125 188.9375 L 272.652344 196.25 L 281.046875 218.996094 L 260.871094 205.523438 L 254.390625 201.195312 L 248.265625 206.015625 L 229.207031 221.023438 L 232.480469 209.425781 L 235.796875 197.691406 L 236.207031 196.234375 C 213.003906 213.585938 180.546875 230.304688 161.140625 236.488281 C 156.6875 237.90625 152.183594 239.179688 147.625 240.3125 Z M 101.992188 258.078125 C 136.382812 256.734375 177.355469 248 217.675781 222.363281 L 209.90625 249.867188 L 254.910156 214.4375 L 302.539062 246.246094 L 282.71875 192.539062 L 327.71875 157.109375 L 270.46875 159.34375 L 250.648438 105.636719 L 235.085938 160.726562 L 177.835938 162.964844 L 210.980469 185.097656 C 189.164062 204.921875 134.445312 247.195312 61.957031 250.03125 C 47.300781 250.601562 31.914062 249.558594 15.933594 246.394531 C 15.933594 246.394531 52.011719 260.035156 101.992188 258.078125 "
fill-opacity="1" fill-rule="nonzero"/>
</g>
<g clip-path="url(#183d3cc178)">
<path fill="#edb641"
d="M 250.789062 78.96875 C 190.78125 78.96875 142.140625 127.570312 142.140625 187.519531 C 142.140625 198.875 143.886719 209.816406 147.121094 220.101562 C 151.847656 217.75 156.363281 215.316406 160.660156 212.84375 C 158.394531 204.789062 157.183594 196.296875 157.183594 187.519531 C 157.183594 135.871094 199.089844 93.996094 250.789062 93.996094 C 302.484375 93.996094 344.390625 135.871094 344.390625 187.519531 C 344.390625 239.171875 302.484375 281.042969 250.789062 281.042969 C 222.75 281.042969 197.597656 268.722656 180.441406 249.210938 C 175.453125 251.152344 170.402344 252.917969 165.289062 254.511719 C 185.183594 279.816406 216.082031 296.070312 250.789062 296.070312 C 310.792969 296.070312 359.433594 247.472656 359.433594 187.519531 C 359.433594 127.570312 310.792969 78.96875 250.789062 78.96875 "
fill-opacity="1" fill-rule="nonzero"/>
</g>
<path fill="#edb641"
d="M 92.292969 173.023438 L 98.289062 191.460938 L 117.691406 191.460938 L 101.992188 202.855469 L 107.988281 221.292969 L 92.292969 209.898438 L 76.59375 221.292969 L 82.589844 202.855469 L 66.894531 191.460938 L 86.296875 191.460938 L 92.292969 173.023438 "
fill-opacity="1" fill-rule="nonzero"/>
<path fill="#edb641"
d="M 120.214844 112.25 L 125.390625 128.167969 L 142.140625 128.167969 L 128.589844 138 L 133.765625 153.917969 L 120.214844 144.082031 L 106.664062 153.917969 L 111.839844 138 L 98.289062 128.167969 L 115.039062 128.167969 L 120.214844 112.25 "
fill-opacity="1" fill-rule="nonzero"/>
<path fill="#edb641"
d="M 34.695312 209.136719 L 37.71875 218.421875 L 47.492188 218.421875 L 39.585938 224.160156 L 42.605469 233.449219 L 34.695312 227.707031 L 26.792969 233.449219 L 29.8125 224.160156 L 21.90625 218.421875 L 31.679688 218.421875 L 34.695312 209.136719 "
fill-opacity="1" fill-rule="nonzero"/>
</svg>
python-polyfactory-2.21.0/docs/changelog.rst 0000664 0000000 0000000 00000364354 15000423051 0021104 0 ustar 00root root 0000000 0000000 =========
Changelog
=========
All commits to this project will be documented in this file.
`Release [v2.21.0] - 2025-04-18 <https://github.com/litestar-org/polyfactory/releases/tag/v2.21.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.21.0 <https://github.com/litestar-org/polyfactory/commits/v2.21.0>`_
`0facd26 <https://github.com/litestar-org/polyfactory/commit/0facd26ec2e8915e1769e90ffb55ccccd60aadc5>`_ ... `02fed72 <https://github.com/litestar-org/polyfactory/commit/02fed7258c5b522891a0b8cdbd0491d21bc9bd95>`_ | `See diff for 2.21.0 <https://github.com/litestar-org/polyfactory/compare/0facd26ec2e8915e1769e90ffb55ccccd60aadc5...02fed7258c5b522891a0b8cdbd0491d21bc9bd95>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`4ae69c8 <https://github.com/litestar-org/polyfactory/commit/4ae69c81c61e70269c004794abf3abca31700e87>`_) - Handle pydantic v1 URL and email correctly (#685) by `@Xdynix <https://github.com/Xdynix>`_ in `#685 <https://github.com/litestar-org/polyfactory/pull/685>`_
* (`18d8579 <https://github.com/litestar-org/polyfactory/commit/18d857966c2049f9705351f276370c7a4e38c0d5>`_) - Make type alias detection work with typing_extensions 4.13 (#684) by `@airwoodix <https://github.com/airwoodix>`_ in `#684 <https://github.com/litestar-org/polyfactory/pull/684>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`9940230 <https://github.com/litestar-org/polyfactory/commit/9940230d3b1958f6f0b14e3157dcdd137af40cea>`_) - Document overriding SQLA column mapping (#671) by `@adhtruong <https://github.com/adhtruong>`_ in `#671 <https://github.com/litestar-org/polyfactory/pull/671>`_
* (`cc789b5 <https://github.com/litestar-org/polyfactory/commit/cc789b55298e6e160f8d14877c7ea5859d72ee4d>`_) - Support new type and annotated mapping (#680) by `@adhtruong <https://github.com/adhtruong>`_ in `#680 <https://github.com/litestar-org/polyfactory/pull/680>`_
* (`36395d9 <https://github.com/litestar-org/polyfactory/commit/36395d94a3a325c3f7db51fc71f0ef9c2edb3f3d>`_) - Issue 678 use pydantic field examples (#679) by `@stardust85 <https://github.com/stardust85>`_ in `#679 <https://github.com/litestar-org/polyfactory/pull/679>`_
* (`02fed72 <https://github.com/litestar-org/polyfactory/commit/02fed7258c5b522891a0b8cdbd0491d21bc9bd95>`_) - Add release command (#687) by `@adhtruong <https://github.com/adhtruong>`_ in `#687 <https://github.com/litestar-org/polyfactory/pull/687>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`e0c6941 <https://github.com/litestar-org/polyfactory/commit/e0c6941d3fdf89038484bfe62b80485b897ca439>`_) - Remove sonar (#672) by `@adhtruong <https://github.com/adhtruong>`_ in `#672 <https://github.com/litestar-org/polyfactory/pull/672>`_
Refactor
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`00aa862 <https://github.com/litestar-org/polyfactory/commit/00aa862cf96174b4fb845e95afeb0e440f1679ee>`_) - Deprecate FieldMeta.random (#663) by `@adhtruong <https://github.com/adhtruong>`_ in `#663 <https://github.com/litestar-org/polyfactory/pull/663>`_
* (`ade1115 <https://github.com/litestar-org/polyfactory/commit/ade1115b20bb61da698cb2e1561b38a8de20fca3>`_) - Migrate to typos (#675) by `@adhtruong <https://github.com/adhtruong>`_ in `#675 <https://github.com/litestar-org/polyfactory/pull/675>`_
Ci
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`c42bf6d <https://github.com/litestar-org/polyfactory/commit/c42bf6dd4aaa2b3625b7dc7d2873bbd5b0a7a70d>`_) - Add toml formatter (#682) by `@adhtruong <https://github.com/adhtruong>`_ in `#682 <https://github.com/litestar-org/polyfactory/pull/682>`_
`Release [v2.20.0] - 2025-03-21 <https://github.com/litestar-org/polyfactory/releases/tag/v2.20.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.20.0 <https://github.com/litestar-org/polyfactory/commits/v2.20.0>`_
`de78949 <https://github.com/litestar-org/polyfactory/commit/de789499f8b16b49c9fae5954cfba8ad868fff58>`_ ... `0facd26 <https://github.com/litestar-org/polyfactory/commit/0facd26ec2e8915e1769e90ffb55ccccd60aadc5>`_ | `See diff for 2.20.0 <https://github.com/litestar-org/polyfactory/compare/de789499f8b16b49c9fae5954cfba8ad868fff58...0facd26ec2e8915e1769e90ffb55ccccd60aadc5>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`64fa119 <https://github.com/litestar-org/polyfactory/commit/64fa119f7caa2d8c616e3dc2c50ae9c232616351>`_) - Allow non-hashable type args (#643) by `@adhtruong <https://github.com/adhtruong>`_ in `#643 <https://github.com/litestar-org/polyfactory/pull/643>`_
* (`703aa2e <https://github.com/litestar-org/polyfactory/commit/703aa2ef2d2b2489b0c817f6f0d9e75714e1069b>`_) - Dont allow faker version less then 5.0.0 (#646) by `@T0nd0Tara <https://github.com/T0nd0Tara>`_ in `#646 <https://github.com/litestar-org/polyfactory/pull/646>`_
* (`e4a27ca <https://github.com/litestar-org/polyfactory/commit/e4a27cab597f60f142210eaca66a3f97188810f0>`_) - Added a generate function to support SQL Numeric field (#636) by `@nisemenov <https://github.com/nisemenov>`_ in `#636 <https://github.com/litestar-org/polyfactory/pull/636>`_
* (`da6ad4d <https://github.com/litestar-org/polyfactory/commit/da6ad4d213aec4447e9b3b257ab5fed392f445ae>`_) - Ignore dataclass types in pydantic field parsing (#660) by `@adhtruong <https://github.com/adhtruong>`_ in `#660 <https://github.com/litestar-org/polyfactory/pull/660>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`3c1e68f <https://github.com/litestar-org/polyfactory/commit/3c1e68ffbfa59d0ed9b9cc41d9b9a17654b841e4>`_) - Add nisemenov as a contributor for code, and doc (#633) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#633 <https://github.com/litestar-org/polyfactory/pull/633>`_
* (`beab66c <https://github.com/litestar-org/polyfactory/commit/beab66cf39a8bf67e3a1ac41cde30ee27ee08be1>`_) - Add iloveitaly as a contributor for code, and doc (#662) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#662 <https://github.com/litestar-org/polyfactory/pull/662>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`8c1fe02 <https://github.com/litestar-org/polyfactory/commit/8c1fe0293a525fdd20aaadbbf09f8a31dffcdaf8>`_) - Described an ability to use async data in factory fields; refactored factories/base and some tests (#641) by `@nisemenov <https://github.com/nisemenov>`_ in `#641 <https://github.com/litestar-org/polyfactory/pull/641>`_
* (`ba7cd3f <https://github.com/litestar-org/polyfactory/commit/ba7cd3f382140523d61b35c9ed572c74d8c1ef9f>`_) - Simplify pytest plugin (#652) by `@adhtruong <https://github.com/adhtruong>`_ in `#652 <https://github.com/litestar-org/polyfactory/pull/652>`_
* (`b98ae5d <https://github.com/litestar-org/polyfactory/commit/b98ae5d1c50d24748903e65a8d3b1674f1043f2c>`_) - Improve create factory typing (#657) by `@adhtruong <https://github.com/adhtruong>`_ in `#657 <https://github.com/litestar-org/polyfactory/pull/657>`_
* (`33c72e7 <https://github.com/litestar-org/polyfactory/commit/33c72e7bcd1388756a2235e4d75b74fe0de16d27>`_) - Add_providers to easily add new type provider (#659) by `@iloveitaly <https://github.com/iloveitaly>`_ in `#659 <https://github.com/litestar-org/polyfactory/pull/659>`_
* (`0b5df15 <https://github.com/litestar-org/polyfactory/commit/0b5df15bd324a7ac2079947dd600e899f2b10798>`_) - Improve random range (#653) by `@adhtruong <https://github.com/adhtruong>`_ in `#653 <https://github.com/litestar-org/polyfactory/pull/653>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`f5cb818 <https://github.com/litestar-org/polyfactory/commit/f5cb818314bf4887f2caab2c3961d1dd886b68cc>`_) - Bump dawidd6/action-download-artifact from 7 to 9 (#651) by `@dependabot[bot] <https://github.com/dependabot[bot]>`_ in `#651 <https://github.com/litestar-org/polyfactory/pull/651>`_
* (`1c56f09 <https://github.com/litestar-org/polyfactory/commit/1c56f09692214cefcfcd3bc29ba9b74fc18a940f>`_) - Bump codecov/codecov-action from 4 to 5 (#620) by `@dependabot[bot] <https://github.com/dependabot[bot]>`_ in `#620 <https://github.com/litestar-org/polyfactory/pull/620>`_
* (`516dd6d <https://github.com/litestar-org/polyfactory/commit/516dd6d280ee35afda068c7ecaa0d672daf971d1>`_) - Improve test imports (#661) by `@adhtruong <https://github.com/adhtruong>`_ in `#661 <https://github.com/litestar-org/polyfactory/pull/661>`_
* (`0facd26 <https://github.com/litestar-org/polyfactory/commit/0facd26ec2e8915e1769e90ffb55ccccd60aadc5>`_) - Prep 2.20.0 release (#669) by `@adhtruong <https://github.com/adhtruong>`_ in `#669 <https://github.com/litestar-org/polyfactory/pull/669>`_
Build
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`34182d4 <https://github.com/litestar-org/polyfactory/commit/34182d439d5d5f1f1964a961c028859e3b404851>`_) - Update dependencies and ignores (#648) by `@adhtruong <https://github.com/adhtruong>`_ in `#648 <https://github.com/litestar-org/polyfactory/pull/648>`_
* (`396b555 <https://github.com/litestar-org/polyfactory/commit/396b5559ec2a2bbf7818dd15a75b556c18849183>`_) - Update pyright (#665) by `@adhtruong <https://github.com/adhtruong>`_ in `#665 <https://github.com/litestar-org/polyfactory/pull/665>`_
`Release [v2.19.0] - 2025-01-29 <https://github.com/litestar-org/polyfactory/releases/tag/v2.19.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.19.0 <https://github.com/litestar-org/polyfactory/commits/v2.19.0>`_
`0290580 <https://github.com/litestar-org/polyfactory/commit/029058005ff9681f5b9f3e2adf2030dfb40d21d5>`_ ... `de78949 <https://github.com/litestar-org/polyfactory/commit/de789499f8b16b49c9fae5954cfba8ad868fff58>`_ | `See diff for 2.19.0 <https://github.com/litestar-org/polyfactory/compare/029058005ff9681f5b9f3e2adf2030dfb40d21d5...de789499f8b16b49c9fae5954cfba8ad868fff58>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`e1c5b8c <https://github.com/litestar-org/polyfactory/commit/e1c5b8c9f2c63604a3856937e772b4081c77ca90>`_) - Lock PDM version to support 3.8 (#609) by `@adhtruong <https://github.com/adhtruong>`_ in `#609 <https://github.com/litestar-org/polyfactory/pull/609>`_
* (`f526601 <https://github.com/litestar-org/polyfactory/commit/f526601b080479963d431d36545c129be47ad161>`_) - Pydantic 2.10 compatibility (#613) by `@adhtruong <https://github.com/adhtruong>`_ in `#613 <https://github.com/litestar-org/polyfactory/pull/613>`_
* (`1e0c847 <https://github.com/litestar-org/polyfactory/commit/1e0c847deb762a8305edaf03a6e0a2a1e86a266e>`_) - Update security alert (#615) by `@adhtruong <https://github.com/adhtruong>`_ in `#615 <https://github.com/litestar-org/polyfactory/pull/615>`_
* (`135bbc0 <https://github.com/litestar-org/polyfactory/commit/135bbc03370212729350fd098b5d0a1cb227f388>`_) - Ensure ABC are not considered a factory type (#628) by `@adhtruong <https://github.com/adhtruong>`_ in `#628 <https://github.com/litestar-org/polyfactory/pull/628>`_
* (`137bfb9 <https://github.com/litestar-org/polyfactory/commit/137bfb9cb4f50b4b4397949bbf80b86a52483029>`_) - Added an async context manager in SQLAASyncPersistence (#630) by `@nisemenov <https://github.com/nisemenov>`_ in `#630 <https://github.com/litestar-org/polyfactory/pull/630>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`42999fa <https://github.com/litestar-org/polyfactory/commit/42999fa015d70bae78ad67f7af160b6be2c2a90e>`_) - Added __set_association_proxy__ attribute (#629) by `@nisemenov <https://github.com/nisemenov>`_ in `#629 <https://github.com/litestar-org/polyfactory/pull/629>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`d6a886a <https://github.com/litestar-org/polyfactory/commit/d6a886a4f3b33c77774e14ec190531128ce504c2>`_) - Bump astral-sh/setup-uv from 4 to 5 (#622) by `@dependabot[bot] <https://github.com/dependabot[bot]>`_ in `#622 <https://github.com/litestar-org/polyfactory/pull/622>`_
* (`9db2ee7 <https://github.com/litestar-org/polyfactory/commit/9db2ee726592c8b24b853e5f1d9c22df016be5c3>`_) - Bump dawidd6/action-download-artifact from 3 to 7 (#619) by `@dependabot[bot] <https://github.com/dependabot[bot]>`_ in `#619 <https://github.com/litestar-org/polyfactory/pull/619>`_
* (`de78949 <https://github.com/litestar-org/polyfactory/commit/de789499f8b16b49c9fae5954cfba8ad868fff58>`_) - Prep 2.19.0 release (#637) by `@adhtruong <https://github.com/adhtruong>`_ in `#637 <https://github.com/litestar-org/polyfactory/pull/637>`_
Refactor
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`a7dda85 <https://github.com/litestar-org/polyfactory/commit/a7dda85319bcefa0df4aef9fc75e6c0813cd7596>`_) - Update Pydantic imports (#625) by `@adhtruong <https://github.com/adhtruong>`_ in `#625 <https://github.com/litestar-org/polyfactory/pull/625>`_
Build
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`9ee5852 <https://github.com/litestar-org/polyfactory/commit/9ee585214ea916751e48e36ac52dad6169d82519>`_) - Update pre-commit dependencies (#614) by `@adhtruong <https://github.com/adhtruong>`_ in `#614 <https://github.com/litestar-org/polyfactory/pull/614>`_
* (`9fa4ad9 <https://github.com/litestar-org/polyfactory/commit/9fa4ad913dcbef60440f1c5022581ef352c7cceb>`_) - Migrate to uv (#612) by `@adhtruong <https://github.com/adhtruong>`_ in `#612 <https://github.com/litestar-org/polyfactory/pull/612>`_
* (`d374de5 <https://github.com/litestar-org/polyfactory/commit/d374de52a6524a0eb3126483f6ea25812df59566>`_) - Support 3.13 (#599) by `@adhtruong <https://github.com/adhtruong>`_ in `#599 <https://github.com/litestar-org/polyfactory/pull/599>`_
* (`d2ef554 <https://github.com/litestar-org/polyfactory/commit/d2ef5549a20da966a992f96145d2a46bd4f3d570>`_) - Change deprecated action (#626) by `@adhtruong <https://github.com/adhtruong>`_ in `#626 <https://github.com/litestar-org/polyfactory/pull/626>`_
`Release [v2.18.1] - 2024-11-26 <https://github.com/litestar-org/polyfactory/releases/tag/v2.18.1>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.18.1 <https://github.com/litestar-org/polyfactory/commits/v2.18.1>`_
`f7b5d8b <https://github.com/litestar-org/polyfactory/commit/f7b5d8bb9410d40dc6073d9ca7f2cdec878bc419>`_ ... `0290580 <https://github.com/litestar-org/polyfactory/commit/029058005ff9681f5b9f3e2adf2030dfb40d21d5>`_ | `See diff for 2.18.1 <https://github.com/litestar-org/polyfactory/compare/f7b5d8bb9410d40dc6073d9ca7f2cdec878bc419...029058005ff9681f5b9f3e2adf2030dfb40d21d5>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`660183b <https://github.com/litestar-org/polyfactory/commit/660183b5f90d4969576baa2be19a9cf70b3d0d1c>`_) - Handle nullable SQLA constraints (#602) by `@adhtruong <https://github.com/adhtruong>`_ in `#602 <https://github.com/litestar-org/polyfactory/pull/602>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`0290580 <https://github.com/litestar-org/polyfactory/commit/029058005ff9681f5b9f3e2adf2030dfb40d21d5>`_) - Bump release version (#608) by `@adhtruong <https://github.com/adhtruong>`_ in `#608 <https://github.com/litestar-org/polyfactory/pull/608>`_
`Release [v2.18.0] - 2024-11-06 <https://github.com/litestar-org/polyfactory/releases/tag/v2.18.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.18.0 <https://github.com/litestar-org/polyfactory/commits/v2.18.0>`_
`37a9894 <https://github.com/litestar-org/polyfactory/commit/37a9894a52c1188a927c8c9cb5b4485b73d062c3>`_ ... `f7b5d8b <https://github.com/litestar-org/polyfactory/commit/f7b5d8bb9410d40dc6073d9ca7f2cdec878bc419>`_ | `See diff for 2.18.0 <https://github.com/litestar-org/polyfactory/compare/37a9894a52c1188a927c8c9cb5b4485b73d062c3...f7b5d8bb9410d40dc6073d9ca7f2cdec878bc419>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`c027bbd <https://github.com/litestar-org/polyfactory/commit/c027bbd1c1ff990e02c19cac7d67851c17853469>`_) - Update docs preview upload (#597) by `@adhtruong <https://github.com/adhtruong>`_ in `#597 <https://github.com/litestar-org/polyfactory/pull/597>`_
* (`8d8f6a9 <https://github.com/litestar-org/polyfactory/commit/8d8f6a9b4b2ae525dc41539a88418aabdee1efd1>`_) - Add SQLA async to test dependencies (#595) by `@adhtruong <https://github.com/adhtruong>`_ in `#595 <https://github.com/litestar-org/polyfactory/pull/595>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`6abb845 <https://github.com/litestar-org/polyfactory/commit/6abb845ddcc673db3fac253a5084f4726f4f4263>`_) - Handle SQLA column constraints (#594) by `@adhtruong <https://github.com/adhtruong>`_ in `#594 <https://github.com/litestar-org/polyfactory/pull/594>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`f7b5d8b <https://github.com/litestar-org/polyfactory/commit/f7b5d8bb9410d40dc6073d9ca7f2cdec878bc419>`_) - Bump minor version by `@guacs <https://github.com/guacs>`_
`Release [v2.17.0] - 2024-09-22 <https://github.com/litestar-org/polyfactory/releases/tag/v2.17.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.17.0 <https://github.com/litestar-org/polyfactory/commits/v2.17.0>`_
`67c5720 <https://github.com/litestar-org/polyfactory/commit/67c57208de5ce993bdb2c7888864ac4e71964511>`_ ... `37a9894 <https://github.com/litestar-org/polyfactory/commit/37a9894a52c1188a927c8c9cb5b4485b73d062c3>`_ | `See diff for 2.17.0 <https://github.com/litestar-org/polyfactory/compare/67c57208de5ce993bdb2c7888864ac4e71964511...37a9894a52c1188a927c8c9cb5b4485b73d062c3>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`24701eb <https://github.com/litestar-org/polyfactory/commit/24701eb593493f7c038709b1327dbf6dd8942e87>`_) - Constrained 0 length lists (#570) by `@marcozzxx810 <https://github.com/marcozzxx810>`_ in `#570 <https://github.com/litestar-org/polyfactory/pull/570>`_
* (`6f5b78c <https://github.com/litestar-org/polyfactory/commit/6f5b78cc5ef3f0fb1037d17d06837af54aac586d>`_) - Use provider map for any in coverage (#574) by `@adhtruong <https://github.com/adhtruong>`_ in `#574 <https://github.com/litestar-org/polyfactory/pull/574>`_
* (`4aaf656 <https://github.com/litestar-org/polyfactory/commit/4aaf656baa5b612fa3b63c6047b653b9b785f60d>`_) - Tuple randomized length (#573) by `@adhtruong <https://github.com/adhtruong>`_ in `#573 <https://github.com/litestar-org/polyfactory/pull/573>`_
* (`9a83ad6 <https://github.com/litestar-org/polyfactory/commit/9a83ad6354d675b42eb514f9354e845490608ba6>`_) - Adjust min/max items to valid lengths for Set[Enum] fields (#567) by `@adrianeboyd <https://github.com/adrianeboyd>`_ in `#567 <https://github.com/litestar-org/polyfactory/pull/567>`_
* (`135d7fe <https://github.com/litestar-org/polyfactory/commit/135d7fea8d939a1fa8c87838d2b705db8968dccd>`_) - Handle Optional type recursive models (#584) by `@adhtruong <https://github.com/adhtruong>`_ in `#584 <https://github.com/litestar-org/polyfactory/pull/584>`_
* (`6440faa <https://github.com/litestar-org/polyfactory/commit/6440faa24abfc34c2d10e31797224f5aec2d43c0>`_) - Handle recursive collections (#587) by `@adhtruong <https://github.com/adhtruong>`_ in `#587 <https://github.com/litestar-org/polyfactory/pull/587>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`841831d <https://github.com/litestar-org/polyfactory/commit/841831d12f59a0825e490e71fdbc32744c433565>`_) - Swap word with its antonym to match the context (#575) by `@UncleGoogle <https://github.com/UncleGoogle>`_ in `#575 <https://github.com/litestar-org/polyfactory/pull/575>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`c0c2704 <https://github.com/litestar-org/polyfactory/commit/c0c27049afc9dd60395d5dd087f47ee700e1a6a7>`_) - Enhance register_fixture return type annotation (#581) by `@giulioindev <https://github.com/giulioindev>`_ in `#581 <https://github.com/litestar-org/polyfactory/pull/581>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`37a9894 <https://github.com/litestar-org/polyfactory/commit/37a9894a52c1188a927c8c9cb5b4485b73d062c3>`_) - Bump release version (#588) by `@adhtruong <https://github.com/adhtruong>`_ in `#588 <https://github.com/litestar-org/polyfactory/pull/588>`_
Build
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`d75b1d2 <https://github.com/litestar-org/polyfactory/commit/d75b1d2eee3c042b3bf1ea7b8c2b0b6a744df75d>`_) - Update pre-commit dependencies (#571) by `@adhtruong <https://github.com/adhtruong>`_ in `#571 <https://github.com/litestar-org/polyfactory/pull/571>`_
`Release [v2.16.2] - 2024-07-09 <https://github.com/litestar-org/polyfactory/releases/tag/v2.16.2>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.16.2 <https://github.com/litestar-org/polyfactory/commits/v2.16.2>`_
`23281ee <https://github.com/litestar-org/polyfactory/commit/23281eed6c596a7defdc022e8d595cb3f4d2f169>`_ ... `67c5720 <https://github.com/litestar-org/polyfactory/commit/67c57208de5ce993bdb2c7888864ac4e71964511>`_ | `See diff for 2.16.2 <https://github.com/litestar-org/polyfactory/compare/23281eed6c596a7defdc022e8d595cb3f4d2f169...67c57208de5ce993bdb2c7888864ac4e71964511>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`3bb97e0 <https://github.com/litestar-org/polyfactory/commit/3bb97e0672d7fadb8532a882e62922b135c81fec>`_) - Nested model in collection build context (#564) by `@sam-or <https://github.com/sam-or>`_ in `#564 <https://github.com/litestar-org/polyfactory/pull/564>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`67c5720 <https://github.com/litestar-org/polyfactory/commit/67c57208de5ce993bdb2c7888864ac4e71964511>`_) - Bump patch version by `@guacs <https://github.com/guacs>`_
`Release [v2.16.1] - 2024-07-08 <https://github.com/litestar-org/polyfactory/releases/tag/v2.16.1>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.16.1 <https://github.com/litestar-org/polyfactory/commits/v2.16.1>`_
`4928f07 <https://github.com/litestar-org/polyfactory/commit/4928f0735ad58adc63f093062b4938dfc5003ea9>`_ ... `23281ee <https://github.com/litestar-org/polyfactory/commit/23281eed6c596a7defdc022e8d595cb3f4d2f169>`_ | `See diff for 2.16.1 <https://github.com/litestar-org/polyfactory/compare/4928f0735ad58adc63f093062b4938dfc5003ea9...23281eed6c596a7defdc022e8d595cb3f4d2f169>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`86869c2 <https://github.com/litestar-org/polyfactory/commit/86869c231255f9269420039b35b3b2f3572a0255>`_) - Use provider map for generating value for 'Any' (#522) by `@guacs <https://github.com/guacs>`_ in `#522 <https://github.com/litestar-org/polyfactory/pull/522>`_
* (`cbe6dfc <https://github.com/litestar-org/polyfactory/commit/cbe6dfce14b1778cf2434a93addeb6936ce3c61b>`_) - Pydantic factory_use_construct is not propagated to the nested (#549) by `@Reskov <https://github.com/Reskov>`_ in `#549 <https://github.com/litestar-org/polyfactory/pull/549>`_
* (`b09bf64 <https://github.com/litestar-org/polyfactory/commit/b09bf64e56ac9bf32ba77b835abbc43ededabd9f>`_) - Send correct field_meta to avoid over nesting (#527) by `@Vegemash <https://github.com/Vegemash>`_ in `#527 <https://github.com/litestar-org/polyfactory/pull/527>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`740fd34 <https://github.com/litestar-org/polyfactory/commit/740fd345685df6b313f8a4e12e041129b4dcd2e1>`_) - Link to GitHub repo (#547) by `@Alc-Alc <https://github.com/Alc-Alc>`_ in `#547 <https://github.com/litestar-org/polyfactory/pull/547>`_
* (`c34e72e <https://github.com/litestar-org/polyfactory/commit/c34e72e96d0530293739442a48a679dc85ec33fa>`_) - Add Reskov as a contributor for code (#556) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#556 <https://github.com/litestar-org/polyfactory/pull/556>`_
* (`3320989 <https://github.com/litestar-org/polyfactory/commit/3320989ed73265861ec11d09be5c57ed8f06c03f>`_) - Add Vegemash as a contributor for code (#562) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#562 <https://github.com/litestar-org/polyfactory/pull/562>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`f8e9318 <https://github.com/litestar-org/polyfactory/commit/f8e93188b447b6c28ee4466da3a128f2edafc5bd>`_) - Migrate formatting to ruff (#554) by `@adhtruong <https://github.com/adhtruong>`_ in `#554 <https://github.com/litestar-org/polyfactory/pull/554>`_
* (`36a9cc1 <https://github.com/litestar-org/polyfactory/commit/36a9cc15d91d6a64e6aecf76757c10b11bc7a87c>`_) - Bump pydantic (#561) by `@Vegemash <https://github.com/Vegemash>`_ in `#561 <https://github.com/litestar-org/polyfactory/pull/561>`_
* (`23281ee <https://github.com/litestar-org/polyfactory/commit/23281eed6c596a7defdc022e8d595cb3f4d2f169>`_) - Bump patch version by `@guacs <https://github.com/guacs>`_
`Release [v2.16.0] - 2024-05-13 <https://github.com/litestar-org/polyfactory/releases/tag/v2.16.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.16.0 <https://github.com/litestar-org/polyfactory/commits/v2.16.0>`_
`1d1c7f9 <https://github.com/litestar-org/polyfactory/commit/1d1c7f9d02f9c7a8eb977dc0624bf5a045d55ddc>`_ ... `4928f07 <https://github.com/litestar-org/polyfactory/commit/4928f0735ad58adc63f093062b4938dfc5003ea9>`_ | `See diff for 2.16.0 <https://github.com/litestar-org/polyfactory/compare/1d1c7f9d02f9c7a8eb977dc0624bf5a045d55ddc...4928f0735ad58adc63f093062b4938dfc5003ea9>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`719495e <https://github.com/litestar-org/polyfactory/commit/719495e6dca5c6938975b6bc0456205d28e2c90d>`_) - Ignore non-columns types (#510) by `@adhtruong <https://github.com/adhtruong>`_ in `#510 <https://github.com/litestar-org/polyfactory/pull/510>`_
* (`bb04b4e <https://github.com/litestar-org/polyfactory/commit/bb04b4e81764289ba5a138c0b82faa73bb4e5257>`_) - Favour SA mapped type over impl type (#513) by `@adhtruong <https://github.com/adhtruong>`_ in `#513 <https://github.com/litestar-org/polyfactory/pull/513>`_
* (`0032b5e <https://github.com/litestar-org/polyfactory/commit/0032b5e962906239ecd4c4bd7276dc0d9e9f142d>`_) - Add footer to changelog generation by `@JacobCoffee <https://github.com/JacobCoffee>`_
* (`5fd7d6c <https://github.com/litestar-org/polyfactory/commit/5fd7d6c2bedb3c602e009618137c6ab215172625>`_) - Resolve mypy issues (#540) by `@adhtruong <https://github.com/adhtruong>`_ in `#540 <https://github.com/litestar-org/polyfactory/pull/540>`_
* (`9e6edab <https://github.com/litestar-org/polyfactory/commit/9e6edabd4ee5242c54f3ddb66e539a415da86901>`_) - Fix json type error and pg dialect default value e… (#542) by `@wangxin688 <https://github.com/wangxin688>`_ in `#542 <https://github.com/litestar-org/polyfactory/pull/542>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`01d1dbe <https://github.com/litestar-org/polyfactory/commit/01d1dbeb46cc722b075dba85cfd6bcb94505e65d>`_) - Apply organization theme (#533) by `@JacobCoffee <https://github.com/JacobCoffee>`_ in `#533 <https://github.com/litestar-org/polyfactory/pull/533>`_
* (`5a0a5be <https://github.com/litestar-org/polyfactory/commit/5a0a5bed4ddb679868d9365a5ffbcc6c3fed686c>`_) - Polyfactory landing page (#535) by `@JacobCoffee <https://github.com/JacobCoffee>`_ in `#535 <https://github.com/litestar-org/polyfactory/pull/535>`_
* (`2f781ee <https://github.com/litestar-org/polyfactory/commit/2f781eee7f06436661874a4e469c601bb0de6cd4>`_) - Add wangxin688 as a contributor for code (#544) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#544 <https://github.com/litestar-org/polyfactory/pull/544>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`1792c19 <https://github.com/litestar-org/polyfactory/commit/1792c19fc100b16b610902c19c90b2031420c57e>`_) - Support nested type in pg.array types and others (#530) by `@wangxin688 <https://github.com/wangxin688>`_ in `#530 <https://github.com/litestar-org/polyfactory/pull/530>`_
* (`013135c <https://github.com/litestar-org/polyfactory/commit/013135c17387e451d88a7b73157ad08333649112>`_) - Refresh object in async_session after commit to db (#541) by `@wangxin688 <https://github.com/wangxin688>`_ in `#541 <https://github.com/litestar-org/polyfactory/pull/541>`_
* (`e4695a7 <https://github.com/litestar-org/polyfactory/commit/e4695a7d16e1a63b7cce036ca653d839ea0104fb>`_) - Copy mutable args (#529) by `@adhtruong <https://github.com/adhtruong>`_ in `#529 <https://github.com/litestar-org/polyfactory/pull/529>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`fac9fba <https://github.com/litestar-org/polyfactory/commit/fac9fbad94f0a82a062bfdac11b2da19f906e32f>`_) - Upgrade dependencies (#517) by `@adhtruong <https://github.com/adhtruong>`_ in `#517 <https://github.com/litestar-org/polyfactory/pull/517>`_
* (`3da64f6 <https://github.com/litestar-org/polyfactory/commit/3da64f615056c8d2f11c6bfc55c86877a89c2414>`_) - Update changelog.rst (#537) by `@impaktor <https://github.com/impaktor>`_ in `#537 <https://github.com/litestar-org/polyfactory/pull/537>`_
* (`3e2d22c <https://github.com/litestar-org/polyfactory/commit/3e2d22c5bafc5ed984338be54c3eace3cacc720f>`_) - Update maintainer emails (#545) by `@guacs <https://github.com/guacs>`_ in `#545 <https://github.com/litestar-org/polyfactory/pull/545>`_
Ci
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`6507c6d <https://github.com/litestar-org/polyfactory/commit/6507c6d86094dbcf678083e3ce7d06a5b4dd2f60>`_) - Add codecov coverage, fix badges (#536) by `@JacobCoffee <https://github.com/JacobCoffee>`_ in `#536 <https://github.com/litestar-org/polyfactory/pull/536>`_
`Release [v2.15.0] - 2024-03-02 <https://github.com/litestar-org/polyfactory/releases/tag/v2.15.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.15.0 <https://github.com/litestar-org/polyfactory/commits/v2.15.0>`_
`b44c68b <https://github.com/litestar-org/polyfactory/commit/b44c68b0c1d8c253f828edbbfc88c3f39ec2fdca>`_ ... `1d1c7f9 <https://github.com/litestar-org/polyfactory/commit/1d1c7f9d02f9c7a8eb977dc0624bf5a045d55ddc>`_ | `See diff for 2.15.0 <https://github.com/litestar-org/polyfactory/compare/b44c68b0c1d8c253f828edbbfc88c3f39ec2fdca...1d1c7f9d02f9c7a8eb977dc0624bf5a045d55ddc>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`c4e3d91 <https://github.com/litestar-org/polyfactory/commit/c4e3d919368d158f839a6ea6278a28007fb7f5dc>`_) - Prefer ``sqlalchemy.type.impl`` if it exists (#502) by `@cofin <https://github.com/cofin>`_ in `#502 <https://github.com/litestar-org/polyfactory/pull/502>`_
* (`0f8f9e8 <https://github.com/litestar-org/polyfactory/commit/0f8f9e8d0dbd6156ef55d2d61dc6831c4e59c0b0>`_) - Handle constrained unions properly (#499) by `@guacs <https://github.com/guacs>`_ in `#499 <https://github.com/litestar-org/polyfactory/pull/499>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`61c8892 <https://github.com/litestar-org/polyfactory/commit/61c889229f40e9a454b4dbbaff3e620940ea99ad>`_) - Fix typo on use_defaults (#497) by `@TimDumol <https://github.com/TimDumol>`_ in `#497 <https://github.com/litestar-org/polyfactory/pull/497>`_
* (`9e34fa7 <https://github.com/litestar-org/polyfactory/commit/9e34fa7aa36acd104e61222dac1507bc1efeefd7>`_) - Add TimDumol as a contributor for doc (#498) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#498 <https://github.com/litestar-org/polyfactory/pull/498>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`46ecdc6 <https://github.com/litestar-org/polyfactory/commit/46ecdc67f998464d82cf834ff048376283e29ac8>`_) - Support Pydantic v1 and v2 simultaneously (#492) by `@guacs <https://github.com/guacs>`_ in `#492 <https://github.com/litestar-org/polyfactory/pull/492>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`1078230 <https://github.com/litestar-org/polyfactory/commit/10782304e0d835a5583e7360a4712fae76749c4a>`_) - Bump pdm-project/setup-pdm from 3 to 4 (#496) by `@dependabot[bot] <https://github.com/dependabot[bot]>`_ in `#496 <https://github.com/litestar-org/polyfactory/pull/496>`_
* (`1d1c7f9 <https://github.com/litestar-org/polyfactory/commit/1d1c7f9d02f9c7a8eb977dc0624bf5a045d55ddc>`_) - Release v2.15.0 by `@guacs <https://github.com/guacs>`_
Refactor
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`2acfdc6 <https://github.com/litestar-org/polyfactory/commit/2acfdc6ab96f3ecb504c9c89960198fc8a1effd9>`_) - Change order of imports for pydantic v1 (#509) by `@guacs <https://github.com/guacs>`_ in `#509 <https://github.com/litestar-org/polyfactory/pull/509>`_
Testing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`1ae2d52 <https://github.com/litestar-org/polyfactory/commit/1ae2d528b018ac4d6773b423f3ab8af8d91f4f7b>`_) - Refactor the tests to move tests to correct places (#495) by `@guacs <https://github.com/guacs>`_ in `#495 <https://github.com/litestar-org/polyfactory/pull/495>`_
`Release [v2.14.1] - 2024-01-20 <https://github.com/litestar-org/polyfactory/releases/tag/v2.14.1>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.14.1 <https://github.com/litestar-org/polyfactory/commits/v2.14.1>`_
`83f2992 <https://github.com/litestar-org/polyfactory/commit/83f299231d631e5a361a515616b0d88daa1d3fd7>`_ ... `b44c68b <https://github.com/litestar-org/polyfactory/commit/b44c68b0c1d8c253f828edbbfc88c3f39ec2fdca>`_ | `See diff for 2.14.1 <https://github.com/litestar-org/polyfactory/compare/83f299231d631e5a361a515616b0d88daa1d3fd7...b44c68b0c1d8c253f828edbbfc88c3f39ec2fdca>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`fa50e20 <https://github.com/litestar-org/polyfactory/commit/fa50e20a333b0778119c4256558e05088b26b5c4>`_) - Handle unions properly (#491) by `@guacs <https://github.com/guacs>`_ in `#491 <https://github.com/litestar-org/polyfactory/pull/491>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`b44c68b <https://github.com/litestar-org/polyfactory/commit/b44c68b0c1d8c253f828edbbfc88c3f39ec2fdca>`_) - Bump patch version by `@guacs <https://github.com/guacs>`_
`Release [v2.14.0] - 2024-01-19 <https://github.com/litestar-org/polyfactory/releases/tag/v2.14.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.14.0 <https://github.com/litestar-org/polyfactory/commits/v2.14.0>`_
`8dc8e1a <https://github.com/litestar-org/polyfactory/commit/8dc8e1a4594a75ad9a16e1b6f5041b6044fc4f51>`_ ... `83f2992 <https://github.com/litestar-org/polyfactory/commit/83f299231d631e5a361a515616b0d88daa1d3fd7>`_ | `See diff for 2.14.0 <https://github.com/litestar-org/polyfactory/compare/8dc8e1a4594a75ad9a16e1b6f5041b6044fc4f51...83f299231d631e5a361a515616b0d88daa1d3fd7>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`fb4e50a <https://github.com/litestar-org/polyfactory/commit/fb4e50acaa0796ed7164457c6c767c3351530a81>`_) - Add min version to typing-extensions (#471) by `@hsorsky <https://github.com/hsorsky>`_ in `#471 <https://github.com/litestar-org/polyfactory/pull/471>`_
* (`40538c9 <https://github.com/litestar-org/polyfactory/commit/40538c9a0a4e9ec72b6a8864fc4e6f1293715603>`_) - Set as default type for factory only if model is defined (#479) by `@guacs <https://github.com/guacs>`_ in `#479 <https://github.com/litestar-org/polyfactory/pull/479>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`c22633c <https://github.com/litestar-org/polyfactory/commit/c22633ccf76e0fa58bc53795dfedb78a6abfb807>`_) - Add hsorsky as a contributor for infra (#477) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#477 <https://github.com/litestar-org/polyfactory/pull/477>`_
* (`b9c2127 <https://github.com/litestar-org/polyfactory/commit/b9c212799a3144aa81b43a93f663d20e4d3036ab>`_) - Fix broken uri (#485) by `@wer153 <https://github.com/wer153>`_ in `#485 <https://github.com/litestar-org/polyfactory/pull/485>`_
* (`8f96365 <https://github.com/litestar-org/polyfactory/commit/8f963653a949ae8e5b768473bb654a989b4416fe>`_) - Add wer153 as a contributor for doc (#486) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#486 <https://github.com/litestar-org/polyfactory/pull/486>`_
* (`7ec9eb0 <https://github.com/litestar-org/polyfactory/commit/7ec9eb010a1fae8db5807ae4f1934771909e3a38>`_) - Fix code block (#484) by `@wer153 <https://github.com/wer153>`_ in `#484 <https://github.com/litestar-org/polyfactory/pull/484>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`b33e662 <https://github.com/litestar-org/polyfactory/commit/b33e6621ee6add4fdd2e327834401830f6771d4b>`_) - Allow use of the default value based on configuration (#472) by `@guacs <https://github.com/guacs>`_ in `#472 <https://github.com/litestar-org/polyfactory/pull/472>`_
* (`80bd012 <https://github.com/litestar-org/polyfactory/commit/80bd012fbfb3d22e087dafd68173e633ec727175>`_) - Add recursion guard (#468) by `@adhtruong <https://github.com/adhtruong>`_ in `#468 <https://github.com/litestar-org/polyfactory/pull/468>`_
* (`c7556e8 <https://github.com/litestar-org/polyfactory/commit/c7556e8e5eafaebfdc0dded747ae4e8a144b7cc7>`_) - Pass on factory config (#483) by `@adhtruong <https://github.com/adhtruong>`_ in `#483 <https://github.com/litestar-org/polyfactory/pull/483>`_
* (`94ad561 <https://github.com/litestar-org/polyfactory/commit/94ad5611772e2bed977b693a030f517b3567a6ea>`_) - Support type alias (#487) by `@adhtruong <https://github.com/adhtruong>`_ in `#487 <https://github.com/litestar-org/polyfactory/pull/487>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`bb433a4 <https://github.com/litestar-org/polyfactory/commit/bb433a4291ede8147858585ebf0cff9c7cc53eb1>`_) - Update pre commit (#478) by `@guacs <https://github.com/guacs>`_ in `#478 <https://github.com/litestar-org/polyfactory/pull/478>`_
* (`2b57706 <https://github.com/litestar-org/polyfactory/commit/2b57706fbd4b9120d5a31643e51098cac65df1da>`_) - Bump actions/cache from 3 to 4 (#488) by `@dependabot[bot] <https://github.com/dependabot[bot]>`_ in `#488 <https://github.com/litestar-org/polyfactory/pull/488>`_
* (`83f2992 <https://github.com/litestar-org/polyfactory/commit/83f299231d631e5a361a515616b0d88daa1d3fd7>`_) - Bump minor version by `@guacs <https://github.com/guacs>`_
`Release [v2.13.0] - 2023-12-19 <https://github.com/litestar-org/polyfactory/releases/tag/v2.13.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.13.0 <https://github.com/litestar-org/polyfactory/commits/v2.13.0>`_
`fe05c4e <https://github.com/litestar-org/polyfactory/commit/fe05c4e60a50d8f043e4d1dbee5ea0a0c4d9abd8>`_ ... `8dc8e1a <https://github.com/litestar-org/polyfactory/commit/8dc8e1a4594a75ad9a16e1b6f5041b6044fc4f51>`_ | `See diff for 2.13.0 <https://github.com/litestar-org/polyfactory/compare/fe05c4e60a50d8f043e4d1dbee5ea0a0c4d9abd8...8dc8e1a4594a75ad9a16e1b6f5041b6044fc4f51>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`b479e4a <https://github.com/litestar-org/polyfactory/commit/b479e4af4617d108cbd90890cbda4408ee51ba4a>`_) - Flatten_annotation behaviour for Optional (#440) by `@sam-or <https://github.com/sam-or>`_ in `#440 <https://github.com/litestar-org/polyfactory/pull/440>`_
* (`6961eaa <https://github.com/litestar-org/polyfactory/commit/6961eaa3b65fc63b716e854bd2eb28b5bc96e029>`_) - Don't blindly suppress ValueError (#450) by `@guacs <https://github.com/guacs>`_ in `#450 <https://github.com/litestar-org/polyfactory/pull/450>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`623d8c9 <https://github.com/litestar-org/polyfactory/commit/623d8c97c2a178cc9721fa7b562ce2aee3eddea2>`_) - Optional ``__model__`` type (#452) by `@Mityuha <https://github.com/Mityuha>`_ in `#452 <https://github.com/litestar-org/polyfactory/pull/452>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`1407f07 <https://github.com/litestar-org/polyfactory/commit/1407f07fed3223a11f89b8b9d0019d581f08c1d3>`_) - Bump actions/github-script from 6 to 7 (#438) by `@dependabot[bot] <https://github.com/dependabot[bot]>`_ in `#438 <https://github.com/litestar-org/polyfactory/pull/438>`_
* (`1a0da0d <https://github.com/litestar-org/polyfactory/commit/1a0da0df63d694525ecd19ef990495f5765ba1ba>`_) - Bump actions/setup-python from 4 to 5 (#448) by `@dependabot[bot] <https://github.com/dependabot[bot]>`_ in `#448 <https://github.com/litestar-org/polyfactory/pull/448>`_
* (`231d311 <https://github.com/litestar-org/polyfactory/commit/231d311643b6f3bc022d7de44f58866f1edcb217>`_) - Bump github/codeql-action from 2 to 3 (#458) by `@dependabot[bot] <https://github.com/dependabot[bot]>`_ in `#458 <https://github.com/litestar-org/polyfactory/pull/458>`_
* (`2695880 <https://github.com/litestar-org/polyfactory/commit/2695880a444406c21942b80ad9472ab0212dd98c>`_) - Bump dawidd6/action-download-artifact from 2 to 3 (#459) by `@dependabot[bot] <https://github.com/dependabot[bot]>`_ in `#459 <https://github.com/litestar-org/polyfactory/pull/459>`_
* (`fe342e4 <https://github.com/litestar-org/polyfactory/commit/fe342e49f35df85db27f42444cdb7e74fae090da>`_) - Bump actions/upload-artifact from 3 to 4 (#461) by `@dependabot[bot] <https://github.com/dependabot[bot]>`_ in `#461 <https://github.com/litestar-org/polyfactory/pull/461>`_
* (`a371d7f <https://github.com/litestar-org/polyfactory/commit/a371d7fb0ac0ec323aabe85dca9bb63e41cbd36a>`_) - Bump actions/download-artifact from 3 to 4 (#462) by `@dependabot[bot] <https://github.com/dependabot[bot]>`_ in `#462 <https://github.com/litestar-org/polyfactory/pull/462>`_
* (`0e2f824 <https://github.com/litestar-org/polyfactory/commit/0e2f824e72a5f682c91f1ed0a2862d36c5661e45>`_) - Bump dependencies (#465) by `@guacs <https://github.com/guacs>`_ in `#465 <https://github.com/litestar-org/polyfactory/pull/465>`_
* (`8dc8e1a <https://github.com/litestar-org/polyfactory/commit/8dc8e1a4594a75ad9a16e1b6f5041b6044fc4f51>`_) - Bump minor version by `@guacs <https://github.com/guacs>`_
`Release [v2.12.0] - 2023-11-13 <https://github.com/litestar-org/polyfactory/releases/tag/v2.12.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.12.0 <https://github.com/litestar-org/polyfactory/commits/v2.12.0>`_
`b7b88a8 <https://github.com/litestar-org/polyfactory/commit/b7b88a8a86d735c36df60b2e2af3a6322008152f>`_ ... `fe05c4e <https://github.com/litestar-org/polyfactory/commit/fe05c4e60a50d8f043e4d1dbee5ea0a0c4d9abd8>`_ | `See diff for 2.12.0 <https://github.com/litestar-org/polyfactory/compare/b7b88a8a86d735c36df60b2e2af3a6322008152f...fe05c4e60a50d8f043e4d1dbee5ea0a0c4d9abd8>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`70d49fd <https://github.com/litestar-org/polyfactory/commit/70d49fdf6cde700a403a807d26d0d3ea5c86cd44>`_) - Handle cases where 'init=False' for dataclasses and attrs models (#433) by `@guacs <https://github.com/guacs>`_ in `#433 <https://github.com/litestar-org/polyfactory/pull/433>`_
* (`6b7512d <https://github.com/litestar-org/polyfactory/commit/6b7512d7b3d0c1b9b90dbc94e1667b40aba5bf87>`_) - Correctly handle collections with constrained items (#436) by `@guacs <https://github.com/guacs>`_ in `#436 <https://github.com/litestar-org/polyfactory/pull/436>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`2bad951 <https://github.com/litestar-org/polyfactory/commit/2bad951dc90c6acfb7f88efab0222873ba903191>`_) - Add g0di as a contributor for code, doc, and test (#432) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#432 <https://github.com/litestar-org/polyfactory/pull/432>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`155f4a4 <https://github.com/litestar-org/polyfactory/commit/155f4a44d14290dce18edd2c5999f38915c3039b>`_) - Autofill ``model`` argument when calling ``create_factory`` with receiving factory ``__model__`` (#429) by `@g0di <https://github.com/g0di>`_ in `#429 <https://github.com/litestar-org/polyfactory/pull/429>`_
* (`b1e8b5e <https://github.com/litestar-org/polyfactory/commit/b1e8b5ec02fdfb37c179cf6e37bb0772e61de1aa>`_) - Model type coverage batch generation (#390) by `@sam-or <https://github.com/sam-or>`_ in `#390 <https://github.com/litestar-org/polyfactory/pull/390>`_
`Release [v2.11.0] - 2023-10-23 <https://github.com/litestar-org/polyfactory/releases/tag/v2.11.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.11.0 <https://github.com/litestar-org/polyfactory/commits/v2.11.0>`_
`63aa272 <https://github.com/litestar-org/polyfactory/commit/63aa2729df553f49ed137e8e33c6a1a80387ca2b>`_ ... `b7b88a8 <https://github.com/litestar-org/polyfactory/commit/b7b88a8a86d735c36df60b2e2af3a6322008152f>`_ | `See diff for 2.11.0 <https://github.com/litestar-org/polyfactory/compare/63aa2729df553f49ed137e8e33c6a1a80387ca2b...b7b88a8a86d735c36df60b2e2af3a6322008152f>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`caaee0f <https://github.com/litestar-org/polyfactory/commit/caaee0f4ca372bc29763979be56f8c13ed7fec28>`_) - Handle Required and NonRequired annotations (#422) by `@guacs <https://github.com/guacs>`_ in `#422 <https://github.com/litestar-org/polyfactory/pull/422>`_
* (`5d64bde <https://github.com/litestar-org/polyfactory/commit/5d64bde08134fb30be60a3596a268c23dcd1837e>`_) - Respect override of optional nested model fields (#420) by `@julioolvr <https://github.com/julioolvr>`_ in `#420 <https://github.com/litestar-org/polyfactory/pull/420>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`e819c2f <https://github.com/litestar-org/polyfactory/commit/e819c2fe9451f92e6e175fe9c261aaf34c97eda8>`_) - Add johnraz as a contributor for code, doc, and test (#413) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#413 <https://github.com/litestar-org/polyfactory/pull/413>`_
* (`0631d80 <https://github.com/litestar-org/polyfactory/commit/0631d808c4d984ad70cac199be2312b77a12fcb0>`_) - Update installation (#414) by `@adhtruong <https://github.com/adhtruong>`_ in `#414 <https://github.com/litestar-org/polyfactory/pull/414>`_
* (`11f234c <https://github.com/litestar-org/polyfactory/commit/11f234c030d1d2546ffbeb062ed736753bc7417c>`_) - Reorder docs and add docs on factories as fields (#418) by `@adhtruong <https://github.com/adhtruong>`_ in `#418 <https://github.com/litestar-org/polyfactory/pull/418>`_
* (`a0465c6 <https://github.com/litestar-org/polyfactory/commit/a0465c6aba403263835551dae314975631e26248>`_) - Add julioolvr as a contributor for code, and test (#425) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#425 <https://github.com/litestar-org/polyfactory/pull/425>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`5fefa41 <https://github.com/litestar-org/polyfactory/commit/5fefa4142940019ebd20703663a6888766cc49ad>`_) - Check if fields declared on the factory belong to the model (#405) by `@johnraz <https://github.com/johnraz>`_ in `#405 <https://github.com/litestar-org/polyfactory/pull/405>`_
* (`e1f7a47 <https://github.com/litestar-org/polyfactory/commit/e1f7a47c6e3c979f8f43ce6ee612f417d2f3c03b>`_) - Support annotation with Constraints (#411) by `@guacs <https://github.com/guacs>`_ in `#411 <https://github.com/litestar-org/polyfactory/pull/411>`_
* (`0717951 <https://github.com/litestar-org/polyfactory/commit/07179513fc4e27b7466f5627cf252be535b81b61>`_) - Deprecate FieldMeta collection params (#417) by `@adhtruong <https://github.com/adhtruong>`_ in `#417 <https://github.com/litestar-org/polyfactory/pull/417>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`b7b88a8 <https://github.com/litestar-org/polyfactory/commit/b7b88a8a86d735c36df60b2e2af3a6322008152f>`_) - Prepare for releasing v2.11 (#427) by `@guacs <https://github.com/guacs>`_ in `#427 <https://github.com/litestar-org/polyfactory/pull/427>`_
`Release [v2.10.0] - 2023-10-16 <https://github.com/litestar-org/polyfactory/releases/tag/v2.10.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.10.0 <https://github.com/litestar-org/polyfactory/commits/v2.10.0>`_
`f2c6fe1 <https://github.com/litestar-org/polyfactory/commit/f2c6fe19eb632b04b0efa20b909df96e6d9c6c68>`_ ... `63aa272 <https://github.com/litestar-org/polyfactory/commit/63aa2729df553f49ed137e8e33c6a1a80387ca2b>`_ | `See diff for 2.10.0 <https://github.com/litestar-org/polyfactory/compare/f2c6fe19eb632b04b0efa20b909df96e6d9c6c68...63aa2729df553f49ed137e8e33c6a1a80387ca2b>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`8c88293 <https://github.com/litestar-org/polyfactory/commit/8c88293e71045fb94c2e5657ab2b8062cb84dbd2>`_) - Properly resolve dataclass forward references (#383) by `@guacs <https://github.com/guacs>`_ in `#383 <https://github.com/litestar-org/polyfactory/pull/383>`_
* (`0064240 <https://github.com/litestar-org/polyfactory/commit/00642404e0a1a61052cbf9c1c901d6aee241ff70>`_) - Update makefile (#399) by `@JacobCoffee <https://github.com/JacobCoffee>`_ in `#399 <https://github.com/litestar-org/polyfactory/pull/399>`_
* (`89cd351 <https://github.com/litestar-org/polyfactory/commit/89cd35186a6dd7fd6b86e32e83caa2fad36ee194>`_) - Decouple the handling of collection length configuration from ``FieldMeta`` (#407) by `@guacs <https://github.com/guacs>`_ in `#407 <https://github.com/litestar-org/polyfactory/pull/407>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`c1edfd5 <https://github.com/litestar-org/polyfactory/commit/c1edfd5b135d9042caa02a4dd4d50b276a0ca829>`_) - Install all dependencies for docs build (#404) by `@adhtruong <https://github.com/adhtruong>`_ in `#404 <https://github.com/litestar-org/polyfactory/pull/404>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`cabe03c <https://github.com/litestar-org/polyfactory/commit/cabe03c29cae8ac09c9d51e7f355d324e6740bd9>`_) - Support sqlalchemy 1.4 (#385) by `@adhtruong <https://github.com/adhtruong>`_ in `#385 <https://github.com/litestar-org/polyfactory/pull/385>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`63aa272 <https://github.com/litestar-org/polyfactory/commit/63aa2729df553f49ed137e8e33c6a1a80387ca2b>`_) - Prepare for releasing v2.10 (#410) by `@guacs <https://github.com/guacs>`_ in `#410 <https://github.com/litestar-org/polyfactory/pull/410>`_
Refactor
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`79360f1 <https://github.com/litestar-org/polyfactory/commit/79360f18340da6ab67808a4a177349b206432bc9>`_) - Move creation of pydantic provider map (#396) by `@guacs <https://github.com/guacs>`_ in `#396 <https://github.com/litestar-org/polyfactory/pull/396>`_
* (`f555636 <https://github.com/litestar-org/polyfactory/commit/f555636bee6aa0ebf2c4f2c05cdb24a2e143ff75>`_) - Refactor the msgspec factory to use the fields API (#409) by `@guacs <https://github.com/guacs>`_ in `#409 <https://github.com/litestar-org/polyfactory/pull/409>`_
Ci
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`8ef78b8 <https://github.com/litestar-org/polyfactory/commit/8ef78b8c3eb9d18a9f88b05f02e86378bc3769bf>`_) - Fix alternative version installation (#389) by `@adhtruong <https://github.com/adhtruong>`_ in `#389 <https://github.com/litestar-org/polyfactory/pull/389>`_
Infra
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`eddb978 <https://github.com/litestar-org/polyfactory/commit/eddb9789b45836c3619d97d03b85c90f66ed1099>`_) - Migrate to pdm and full ruff (#384) by `@JacobCoffee <https://github.com/JacobCoffee>`_ in `#384 <https://github.com/litestar-org/polyfactory/pull/384>`_
`Release [v2.9.0] - 2023-09-19 <https://github.com/litestar-org/polyfactory/releases/tag/v2.9.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.9.0 <https://github.com/litestar-org/polyfactory/commits/v2.9.0>`_
`ebf30ff <https://github.com/litestar-org/polyfactory/commit/ebf30ff6e05807ee6073f1fb04667f17498424d5>`_ ... `f2c6fe1 <https://github.com/litestar-org/polyfactory/commit/f2c6fe19eb632b04b0efa20b909df96e6d9c6c68>`_ | `See diff for 2.9.0 <https://github.com/litestar-org/polyfactory/compare/ebf30ff6e05807ee6073f1fb04667f17498424d5...f2c6fe19eb632b04b0efa20b909df96e6d9c6c68>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`2a20513 <https://github.com/litestar-org/polyfactory/commit/2a20513621e1c7c7c1f53c66ad43880b4695ea07>`_) - Properly type hint create_factory (#360) by `@guacs <https://github.com/guacs>`_ in `#360 <https://github.com/litestar-org/polyfactory/pull/360>`_
* (`6cc7b03 <https://github.com/litestar-org/polyfactory/commit/6cc7b03067463e1b4d8a8a007b78a44265e6de36>`_) - ``AttrsFactory`` fixes (#370) by `@guacs <https://github.com/guacs>`_ in `#370 <https://github.com/litestar-org/polyfactory/pull/370>`_
* (`8e41372 <https://github.com/litestar-org/polyfactory/commit/8e41372f0fc1ae7abfbd41c074e8bb5246f3e188>`_) - Update fixture size handling (#373) by `@adhtruong <https://github.com/adhtruong>`_ in `#373 <https://github.com/litestar-org/polyfactory/pull/373>`_
* (`87a6749 <https://github.com/litestar-org/polyfactory/commit/87a67493d839a5a61ea2df2b31eb909a60426a58>`_) - Dataclass field type not used correctly (#371) by `@anthonyjgraff <https://github.com/anthonyjgraff>`_ in `#371 <https://github.com/litestar-org/polyfactory/pull/371>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`6f4b712 <https://github.com/litestar-org/polyfactory/commit/6f4b7127091967bbcbcd561611309d926eb1dcbe>`_) - Add adhtruong as a contributor for doc, test, and code (#375) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#375 <https://github.com/litestar-org/polyfactory/pull/375>`_
* (`64c4e6c <https://github.com/litestar-org/polyfactory/commit/64c4e6cfadd8bdbd6b2fa6af812448c3ba537fb6>`_) - Add anthonyjgraff as a contributor for code (#374) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#374 <https://github.com/litestar-org/polyfactory/pull/374>`_
* (`f2c6fe1 <https://github.com/litestar-org/polyfactory/commit/f2c6fe19eb632b04b0efa20b909df96e6d9c6c68>`_) - Add guacs as a contributor for infra, code, and 2 more (#380) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#380 <https://github.com/litestar-org/polyfactory/pull/380>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`c76ffc9 <https://github.com/litestar-org/polyfactory/commit/c76ffc9e181128d26b448622792f9876bd6f3bac>`_) - Implement SQLA factory (#369) by `@adhtruong <https://github.com/adhtruong>`_ in `#369 <https://github.com/litestar-org/polyfactory/pull/369>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`fc0bf61 <https://github.com/litestar-org/polyfactory/commit/fc0bf6131af6d4480da6e9b0102f1df67180d92a>`_) - Update maintainers by `@provinzkraut <https://github.com/provinzkraut>`_
* (`f67f36e <https://github.com/litestar-org/polyfactory/commit/f67f36e45f67a80bfe63e7df88310f97196e6830>`_) - Ignore .all-contributorsrc for in .pre-commit (#377) by `@adhtruong <https://github.com/adhtruong>`_ in `#377 <https://github.com/litestar-org/polyfactory/pull/377>`_
* (`66e9db1 <https://github.com/litestar-org/polyfactory/commit/66e9db170958d89648df64593e02d43196493f42>`_) - Fix all-contributors config by `@JacobCoffee <https://github.com/JacobCoffee>`_
Testing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`ec177ec <https://github.com/litestar-org/polyfactory/commit/ec177ec2d0e12bddb37af285982b0b453e2cbd06>`_) - Make ``pytest`` configuration stricter (#363) by `@sobolevn <https://github.com/sobolevn>`_ in `#363 <https://github.com/litestar-org/polyfactory/pull/363>`_
* (`95d24cb <https://github.com/litestar-org/polyfactory/commit/95d24cb193e2e6fbfa87c642266f0ae907e3ccdd>`_) - Skip variable length dict test for odmantic (#372) by `@guacs <https://github.com/guacs>`_ in `#372 <https://github.com/litestar-org/polyfactory/pull/372>`_
Infra
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`adccaf0 <https://github.com/litestar-org/polyfactory/commit/adccaf0a5d6261e088b1bd58f54efdd2c1b54147>`_) - Enable publishing with PyPI trusted publishers (#368) by `@provinzkraut <https://github.com/provinzkraut>`_ in `#368 <https://github.com/litestar-org/polyfactory/pull/368>`_
`Release [v2.8.2] - 2023-09-15 <https://github.com/litestar-org/polyfactory/releases/tag/v2.8.2>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.8.2 <https://github.com/litestar-org/polyfactory/commits/v2.8.2>`_
`7af5469 <https://github.com/litestar-org/polyfactory/commit/7af5469440fb2450fdfb68403985f1b67d6e4a92>`_ ... `ebf30ff <https://github.com/litestar-org/polyfactory/commit/ebf30ff6e05807ee6073f1fb04667f17498424d5>`_ | `See diff for 2.8.2 <https://github.com/litestar-org/polyfactory/compare/7af5469440fb2450fdfb68403985f1b67d6e4a92...ebf30ff6e05807ee6073f1fb04667f17498424d5>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`f639c26 <https://github.com/litestar-org/polyfactory/commit/f639c26b630788c3dbcb9c7186d22f20eb59796b>`_) - Properly set annotation in union with nested Annotated (#355) by `@guacs <https://github.com/guacs>`_ in `#355 <https://github.com/litestar-org/polyfactory/pull/355>`_
* (`ebf30ff <https://github.com/litestar-org/polyfactory/commit/ebf30ff6e05807ee6073f1fb04667f17498424d5>`_) - Add minimum version constraint to attrs (#359) by `@guacs <https://github.com/guacs>`_ in `#359 <https://github.com/litestar-org/polyfactory/pull/359>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`091ee36 <https://github.com/litestar-org/polyfactory/commit/091ee36f6ee7e51f73fe6bebabb1bda442faed35>`_) - Change the comment length in "Handling custom types" docs (#361) by `@sobolevn <https://github.com/sobolevn>`_ in `#361 <https://github.com/litestar-org/polyfactory/pull/361>`_
`Release [v2.8.1] - 2023-09-10 <https://github.com/litestar-org/polyfactory/releases/tag/v2.8.1>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.8.1 <https://github.com/litestar-org/polyfactory/commits/v2.8.1>`_
`7b46b57 <https://github.com/litestar-org/polyfactory/commit/7b46b572a71b347ac650658fe066641e631cedd6>`_ ... `7af5469 <https://github.com/litestar-org/polyfactory/commit/7af5469440fb2450fdfb68403985f1b67d6e4a92>`_ | `See diff for 2.8.1 <https://github.com/litestar-org/polyfactory/compare/7b46b572a71b347ac650658fe066641e631cedd6...7af5469440fb2450fdfb68403985f1b67d6e4a92>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`3dba4be <https://github.com/litestar-org/polyfactory/commit/3dba4be756d1d4e2b132f1650949bc9e0cdaa3ec>`_) - Use full Python version for venv cache (#352) by `@guacs <https://github.com/guacs>`_ in `#352 <https://github.com/litestar-org/polyfactory/pull/352>`_
* (`257852a <https://github.com/litestar-org/polyfactory/commit/257852af883c7a34e7a8be4494139f36825be08b>`_) - Add missing factories to builtin registration (#351) by `@guacs <https://github.com/guacs>`_ in `#351 <https://github.com/litestar-org/polyfactory/pull/351>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`e4daf5f <https://github.com/litestar-org/polyfactory/commit/e4daf5f6e4f7e17cad6bb75d8ff81fbb3145958a>`_) - Add adhtruong as a contributor for code (#346) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#346 <https://github.com/litestar-org/polyfactory/pull/346>`_
* (`9ffe596 <https://github.com/litestar-org/polyfactory/commit/9ffe596836271a86ae2a8d0fdb06b2b94d287f54>`_) - Expose all options (#350) by `@adhtruong <https://github.com/adhtruong>`_ in `#350 <https://github.com/litestar-org/polyfactory/pull/350>`_
* (`7a5a1c9 <https://github.com/litestar-org/polyfactory/commit/7a5a1c9a228feaf29ce8211a130daf354725a5ee>`_) - Add adhtruong as a contributor for doc (#353) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#353 <https://github.com/litestar-org/polyfactory/pull/353>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`4f2e5d8 <https://github.com/litestar-org/polyfactory/commit/4f2e5d84d7b2c837a21295f886c9bc04f4ed3534>`_) - Updated dependencies by `@Goldziher <https://github.com/Goldziher>`_
* (`161c0f6 <https://github.com/litestar-org/polyfactory/commit/161c0f69344105a827ee4701e91da159b70b1c08>`_) - Bump actions/checkout from 3 to 4 (#349) by `@dependabot[bot] <https://github.com/dependabot[bot]>`_ in `#349 <https://github.com/litestar-org/polyfactory/pull/349>`_
* (`7af5469 <https://github.com/litestar-org/polyfactory/commit/7af5469440fb2450fdfb68403985f1b67d6e4a92>`_) - Prepare v2.8.1 (#354) by `@guacs <https://github.com/guacs>`_ in `#354 <https://github.com/litestar-org/polyfactory/pull/354>`_
`Release [v2.8.0] - 2023-08-26 <https://github.com/litestar-org/polyfactory/releases/tag/v2.8.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.8.0 <https://github.com/litestar-org/polyfactory/commits/v2.8.0>`_
`710d3ce <https://github.com/litestar-org/polyfactory/commit/710d3ce48e72e36b7e4fabc3a739dd0afc34d317>`_ ... `7b46b57 <https://github.com/litestar-org/polyfactory/commit/7b46b572a71b347ac650658fe066641e631cedd6>`_ | `See diff for 2.8.0 <https://github.com/litestar-org/polyfactory/compare/710d3ce48e72e36b7e4fabc3a739dd0afc34d317...7b46b572a71b347ac650658fe066641e631cedd6>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`3ec7de8 <https://github.com/litestar-org/polyfactory/commit/3ec7de8693efa8a0d16abda0d7a17d4cf5d840ee>`_) - Ensure no override of Faker instance (#331) by `@guacs <https://github.com/guacs>`_ in `#331 <https://github.com/litestar-org/polyfactory/pull/331>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`ea41bbe <https://github.com/litestar-org/polyfactory/commit/ea41bbe6097813de9354e75fff33c785f5c54de2>`_) - Add 185504a9 as a contributor for code (#339) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#339 <https://github.com/litestar-org/polyfactory/pull/339>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`510fabd <https://github.com/litestar-org/polyfactory/commit/510fabdffec6b3f0147a136b8cdd50c0337d09a9>`_) - Support constraints for mapping types (#337) by `@guacs <https://github.com/guacs>`_ in `#337 <https://github.com/litestar-org/polyfactory/pull/337>`_
* (`0228d3d <https://github.com/litestar-org/polyfactory/commit/0228d3dd81015bb3dfc1add6f3f4b7d1b5f2b6a1>`_) - Add pydantic's AwareDatetime to the mock map (#333) by `@185504a9 <https://github.com/185504a9>`_ in `#333 <https://github.com/litestar-org/polyfactory/pull/333>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`bf04fa6 <https://github.com/litestar-org/polyfactory/commit/bf04fa625e3457d81059d754d10e36642a160e8a>`_) - Updated dependencies (#338) by `@Goldziher <https://github.com/Goldziher>`_ in `#338 <https://github.com/litestar-org/polyfactory/pull/338>`_
`Release [v2.7.2] - 2023-08-09 <https://github.com/litestar-org/polyfactory/releases/tag/v2.7.2>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.7.2 <https://github.com/litestar-org/polyfactory/commits/v2.7.2>`_
`04a504b <https://github.com/litestar-org/polyfactory/commit/04a504b7db5713d5e6027c230313ff383bcba252>`_ ... `710d3ce <https://github.com/litestar-org/polyfactory/commit/710d3ce48e72e36b7e4fabc3a739dd0afc34d317>`_ | `See diff for 2.7.2 <https://github.com/litestar-org/polyfactory/compare/04a504b7db5713d5e6027c230313ff383bcba252...710d3ce48e72e36b7e4fabc3a739dd0afc34d317>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`725835e <https://github.com/litestar-org/polyfactory/commit/725835edf8f3c4a4e6e6741ba4f4deeb24192a11>`_) - Fix pydantic core import (#329) by `@guacs <https://github.com/guacs>`_ in `#329 <https://github.com/litestar-org/polyfactory/pull/329>`_
`Release [v2.7.1] - 2023-08-08 <https://github.com/litestar-org/polyfactory/releases/tag/v2.7.1>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.7.1 <https://github.com/litestar-org/polyfactory/commits/v2.7.1>`_
`3e45f8f <https://github.com/litestar-org/polyfactory/commit/3e45f8f331d12ae395779567f5127b1bc18af23e>`_ ... `04a504b <https://github.com/litestar-org/polyfactory/commit/04a504b7db5713d5e6027c230313ff383bcba252>`_ | `See diff for 2.7.1 <https://github.com/litestar-org/polyfactory/compare/3e45f8f331d12ae395779567f5127b1bc18af23e...04a504b7db5713d5e6027c230313ff383bcba252>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`2733497 <https://github.com/litestar-org/polyfactory/commit/2733497369a065cf7c50006921967b93a02e0434>`_) - Add support for Json type in Pydantic factory (#315) by `@guacs <https://github.com/guacs>`_ in `#315 <https://github.com/litestar-org/polyfactory/pull/315>`_
* (`3aeaa0c <https://github.com/litestar-org/polyfactory/commit/3aeaa0cb290225e912ddda3d242b280839e04582>`_) - Constrained strings not deterministic with seed because urandom not seedable (#319) by `@klimantje <https://github.com/klimantje>`_ in `#319 <https://github.com/litestar-org/polyfactory/pull/319>`_
* (`61f1e2e <https://github.com/litestar-org/polyfactory/commit/61f1e2e0d857ffd111ab8c8d7cfbab6f67230ae1>`_) - Random seed configuration (#321) by `@guacs <https://github.com/guacs>`_ in `#321 <https://github.com/litestar-org/polyfactory/pull/321>`_
* (`2400fbe <https://github.com/litestar-org/polyfactory/commit/2400fbeb756deb5cdc32c666f2e27df31dff9387>`_) - Include pydantic Field constraints when using Optional type (#323) by `@tcrasset <https://github.com/tcrasset>`_ in `#323 <https://github.com/litestar-org/polyfactory/pull/323>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`8ff7e0f <https://github.com/litestar-org/polyfactory/commit/8ff7e0fbc3552869b7fcbcb1c8b71cfdf6c46dda>`_) - Add klimantje as a contributor for code (#320) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#320 <https://github.com/litestar-org/polyfactory/pull/320>`_
* (`9def5b1 <https://github.com/litestar-org/polyfactory/commit/9def5b1f2a95470659db0bd2b80d742b6195c2da>`_) - Add tcrasset as a contributor for code (#324) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#324 <https://github.com/litestar-org/polyfactory/pull/324>`_
Infra
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`5543e66 <https://github.com/litestar-org/polyfactory/commit/5543e66b1296cf3db8b1f66f0722fa05114ba266>`_) - Fix health files (#322) by `@JacobCoffee <https://github.com/JacobCoffee>`_ in `#322 <https://github.com/litestar-org/polyfactory/pull/322>`_
Meta
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`5abe4b3 <https://github.com/litestar-org/polyfactory/commit/5abe4b3df7dd9d3623d33332e8b6143b3806ccde>`_) - Update issue template config by `@JacobCoffee <https://github.com/JacobCoffee>`_
`Release [v2.7.0] - 2023-07-28 <https://github.com/litestar-org/polyfactory/releases/tag/v2.7.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.7.0 <https://github.com/litestar-org/polyfactory/commits/v2.7.0>`_
`e703593 <https://github.com/litestar-org/polyfactory/commit/e703593658e94b6aed938fbff161936f916d0e02>`_ ... `3e45f8f <https://github.com/litestar-org/polyfactory/commit/3e45f8f331d12ae395779567f5127b1bc18af23e>`_ | `See diff for 2.7.0 <https://github.com/litestar-org/polyfactory/compare/e703593658e94b6aed938fbff161936f916d0e02...3e45f8f331d12ae395779567f5127b1bc18af23e>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`0bfa3b4 <https://github.com/litestar-org/polyfactory/commit/0bfa3b497ecfe45c21e1d700e1c2aa8ec41db391>`_) - Add litestar rename news link by `@JacobCoffee <https://github.com/JacobCoffee>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`96c61ae <https://github.com/litestar-org/polyfactory/commit/96c61aeabe02cb135bfa5225c0dbe6459df41a8c>`_) - Implementation of Attrs Factory (#313) by `@guacs <https://github.com/guacs>`_ in `#313 <https://github.com/litestar-org/polyfactory/pull/313>`_
Infra
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`d385561 <https://github.com/litestar-org/polyfactory/commit/d38556127f40f009a8baf22e1ea5cb5f12603dd0>`_) - Update codeowners (#311) by `@JacobCoffee <https://github.com/JacobCoffee>`_ in `#311 <https://github.com/litestar-org/polyfactory/pull/311>`_
`Release [v2.6.3] - 2023-07-21 <https://github.com/litestar-org/polyfactory/releases/tag/v2.6.3>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.6.3 <https://github.com/litestar-org/polyfactory/commits/v2.6.3>`_
`86585d0 <https://github.com/litestar-org/polyfactory/commit/86585d064393017c448918d88e00853d370274e1>`_ ... `e703593 <https://github.com/litestar-org/polyfactory/commit/e703593658e94b6aed938fbff161936f916d0e02>`_ | `See diff for 2.6.3 <https://github.com/litestar-org/polyfactory/compare/86585d064393017c448918d88e00853d370274e1...e703593658e94b6aed938fbff161936f916d0e02>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`7405901 <https://github.com/litestar-org/polyfactory/commit/7405901e0e861abcb3256d0f09f22180880ed4e0>`_) - Remove stray badge (#306) by `@JacobCoffee <https://github.com/JacobCoffee>`_ in `#306 <https://github.com/litestar-org/polyfactory/pull/306>`_
* (`b1f8f6e <https://github.com/litestar-org/polyfactory/commit/b1f8f6e7e05f8741a79d166fbeac862a002236d5>`_) - Remove stray character from README by `@JacobCoffee <https://github.com/JacobCoffee>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`c936389 <https://github.com/litestar-org/polyfactory/commit/c9363893b50f1763ee08ccb421856c470f2d9fff>`_) - Update poetry dependencies (#308) by `@Goldziher <https://github.com/Goldziher>`_ in `#308 <https://github.com/litestar-org/polyfactory/pull/308>`_
* (`09f896c <https://github.com/litestar-org/polyfactory/commit/09f896c4d47e9232fe1870fd40f1eef73ddc4f5e>`_) - Fix CONTRIBUTING.rst (#310) by `@provinzkraut <https://github.com/provinzkraut>`_ in `#310 <https://github.com/litestar-org/polyfactory/pull/310>`_
* (`3fadfb7 <https://github.com/litestar-org/polyfactory/commit/3fadfb712b5f967ecb27719ba7f92b20788b108b>`_) - Fix annotated field resolution (#309) by `@Goldziher <https://github.com/Goldziher>`_ in `#309 <https://github.com/litestar-org/polyfactory/pull/309>`_
`Release [v2.6.2] - 2023-07-14 <https://github.com/litestar-org/polyfactory/releases/tag/v2.6.2>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.6.2 <https://github.com/litestar-org/polyfactory/commits/v2.6.2>`_
`d331ae0 <https://github.com/litestar-org/polyfactory/commit/d331ae03a9e11733d5b2b14b4ad190f7281d663a>`_ ... `86585d0 <https://github.com/litestar-org/polyfactory/commit/86585d064393017c448918d88e00853d370274e1>`_ | `See diff for 2.6.2 <https://github.com/litestar-org/polyfactory/compare/d331ae03a9e11733d5b2b14b4ad190f7281d663a...86585d064393017c448918d88e00853d370274e1>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`a2be35a <https://github.com/litestar-org/polyfactory/commit/a2be35a535babbb5b6ed407e8f108f7aa9371067>`_) - Switch to using faker.seed_instance (#305) by `@Goldziher <https://github.com/Goldziher>`_ in `#305 <https://github.com/litestar-org/polyfactory/pull/305>`_
* (`86585d0 <https://github.com/litestar-org/polyfactory/commit/86585d064393017c448918d88e00853d370274e1>`_) - 2.6.2 by `@Goldziher <https://github.com/Goldziher>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`f54f9f3 <https://github.com/litestar-org/polyfactory/commit/f54f9f3c0b849a2d06bf4a5332da80ccdc31d1a9>`_) - Add passing test for issue 300 (#301) by `@Goldziher <https://github.com/Goldziher>`_ in `#301 <https://github.com/litestar-org/polyfactory/pull/301>`_
`Release [v2.6.1] - 2023-07-10 <https://github.com/litestar-org/polyfactory/releases/tag/v2.6.1>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.6.1 <https://github.com/litestar-org/polyfactory/commits/v2.6.1>`_
`79e8145 <https://github.com/litestar-org/polyfactory/commit/79e81458edd3faeacac5b5e4f1b1cece196f326f>`_ ... `d331ae0 <https://github.com/litestar-org/polyfactory/commit/d331ae03a9e11733d5b2b14b4ad190f7281d663a>`_ | `See diff for 2.6.1 <https://github.com/litestar-org/polyfactory/compare/79e81458edd3faeacac5b5e4f1b1cece196f326f...d331ae03a9e11733d5b2b14b4ad190f7281d663a>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`7761834 <https://github.com/litestar-org/polyfactory/commit/776183494c4a0480b2ea5f168378eeffc30906b5>`_) - Add abdulhaq-e as a contributor for code (#297) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#297 <https://github.com/litestar-org/polyfactory/pull/297>`_
`Release [v2.6.0] - 2023-07-09 <https://github.com/litestar-org/polyfactory/releases/tag/v2.6.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.6.0 <https://github.com/litestar-org/polyfactory/commits/v2.6.0>`_
`2b050bb <https://github.com/litestar-org/polyfactory/commit/2b050bb53552ec3dab944a8386b38e8fc104045d>`_ ... `79e8145 <https://github.com/litestar-org/polyfactory/commit/79e81458edd3faeacac5b5e4f1b1cece196f326f>`_ | `See diff for 2.6.0 <https://github.com/litestar-org/polyfactory/compare/2b050bb53552ec3dab944a8386b38e8fc104045d...79e81458edd3faeacac5b5e4f1b1cece196f326f>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`16cbc99 <https://github.com/litestar-org/polyfactory/commit/16cbc9938f3c6e1ce84953e074689869a649270b>`_) - Fix pre-commit issues by `@Goldziher <https://github.com/Goldziher>`_
* (`956472c <https://github.com/litestar-org/polyfactory/commit/956472cd5bba38af012684ed75133bc63d28d562>`_) - Apply sourcery by `@Goldziher <https://github.com/Goldziher>`_
* (`5cdfed3 <https://github.com/litestar-org/polyfactory/commit/5cdfed316621d9f53d364966e150daf9dadacb8a>`_) - Updated dependencies by `@Goldziher <https://github.com/Goldziher>`_
`Release [v2.5.0] - 2023-06-30 <https://github.com/litestar-org/polyfactory/releases/tag/v2.5.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.5.0 <https://github.com/litestar-org/polyfactory/commits/v2.5.0>`_
`79e50df <https://github.com/litestar-org/polyfactory/commit/79e50dfdbabca2c58eee54347edab3fc0e269bc3>`_ ... `2b050bb <https://github.com/litestar-org/polyfactory/commit/2b050bb53552ec3dab944a8386b38e8fc104045d>`_ | `See diff for 2.5.0 <https://github.com/litestar-org/polyfactory/compare/79e50dfdbabca2c58eee54347edab3fc0e269bc3...2b050bb53552ec3dab944a8386b38e8fc104045d>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`35e10da <https://github.com/litestar-org/polyfactory/commit/35e10daf2f2c00de3fcedf857b180741bef22302>`_) - All contributors (#263) by `@Goldziher <https://github.com/Goldziher>`_ in `#263 <https://github.com/litestar-org/polyfactory/pull/263>`_
* (`d592836 <https://github.com/litestar-org/polyfactory/commit/d592836295fd53f7d5604ffe671553a897613673>`_) - Support overriding base factories locally (v2) (#267) by `@gsakkis <https://github.com/gsakkis>`_ in `#267 <https://github.com/litestar-org/polyfactory/pull/267>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`2b8ae48 <https://github.com/litestar-org/polyfactory/commit/2b8ae487feef83143995a4765c70e53d90f270f3>`_) - Add peterschutt as a contributor for maintenance, doc, and test (#264) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#264 <https://github.com/litestar-org/polyfactory/pull/264>`_
* (`a53c598 <https://github.com/litestar-org/polyfactory/commit/a53c598407aac551638a0f39d9a1173370e42ff6>`_) - Update pypi image, update readme (#266) by `@JacobCoffee <https://github.com/JacobCoffee>`_ in `#266 <https://github.com/litestar-org/polyfactory/pull/266>`_
* (`d0c8bfa <https://github.com/litestar-org/polyfactory/commit/d0c8bfab21f9ed0d918d51069b36359337294762>`_) - Add mdczaplicki as a contributor for test, and code (#274) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#274 <https://github.com/litestar-org/polyfactory/pull/274>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`a7220f3 <https://github.com/litestar-org/polyfactory/commit/a7220f31428307b0a635216e3d9d1154b988eb91>`_) - Add ``sourcery-ai`` config (#271) by `@JacobCoffee <https://github.com/JacobCoffee>`_ in `#271 <https://github.com/litestar-org/polyfactory/pull/271>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`946cf08 <https://github.com/litestar-org/polyfactory/commit/946cf08dd5401929a0d8aaeb6eee8a6607e4ac11>`_) - Updated deps by `@Goldziher <https://github.com/Goldziher>`_
* (`e932f89 <https://github.com/litestar-org/polyfactory/commit/e932f8920e786e372e185e5c068543587a4b6861>`_) - Applied sourcery (#281) by `@Goldziher <https://github.com/Goldziher>`_ in `#281 <https://github.com/litestar-org/polyfactory/pull/281>`_
* (`0c0ed22 <https://github.com/litestar-org/polyfactory/commit/0c0ed221c68b3e19951f6861cf65c4e2bd8f265e>`_) - Adjust to pydantic v2 (#284) by `@Goldziher <https://github.com/Goldziher>`_ in `#284 <https://github.com/litestar-org/polyfactory/pull/284>`_
Release
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`2b050bb <https://github.com/litestar-org/polyfactory/commit/2b050bb53552ec3dab944a8386b38e8fc104045d>`_) - Update README for v2.5.0 and pydantic v2 (#285) by `@JacobCoffee <https://github.com/JacobCoffee>`_ in `#285 <https://github.com/litestar-org/polyfactory/pull/285>`_
`Release [v2.4.0] - 2023-06-25 <https://github.com/litestar-org/polyfactory/releases/tag/v2.4.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.4.0 <https://github.com/litestar-org/polyfactory/commits/v2.4.0>`_
`5013069 <https://github.com/litestar-org/polyfactory/commit/5013069b9a1d6adbdd5b1ee27bf5e4a73c00fac0>`_ ... `79e50df <https://github.com/litestar-org/polyfactory/commit/79e50dfdbabca2c58eee54347edab3fc0e269bc3>`_ | `See diff for 2.4.0 <https://github.com/litestar-org/polyfactory/compare/5013069b9a1d6adbdd5b1ee27bf5e4a73c00fac0...79e50dfdbabca2c58eee54347edab3fc0e269bc3>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`26073c4 <https://github.com/litestar-org/polyfactory/commit/26073c4db7b50a4dc90f60e3714b86c6db8a1def>`_) - Support overriding base factories locally (#238) by `@Goldziher <https://github.com/Goldziher>`_ in `#238 <https://github.com/litestar-org/polyfactory/pull/238>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`d625936 <https://github.com/litestar-org/polyfactory/commit/d62593698118fbfa9350b5ad0b7147ad257a0f2a>`_) - Add Simske as a contributor for code (#242) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#242 <https://github.com/litestar-org/polyfactory/pull/242>`_
* (`2b93de6 <https://github.com/litestar-org/polyfactory/commit/2b93de6800a87b97c531162cafaec4b8dd3c2eea>`_) - Add danielkatzan as a contributor for doc (#261) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#261 <https://github.com/litestar-org/polyfactory/pull/261>`_
* (`1511c9e <https://github.com/litestar-org/polyfactory/commit/1511c9eca5f6b97aea7a1eaadf4aac9166309069>`_) - Add gegnew as a contributor for code (#262) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#262 <https://github.com/litestar-org/polyfactory/pull/262>`_
* (`d355511 <https://github.com/litestar-org/polyfactory/commit/d35551182759797996494ead26f054f56f77fc65>`_) - Add roeeyn as a contributor for doc (#260) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#260 <https://github.com/litestar-org/polyfactory/pull/260>`_
* (`c686ddd <https://github.com/litestar-org/polyfactory/commit/c686ddd2a4e935b40c3f93a3c6b84ef69a04cbdf>`_) - Add gigelu as a contributor for doc (#259) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#259 <https://github.com/litestar-org/polyfactory/pull/259>`_
* (`9101134 <https://github.com/litestar-org/polyfactory/commit/910113431cc96e01cab2a3707a05cf13b9e4579f>`_) - Add ReznikovRoman as a contributor for code (#258) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#258 <https://github.com/litestar-org/polyfactory/pull/258>`_
* (`1e4df30 <https://github.com/litestar-org/polyfactory/commit/1e4df304212a6d3291a148aee70e3011771432f7>`_) - Add anthonyh209 as a contributor for code (#257) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#257 <https://github.com/litestar-org/polyfactory/pull/257>`_
* (`c6657e7 <https://github.com/litestar-org/polyfactory/commit/c6657e7fdfcbcac78a9b9c032b8b5c49904cc82e>`_) - Add avihai-yosef as a contributor for code (#256) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#256 <https://github.com/litestar-org/polyfactory/pull/256>`_
* (`97cdad2 <https://github.com/litestar-org/polyfactory/commit/97cdad2b88de1c0dc2ce9a8205e4dce4151a1d76>`_) - Add Iipin as a contributor for code (#254) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#254 <https://github.com/litestar-org/polyfactory/pull/254>`_
* (`9156cca <https://github.com/litestar-org/polyfactory/commit/9156cca1399a27c0cd9e3d1fb9e449e6f0f9a35f>`_) - Add thorin-schiffer as a contributor for code (#253) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#253 <https://github.com/litestar-org/polyfactory/pull/253>`_
* (`02c1daa <https://github.com/litestar-org/polyfactory/commit/02c1daa2a0bc7c90d522de62f37c15203dca7d45>`_) - Add lyz-code as a contributor for code (#252) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#252 <https://github.com/litestar-org/polyfactory/pull/252>`_
* (`e883d58 <https://github.com/litestar-org/polyfactory/commit/e883d58cf0eaebe694b5a54e30dfce73759031fc>`_) - Add DaanRademaker as a contributor for code (#251) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#251 <https://github.com/litestar-org/polyfactory/pull/251>`_
* (`cd2e558 <https://github.com/litestar-org/polyfactory/commit/cd2e5582ca01dc1375ae7bb4f3d9e057cff91d8a>`_) - Add nguyent as a contributor for code (#250) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#250 <https://github.com/litestar-org/polyfactory/pull/250>`_
* (`af594e3 <https://github.com/litestar-org/polyfactory/commit/af594e319db5420e0a76e7919743309987bd9d46>`_) - Add EltonChou as a contributor for code (#249) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#249 <https://github.com/litestar-org/polyfactory/pull/249>`_
* (`bac2622 <https://github.com/litestar-org/polyfactory/commit/bac262255b656f7ec8ad2f0202f83dd3a59910de>`_) - Add Butch78 as a contributor for code (#248) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#248 <https://github.com/litestar-org/polyfactory/pull/248>`_
* (`13e80a7 <https://github.com/litestar-org/polyfactory/commit/13e80a7b4c8cea8395c09443d561e372105f1b80>`_) - Add lindycoder as a contributor for code (#247) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#247 <https://github.com/litestar-org/polyfactory/pull/247>`_
* (`3940de4 <https://github.com/litestar-org/polyfactory/commit/3940de43ce54d86385cf412007a7c261a5bb0590>`_) - Add peterschutt as a contributor for code (#246) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#246 <https://github.com/litestar-org/polyfactory/pull/246>`_
* (`e598c7d <https://github.com/litestar-org/polyfactory/commit/e598c7ddcdcdef07a1cca448f898c3f8bb176cd8>`_) - Add phbernardes as a contributor for code (#245) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#245 <https://github.com/litestar-org/polyfactory/pull/245>`_
* (`24a7766 <https://github.com/litestar-org/polyfactory/commit/24a7766a0f6888dc6548366f7af7535cb7d36fab>`_) - Add mciszczon as a contributor for code (#244) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#244 <https://github.com/litestar-org/polyfactory/pull/244>`_
* (`b8cfe1a <https://github.com/litestar-org/polyfactory/commit/b8cfe1a3f581bf07b32a8102b9c975e88594cd6b>`_) - Add sondrelg as a contributor for code (#243) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#243 <https://github.com/litestar-org/polyfactory/pull/243>`_
Fix
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`773b364 <https://github.com/litestar-org/polyfactory/commit/773b36460720cebd8afb246b63c0d8f09ea3faf4>`_) - URL constraints and strict pydantic v2 values (#241) by `@Goldziher <https://github.com/Goldziher>`_ in `#241 <https://github.com/litestar-org/polyfactory/pull/241>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`00dce8a <https://github.com/litestar-org/polyfactory/commit/00dce8a662eaf53aa38acf47ef8586855cc891fe>`_) - Reformat readme by `@Goldziher <https://github.com/Goldziher>`_
`Release [v2.3.3] - 2023-06-22 <https://github.com/litestar-org/polyfactory/releases/tag/v2.3.3>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.3.3 <https://github.com/litestar-org/polyfactory/commits/v2.3.3>`_
`aef7acb <https://github.com/litestar-org/polyfactory/commit/aef7acbc3c1222d351fad8bcb0a9517e1508165b>`_ ... `5013069 <https://github.com/litestar-org/polyfactory/commit/5013069b9a1d6adbdd5b1ee27bf5e4a73c00fac0>`_ | `See diff for 2.3.3 <https://github.com/litestar-org/polyfactory/compare/aef7acbc3c1222d351fad8bcb0a9517e1508165b...5013069b9a1d6adbdd5b1ee27bf5e4a73c00fac0>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`b9ea84d <https://github.com/litestar-org/polyfactory/commit/b9ea84d924942ee39d00871d4f4369a8b7a7a813>`_) - Add VSHUMILIN97 as a contributor for code (#237) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#237 <https://github.com/litestar-org/polyfactory/pull/237>`_
`Release [v2.3.2] - 2023-06-18 <https://github.com/litestar-org/polyfactory/releases/tag/v2.3.2>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.3.2 <https://github.com/litestar-org/polyfactory/commits/v2.3.2>`_
`36c2f2f <https://github.com/litestar-org/polyfactory/commit/36c2f2f77a546b7992ab9f95a4904b1717d86e91>`_ ... `aef7acb <https://github.com/litestar-org/polyfactory/commit/aef7acbc3c1222d351fad8bcb0a9517e1508165b>`_ | `See diff for 2.3.2 <https://github.com/litestar-org/polyfactory/compare/36c2f2f77a546b7992ab9f95a4904b1717d86e91...aef7acbc3c1222d351fad8bcb0a9517e1508165b>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`5bd544f <https://github.com/litestar-org/polyfactory/commit/5bd544f41ca07cac7d45c493d6a5262d648a79ab>`_) - Fix constant constraints (#233) by `@Goldziher <https://github.com/Goldziher>`_ in `#233 <https://github.com/litestar-org/polyfactory/pull/233>`_
`Release [v2.1.2] - 2023-05-28 <https://github.com/litestar-org/polyfactory/releases/tag/v2.1.2>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.1.2 <https://github.com/litestar-org/polyfactory/commits/v2.1.2>`_
`f2ba049 <https://github.com/litestar-org/polyfactory/commit/f2ba049b06a0bb74a14c36cc5ef885c0fc8452ab>`_ ... `2e2f11a <https://github.com/litestar-org/polyfactory/commit/2e2f11a8489c09b113a67462221adc3c1450b97b>`_ | `See diff for 2.1.2 <https://github.com/litestar-org/polyfactory/compare/f2ba049b06a0bb74a14c36cc5ef885c0fc8452ab...2e2f11a8489c09b113a67462221adc3c1450b97b>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`9670d27 <https://github.com/litestar-org/polyfactory/commit/9670d27391f75f9f562f0663c2a0b2497d44e990>`_) - Return the correct types in the provider map (#224) by `@guacs <https://github.com/guacs>`_ in `#224 <https://github.com/litestar-org/polyfactory/pull/224>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`02a4c97 <https://github.com/litestar-org/polyfactory/commit/02a4c971ae56758bd625ff54a151a9b4e421a9fa>`_) - Add guacs as a contributor for code (#221) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#221 <https://github.com/litestar-org/polyfactory/pull/221>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`d753504 <https://github.com/litestar-org/polyfactory/commit/d753504ada2efc91b7f7ea94ad5cc10b5ae3322e>`_) - Remove typeddict imports from typing extensions by `@Goldziher <https://github.com/Goldziher>`_
* (`2e2f11a <https://github.com/litestar-org/polyfactory/commit/2e2f11a8489c09b113a67462221adc3c1450b97b>`_) - Resolve pydantic test issues by `@Goldziher <https://github.com/Goldziher>`_
`Release [v2.1.0] - 2023-05-06 <https://github.com/litestar-org/polyfactory/releases/tag/v2.1.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.1.0 <https://github.com/litestar-org/polyfactory/commits/v2.1.0>`_
`d671ac2 <https://github.com/litestar-org/polyfactory/commit/d671ac2470b03411345bf4e57f0531cfa3c4c6f6>`_ ... `47d234b <https://github.com/litestar-org/polyfactory/commit/47d234bc2f36519fc5f5527766272d1e526734f4>`_ | `See diff for 2.1.0 <https://github.com/litestar-org/polyfactory/compare/d671ac2470b03411345bf4e57f0531cfa3c4c6f6...47d234bc2f36519fc5f5527766272d1e526734f4>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`1d5c645 <https://github.com/litestar-org/polyfactory/commit/1d5c645291d6134d0f7f3f8b90a4db206a429a39>`_) - Fix README.md formatting (#197) by `@JacobCoffee <https://github.com/JacobCoffee>`_ in `#197 <https://github.com/litestar-org/polyfactory/pull/197>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`f767011 <https://github.com/litestar-org/polyfactory/commit/f767011835432c55c93429c298262e736d7182ac>`_) - Add sygutss as a contributor for bug (#201) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#201 <https://github.com/litestar-org/polyfactory/pull/201>`_
* (`36ff02e <https://github.com/litestar-org/polyfactory/commit/36ff02e23a22868a0276a0614ce96015ca89b9af>`_) - Add chrisbeardy as a contributor for doc (#207) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#207 <https://github.com/litestar-org/polyfactory/pull/207>`_
Enhancement
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`a62c976 <https://github.com/litestar-org/polyfactory/commit/a62c97672ddfcfc6c7616e6cb6e6bab7efe25b87>`_) - PostGenerated classmethods (#204) by `@gsakkis <https://github.com/gsakkis>`_ in `#204 <https://github.com/litestar-org/polyfactory/pull/204>`_
Fix
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`af36991 <https://github.com/litestar-org/polyfactory/commit/af369911b8523d796fe6be5822aeea77e2b95eeb>`_) - Random union types for dict (#200) by `@sygutss <https://github.com/sygutss>`_ in `#200 <https://github.com/litestar-org/polyfactory/pull/200>`_
`Release [v2.0.1] - 2023-04-28 <https://github.com/litestar-org/polyfactory/releases/tag/v2.0.1>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.0.1 <https://github.com/litestar-org/polyfactory/commits/v2.0.1>`_
`1f8d94c <https://github.com/litestar-org/polyfactory/commit/1f8d94c522556d39b35b1ea0e79155b8e50ac152>`_ ... `d671ac2 <https://github.com/litestar-org/polyfactory/commit/d671ac2470b03411345bf4e57f0531cfa3c4c6f6>`_ | `See diff for 2.0.1 <https://github.com/litestar-org/polyfactory/compare/1f8d94c522556d39b35b1ea0e79155b8e50ac152...d671ac2470b03411345bf4e57f0531cfa3c4c6f6>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`60cdb30 <https://github.com/litestar-org/polyfactory/commit/60cdb30832068ad1643d71632c10490eb7b161e9>`_) - Add mdczaplicki as a contributor for code (#185) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#185 <https://github.com/litestar-org/polyfactory/pull/185>`_
* (`8b5d903 <https://github.com/litestar-org/polyfactory/commit/8b5d90370a53743b63222cec8d210018568f2ffe>`_) - Add przybylop as a contributor for code (#187) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#187 <https://github.com/litestar-org/polyfactory/pull/187>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`16f562f <https://github.com/litestar-org/polyfactory/commit/16f562f0bdf92d991deba79ce3e75d16df776896>`_) - Update maintainers (#194) by `@JacobCoffee <https://github.com/JacobCoffee>`_ in `#194 <https://github.com/litestar-org/polyfactory/pull/194>`_
* (`d671ac2 <https://github.com/litestar-org/polyfactory/commit/d671ac2470b03411345bf4e57f0531cfa3c4c6f6>`_) - Bump release version by `@JacobCoffee <https://github.com/JacobCoffee>`_
`Release [v2.0.0] - 2023-04-16 <https://github.com/litestar-org/polyfactory/releases/tag/v2.0.0>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.0.0 <https://github.com/litestar-org/polyfactory/commits/v2.0.0>`_
`cb71cd0 <https://github.com/litestar-org/polyfactory/commit/cb71cd0d7391cbedeaf5bd3275473fec7ef9347e>`_ ... `1f8d94c <https://github.com/litestar-org/polyfactory/commit/1f8d94c522556d39b35b1ea0e79155b8e50ac152>`_ | `See diff for 2.0.0 <https://github.com/litestar-org/polyfactory/compare/cb71cd0d7391cbedeaf5bd3275473fec7ef9347e...1f8d94c522556d39b35b1ea0e79155b8e50ac152>`_
Bug Fixes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`8097da7 <https://github.com/litestar-org/polyfactory/commit/8097da790a1d4b8c108f268b197ae0ad0c718723>`_) - Update all-contrib placement by `@JacobCoffee <https://github.com/JacobCoffee>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`0814bb8 <https://github.com/litestar-org/polyfactory/commit/0814bb8c10607aa4ade7fb9575ab65d8f04bc3d5>`_) - Add JacobCoffee as a contributor for doc (#170)Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#170 <https://github.com/litestar-org/polyfactory/pull/170>`_
* (`60511c9 <https://github.com/litestar-org/polyfactory/commit/60511c970f1d548b0a498f2d20b358c6798d046c>`_) - Add Goldziher as a contributor for infra, test, and code (#171)Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#171 <https://github.com/litestar-org/polyfactory/pull/171>`_
* (`3853048 <https://github.com/litestar-org/polyfactory/commit/385304873a79f394a74c4dca4048212b224d1adf>`_) - Add provinzkraut as a contributor for code, test, and 6 more (#173) by `@allcontributors[bot] <https://github.com/allcontributors[bot]>`_ in `#173 <https://github.com/litestar-org/polyfactory/pull/173>`_
`Release [v2.0.0alpha1] - 2023-04-11 <https://github.com/litestar-org/polyfactory/releases/tag/v2.0.0alpha1>`_
----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
* `See All commits in v2.0.0alpha1 <https://github.com/litestar-org/polyfactory/commits/v2.0.0alpha1>`_
Docs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`5f111e4 <https://github.com/litestar-org/polyfactory/commit/5f111e45295f63265a1f293aa3b2ab9989bcac7e>`_) - Added Create Factory Method by `@Butch78 <https://github.com/Butch78>`_
* (`b1f83b3 <https://github.com/litestar-org/polyfactory/commit/b1f83b3fdd785ab4df2e7e03e353b9e04acdac30>`_) - Improved Inheritance by `@Butch78 <https://github.com/Butch78>`_
* (`5293860 <https://github.com/litestar-org/polyfactory/commit/52938600016fe16efef8daac23841fb106d8d472>`_) - Improved notes by `@Butch78 <https://github.com/Butch78>`_
Documentation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`7ae2678 <https://github.com/litestar-org/polyfactory/commit/7ae26782508642faab7a100dff3160fd02bacaed>`_) - Explain how to subclass ModelFactory to create your custom extensions by `@lyz-code <https://github.com/lyz-code>`_
* (`218522f <https://github.com/litestar-org/polyfactory/commit/218522f689b5b208f9f7cd6d3763d6a82cc6c442>`_) - Reorder changes in CHANGELOG (#91) by `@ReznikovRoman <https://github.com/ReznikovRoman>`_ in `#91 <https://github.com/litestar-org/polyfactory/pull/91>`_
Features
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`4c2b931 <https://github.com/litestar-org/polyfactory/commit/4c2b93166ced4b7507290dd71a77c1f83631db69>`_) - 2023 Branding by `@JacobCoffee <https://github.com/JacobCoffee>`_
Miscellaneous Tasks
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* (`25570f5 <https://github.com/litestar-org/polyfactory/commit/25570f5929dd644173a90148216c6669cfd0b79f>`_) - Update polyfactory banner logo by `@JacobCoffee <https://github.com/JacobCoffee>`_
Polyfactory Changelog
python-polyfactory-2.21.0/docs/conf.py 0000664 0000000 0000000 00000017126 15000423051 0017712 0 ustar 00root root 0000000 0000000 from __future__ import annotations
import sys
from datetime import datetime
from functools import partial
from typing import TYPE_CHECKING, Any
from unittest import mock
from polyfactory.__metadata__ import __project__, __version__
if TYPE_CHECKING:
from sphinx.addnodes import document # type: ignore[attr-defined]
from sphinx.application import Sphinx
for mod_name in ("beanie", "odmantic"):
sys.modules[mod_name] = mock.Mock()
PY_CLASS = "py:class"
PY_RE = r"py:.*"
# -- Environmental Data ------------------------------------------------------
# -- Project information -----------------------------------------------------
current_year = datetime.now().year
project = __project__
copyright = f"{current_year}, Litestar Organization"
release = __version__
extensions = [
"sphinx.ext.intersphinx",
"sphinx.ext.autosectionlabel",
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx_design",
"auto_pytabs.sphinx_ext",
"sphinx_copybutton",
"sphinx.ext.viewcode",
"sphinx.ext.todo",
"sphinx.ext.viewcode",
"sphinx_toolbox.collapse",
"sphinx_togglebutton",
"sphinx_paramlinks",
]
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"faker": ("https://faker.readthedocs.io/en/master/", None),
"pytest": ("https://docs.pytest.org/en/latest/", None),
"msgspec": ("https://jcristharif.com/msgspec/", None),
}
nitpicky = True
nitpick_ignore = [
(PY_CLASS, "BaseModel"),
(PY_CLASS, "Decimal"),
(PY_CLASS, "Faker"),
(PY_CLASS, "FieldInfo"),
(PY_CLASS, "Random"),
(PY_CLASS, "Scope"),
(PY_CLASS, "T"),
(PY_CLASS, "F"),
(PY_CLASS, "P"),
(PY_CLASS, "P.args"),
(PY_CLASS, "P.kwargs"),
(PY_CLASS, "Self"),
(PY_CLASS, "TypeGuard"),
(PY_CLASS, "date"),
(PY_CLASS, "tzinfo"),
(PY_CLASS, "BeanieDocumentFactory"),
(PY_CLASS, "OdmanticModelFactory"),
(PY_CLASS, "ModelField"),
(PY_CLASS, "Session"),
(PY_CLASS, "AsyncSession"),
]
nitpick_ignore_regex = [
(PY_RE, r"typing_extensions.*"),
(PY_RE, r"polyfactory.*\.T"),
(PY_RE, r"polyfactory.*\.P"),
(PY_RE, r".*TypedDictT"),
(PY_RE, r"pydantic.*"),
(PY_RE, r"msgspec.*"),
]
suppress_warnings = [
"autosectionlabel.*",
"ref.python", # TODO: remove when https://github.com/sphinx-doc/sphinx/issues/4961 is fixed
"config.cache",
]
napoleon_google_docstring = True
napoleon_include_special_with_doc = True
napoleon_use_admonition_for_examples = True
napoleon_use_admonition_for_notes = True
napoleon_use_admonition_for_references = False
napoleon_attr_annotations = True
autoclass_content = "class"
autodoc_class_signature = "separated"
autodoc_default_options = {
"special-members": True,
"show-inheritance": True,
"members": True,
"exclude-members": "__init_subclass__,__weakref__,__subclasshook__",
}
autodoc_member_order = "bysource"
autodoc_typehints_format = "short"
auto_pytabs_min_version = (3, 8)
auto_pytabs_max_version = (3, 11)
auto_pytabs_compat_mode = True
autosectionlabel_prefix_document = True
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
# -- Style configuration -----------------------------------------------------
html_theme = "litestar_sphinx_theme"
html_title = "Polyfactory"
# pygments_style = "lightbulb"
todo_include_todos = True
html_static_path = ["_static"]
templates_path = ["_templates"]
html_js_files = ["versioning.js"]
html_css_files = ["style.css"]
html_show_sourcelink = True
html_copy_source = True
html_context = {
"source_type": "github",
"source_user": "litestar-org",
"source_repo": "polyfactory",
"current_version": "latest",
"versions": [
("latest", "/latest"),
("development", "/main"),
],
"version": release,
}
html_theme_options = {
"logo_target": "/",
"github_repo_name": "polyfactory",
"github_url": "https://github.com/litestar-org/polyfactory",
"navigation_with_keys": True,
"nav_links": [
{"title": "Home", "url": "index"},
{
"title": "Community",
"children": [
{
"title": "Contributing",
"summary": "Learn how to contribute to the Type Lens project",
"url": "contribution-guide",
"icon": "contributing",
},
{
"title": "Code of Conduct",
"summary": "Review the etiquette for interacting with the Litestar community",
"url": "https://github.com/litestar-org/.github?tab=coc-ov-file",
"icon": "coc",
},
{
"title": "Security",
"summary": "Overview of Litestar's security protocols",
"url": "https://github.com/litestar-org/.github?tab=coc-ov-file#security-ov-file",
"icon": "coc",
},
],
},
{
"title": "About",
"children": [
{
"title": "Litestar Organization",
"summary": "Details about the Litestar organization",
"url": "https://litestar.dev/about/organization",
"icon": "org",
},
{
"title": "Releases",
"summary": "Explore the release process, versioning, and deprecation policy for Litestar",
"url": "releases",
"icon": "releases",
},
],
},
{
"title": "Release notes",
"children": [
{
"title": "Changelog",
"url": "changelog",
"summary": "All changes in the current major version",
},
],
},
{
"title": "Help",
"children": [
{
"title": "Discord Help Forum",
"summary": "Dedicated Discord help forum",
"url": "https://discord.gg/litestar",
"icon": "coc",
},
{
"title": "GitHub Discussions",
"summary": "GitHub Discussions",
"url": "https://github.com/litestar-org/polyfactory/discussions",
"icon": "coc",
},
{
"title": "Stack Overflow",
"summary": "We monitor the <code><b>polyfactory</b></code> tag on Stack Overflow",
"url": "https://stackoverflow.com/questions/tagged/polyfactory",
"icon": "coc",
},
],
},
{"title": "Sponsor", "url": "https://github.com/sponsors/Litestar-Org", "icon": "heart"},
],
}
def update_html_context(
app: Sphinx,
pagename: str,
templatename: str,
context: dict[str, Any],
doctree: document,
) -> None:
context["generate_toctree_html"] = partial(context["generate_toctree_html"], startdepth=0)
def delayed_setup(app: Sphinx) -> None:
"""When running linkcheck Shibuya causes a build failure, and checking
the builder in the initial `setup` function call is not possible, so the check
and extension setup has to be delayed until the builder is initialized.
"""
if app.builder.name == "linkcheck":
return
app.setup_extension("shibuya")
def setup(app: Sphinx) -> dict[str, bool]:
app.connect("builder-inited", delayed_setup, priority=0)
app.setup_extension("litestar_sphinx_theme")
return {"parallel_read_safe": True, "parallel_write_safe": True}
python-polyfactory-2.21.0/docs/contribution-guide.rst 0000664 0000000 0000000 00000000053 15000423051 0022746 0 ustar 00root root 0000000 0000000 :orphan:
.. include:: ../CONTRIBUTING.rst
python-polyfactory-2.21.0/docs/examples/ 0000775 0000000 0000000 00000000000 15000423051 0020222 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/__init__.py 0000664 0000000 0000000 00000000000 15000423051 0022321 0 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/configuration/ 0000775 0000000 0000000 00000000000 15000423051 0023071 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/configuration/__init__.py 0000664 0000000 0000000 00000000000 15000423051 0025170 0 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/configuration/test_example_1.py 0000664 0000000 0000000 00000001221 15000423051 0026351 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from polyfactory.factories import DataclassFactory
@dataclass
class Person:
name: str
age: float
height: float
weight: float
class PersonFactory(DataclassFactory[Person]):
__random_seed__ = 1
@classmethod
def name(cls) -> str:
return cls.__random__.choice(["John", "Alice", "George"])
def test_random_seed() -> None:
# the outcome of 'factory.__random__.choice' is deterministic, because Random has been seeded with a set value.
assert PersonFactory.build().name == "John"
assert PersonFactory.build().name == "George"
assert PersonFactory.build().name == "John"
python-polyfactory-2.21.0/docs/examples/configuration/test_example_10.py 0000664 0000000 0000000 00000000642 15000423051 0026437 0 ustar 00root root 0000000 0000000 from pydantic import BaseModel, Field
from polyfactory.factories.pydantic_factory import ModelFactory
class Payment(BaseModel):
amount: int = Field(0)
currency: str = Field(examples=["USD", "EUR", "INR"])
class PaymentFactory(ModelFactory[Payment]):
__use_examples__ = True
def test_use_examples() -> None:
instance = PaymentFactory.build()
assert instance.currency in ["USD", "EUR", "INR"]
python-polyfactory-2.21.0/docs/examples/configuration/test_example_2.py 0000664 0000000 0000000 00000001261 15000423051 0026356 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from random import Random
from polyfactory.factories import DataclassFactory
@dataclass
class Person:
name: str
age: float
height: float
weight: float
class PersonFactory(DataclassFactory[Person]):
__random__ = Random(10)
@classmethod
def name(cls) -> str:
return cls.__random__.choice(["John", "Alice", "George"])
def test_setting_random() -> None:
# the outcome of 'factory.__random__.choice' is deterministic, because Random is configured with a set value.
assert PersonFactory.build().name == "George"
assert PersonFactory.build().name == "John"
assert PersonFactory.build().name == "Alice"
python-polyfactory-2.21.0/docs/examples/configuration/test_example_3.py 0000664 0000000 0000000 00000001123 15000423051 0026354 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from faker import Faker
from polyfactory.factories import DataclassFactory
@dataclass
class Person:
name: str
age: float
height: float
weight: float
class PersonFactory(DataclassFactory[Person]):
__faker__ = Faker(locale="es_ES")
__random_seed__ = 10
@classmethod
def name(cls) -> str:
return cls.__faker__.name()
def test_setting_faker() -> None:
# the outcome of faker deterministic because we seeded random, and it uses a spanish locale.
assert PersonFactory.build().name == "Alejandra Romeu-Tolosa"
python-polyfactory-2.21.0/docs/examples/configuration/test_example_4.py 0000664 0000000 0000000 00000005057 15000423051 0026367 0 ustar 00root root 0000000 0000000 from asyncio import sleep
from dataclasses import dataclass
from typing import Dict, List
from uuid import UUID
from polyfactory import AsyncPersistenceProtocol, SyncPersistenceProtocol
from polyfactory.factories import DataclassFactory
@dataclass
class Person:
id: UUID
name: str
# we will use a dictionary to persist values for the example
mock_db: Dict[UUID, Person] = {}
class SyncPersistenceHandler(SyncPersistenceProtocol[Person]):
def save(self, data: Person) -> Person:
# do stuff here to persist the value, such as use an ORM or ODM, cache in redis etc.
# in our case we simply save it in the dictionary.
mock_db[data.id] = data
return data
def save_many(self, data: List[Person]) -> List[Person]:
# same as for save, here we should store the list in persistence.
# in this case, we use the same dictionary.
for person in data:
mock_db[person.id] = person
return data
class AsyncPersistenceHandler(AsyncPersistenceProtocol[Person]):
async def save(self, data: Person) -> Person:
# do stuff here to persist the value using an async method, such as an async ORM or ODM.
# in our case we simply save it in the dictionary and add a minimal sleep to mock async.
mock_db[data.id] = data
await sleep(0.0001)
return data
async def save_many(self, data: List[Person]) -> List[Person]:
# same as for the async save, here we should store the list in persistence using async logic.
# we again store in dict, and mock async using sleep.
for person in data:
mock_db[person.id] = person
await sleep(0.0001)
return data
class PersonFactory(DataclassFactory[Person]):
__sync_persistence__ = SyncPersistenceHandler
__async_persistence__ = AsyncPersistenceHandler
def test_sync_persistence_build() -> None:
person_instance = PersonFactory.create_sync()
assert mock_db[person_instance.id] is person_instance
def test_sync_persistence_batch() -> None:
person_batch = PersonFactory.create_batch_sync(10)
for person_instance in person_batch:
assert mock_db[person_instance.id] is person_instance
async def test_async_persistence_build() -> None:
person_instance = await PersonFactory.create_async()
assert mock_db[person_instance.id] is person_instance
async def test_async_persistence_batch() -> None:
person_batch = await PersonFactory.create_batch_async(10)
for person_instance in person_batch:
assert mock_db[person_instance.id] is person_instance
python-polyfactory-2.21.0/docs/examples/configuration/test_example_5.py 0000664 0000000 0000000 00000001744 15000423051 0026367 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from datetime import date, datetime
from enum import Enum
from typing import Any, Dict, List, Union
from uuid import UUID
from polyfactory import Use
from polyfactory.factories import DataclassFactory
class Species(str, Enum):
CAT = "Cat"
DOG = "Dog"
@dataclass
class Pet:
name: str
species: Species
sound: str
@dataclass
class Person:
id: UUID
name: str
hobbies: List[str]
age: Union[float, int]
birthday: Union[datetime, date]
pets: List[Pet]
assets: List[Dict[str, Dict[str, Any]]]
class PetFactory(DataclassFactory[Pet]):
__set_as_default_factory_for_type__ = True
name = Use(DataclassFactory.__random__.choice, ["Roxy", "Spammy", "Moshe"])
class PersonFactory(DataclassFactory[Person]): ...
def test_default_pet_factory() -> None:
person_instance = PersonFactory.build()
assert len(person_instance.pets) > 0
assert person_instance.pets[0].name in ["Roxy", "Spammy", "Moshe"]
python-polyfactory-2.21.0/docs/examples/configuration/test_example_6.py 0000664 0000000 0000000 00000000672 15000423051 0026367 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from typing import Tuple
from polyfactory.factories import DataclassFactory
@dataclass
class Owner:
cars: Tuple[str, ...]
class OwnerFactory(DataclassFactory[Owner]):
__randomize_collection_length__ = True
__min_collection_length__ = 2
__max_collection_length__ = 5
def test_randomized_collection_length() -> None:
owner = OwnerFactory.build()
assert 2 <= len(owner.cars) <= 5
python-polyfactory-2.21.0/docs/examples/configuration/test_example_7.py 0000664 0000000 0000000 00000000671 15000423051 0026367 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from typing import Optional
from uuid import UUID
from polyfactory.factories.dataclass_factory import DataclassFactory
@dataclass
class Person:
id: UUID
name: Optional[str]
class PersonFactory(DataclassFactory[Person]):
__allow_none_optionals__ = False
def test_optional_type_ignored() -> None:
person_instance = PersonFactory.build()
assert isinstance(person_instance.name, str)
python-polyfactory-2.21.0/docs/examples/configuration/test_example_8.py 0000664 0000000 0000000 00000001140 15000423051 0026360 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from uuid import UUID
import pytest
from polyfactory import ConfigurationException, PostGenerated
from polyfactory.factories.dataclass_factory import DataclassFactory
@dataclass
class Person:
id: UUID
def test_check_factory_fields() -> None:
with pytest.raises(
ConfigurationException,
match="unknown_field is declared on the factory PersonFactory but it is not part of the model Person",
):
class PersonFactory(DataclassFactory[Person]):
__check_model__ = True
unknown_field = PostGenerated(lambda: "foo")
python-polyfactory-2.21.0/docs/examples/configuration/test_example_9.py 0000664 0000000 0000000 00000000751 15000423051 0026370 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from enum import Enum
from polyfactory.factories import DataclassFactory
class Species(str, Enum):
CAT = "Cat"
DOG = "Dog"
@dataclass
class Pet:
name: str
sound: str = "meow"
species: Species = Species.CAT
class PetFactory(DataclassFactory[Pet]):
__model__ = Pet
__use_defaults__ = True
def test_use_default() -> None:
pet = PetFactory.build()
assert pet.species == Species.CAT
assert pet.sound == "meow"
python-polyfactory-2.21.0/docs/examples/creating_base_factories/ 0000775 0000000 0000000 00000000000 15000423051 0025047 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/creating_base_factories/__init__.py 0000664 0000000 0000000 00000000000 15000423051 0027146 0 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/declaring_factories/ 0000775 0000000 0000000 00000000000 15000423051 0024211 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/declaring_factories/__init__.py 0000664 0000000 0000000 00000000000 15000423051 0026310 0 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/declaring_factories/test_example_1.py 0000664 0000000 0000000 00000001102 15000423051 0027467 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from polyfactory.factories import DataclassFactory
@dataclass
class Person:
name: str
age: float
height: float
weight: float
class PersonFactory(DataclassFactory[Person]):
__model__ = Person
def test_is_person() -> None:
person_instance = PersonFactory.build()
assert isinstance(person_instance, Person)
assert isinstance(person_instance.name, str)
assert isinstance(person_instance.age, float)
assert isinstance(person_instance.height, float)
assert isinstance(person_instance.weight, float)
python-polyfactory-2.21.0/docs/examples/declaring_factories/test_example_2.py 0000664 0000000 0000000 00000001104 15000423051 0027472 0 ustar 00root root 0000000 0000000 from typing import TypedDict
from polyfactory.factories import TypedDictFactory
class Person(TypedDict):
name: str
age: float
height: float
weight: float
class PersonFactory(TypedDictFactory[Person]): ...
def test_is_person() -> None:
person_instance = PersonFactory.build()
assert isinstance(person_instance, dict)
assert isinstance(person_instance.get("name"), str)
assert isinstance(person_instance.get("age"), float)
assert isinstance(person_instance.get("height"), float)
assert isinstance(person_instance.get("weight"), float)
python-polyfactory-2.21.0/docs/examples/declaring_factories/test_example_3.py 0000664 0000000 0000000 00000001065 15000423051 0027501 0 ustar 00root root 0000000 0000000 from pydantic import BaseModel
from polyfactory.factories.pydantic_factory import ModelFactory
class Person(BaseModel):
name: str
age: float
height: float
weight: float
class PersonFactory(ModelFactory[Person]): ...
def test_is_person() -> None:
person_instance = PersonFactory.build()
assert isinstance(person_instance, Person)
assert isinstance(person_instance.name, str)
assert isinstance(person_instance.age, float)
assert isinstance(person_instance.height, float)
assert isinstance(person_instance.weight, float)
python-polyfactory-2.21.0/docs/examples/declaring_factories/test_example_4.py 0000664 0000000 0000000 00000001070 15000423051 0027476 0 ustar 00root root 0000000 0000000 from pydantic.dataclasses import dataclass
from polyfactory.factories import DataclassFactory
@dataclass
class Person:
name: str
age: float
height: float
weight: float
class PersonFactory(DataclassFactory[Person]): ...
def test_is_person() -> None:
person_instance = PersonFactory.build()
assert isinstance(person_instance, Person)
assert isinstance(person_instance.name, str)
assert isinstance(person_instance.age, float)
assert isinstance(person_instance.height, float)
assert isinstance(person_instance.weight, float)
python-polyfactory-2.21.0/docs/examples/declaring_factories/test_example_5.py 0000664 0000000 0000000 00000001421 15000423051 0027477 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from datetime import date, datetime
from enum import Enum
from typing import Any, Dict, List, Union
from uuid import UUID
from polyfactory.factories import DataclassFactory
class Species(str, Enum):
CAT = "Cat"
DOG = "Dog"
@dataclass
class Pet:
name: str
species: Species
sound: str
@dataclass
class Person:
id: UUID
name: str
hobbies: List[str]
age: Union[float, int]
birthday: Union[datetime, date]
pets: List[Pet]
assets: List[Dict[str, Dict[str, Any]]]
class PersonFactory(DataclassFactory[Person]): ...
def test_dynamic_factory_generation() -> None:
person_instance = PersonFactory.build()
assert len(person_instance.pets) > 0
assert isinstance(person_instance.pets[0], Pet)
python-polyfactory-2.21.0/docs/examples/declaring_factories/test_example_6.py 0000664 0000000 0000000 00000000661 15000423051 0027505 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from enum import Enum
from polyfactory.factories import DataclassFactory
class Species(str, Enum):
CAT = "Cat"
DOG = "Dog"
@dataclass
class Pet:
name: str
species: Species
sound: str
def test_imperative_factory_creation() -> None:
pet_factory = DataclassFactory.create_factory(model=Pet)
pet_instance = pet_factory.build()
assert isinstance(pet_instance, Pet)
python-polyfactory-2.21.0/docs/examples/declaring_factories/test_example_7.py 0000664 0000000 0000000 00000001146 15000423051 0027505 0 ustar 00root root 0000000 0000000 from datetime import date, datetime
from typing import Any, Dict, List, Union
from uuid import UUID
import attrs
from polyfactory.factories.attrs_factory import AttrsFactory
@attrs.define
class Person:
id: UUID
name: str
hobbies: List[str]
age: Union[float, int]
# an aliased variable
birthday: Union[datetime, date] = attrs.field(alias="date_of_birth")
# a "private" variable
_assets: List[Dict[str, Dict[str, Any]]]
class PersonFactory(AttrsFactory[Person]): ...
def test_person_factory() -> None:
person = PersonFactory.build()
assert isinstance(person, Person)
python-polyfactory-2.21.0/docs/examples/declaring_factories/test_example_8.py 0000664 0000000 0000000 00000001121 15000423051 0027477 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from enum import Enum
from polyfactory.factories import DataclassFactory
class Species(str, Enum):
CAT = "Cat"
DOG = "Dog"
RABBIT = "Rabbit"
MOUSE = "Mouse"
@dataclass
class Pet:
name: str
species: Species
sound: str
def test_imperative_sub_factory_creation() -> None:
pet_factory = DataclassFactory.create_factory(model=Pet)
cat_factory = pet_factory.create_factory(species=Species.CAT)
cat_instance = cat_factory.build()
assert isinstance(cat_instance, Pet)
assert cat_instance.species == Species.CAT
python-polyfactory-2.21.0/docs/examples/decorators/ 0000775 0000000 0000000 00000000000 15000423051 0022367 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/decorators/test_example_1.py 0000664 0000000 0000000 00000001360 15000423051 0025653 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass, field
from datetime import datetime, timedelta
from polyfactory.decorators import post_generated
from polyfactory.factories import DataclassFactory
@dataclass
class DatetimeRange:
to_dt: datetime
from_dt: datetime = field(default_factory=datetime.now)
class DatetimeRangeFactory(DataclassFactory[DatetimeRange]):
@post_generated
@classmethod
def to_dt(cls, from_dt: datetime) -> datetime:
return from_dt + cls.__faker__.time_delta("+3d")
def test_post_generated() -> None:
date_range_instance = DatetimeRangeFactory.build()
assert date_range_instance.to_dt > date_range_instance.from_dt
assert date_range_instance.to_dt < date_range_instance.from_dt + timedelta(days=3)
python-polyfactory-2.21.0/docs/examples/fields/ 0000775 0000000 0000000 00000000000 15000423051 0021470 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/fields/__init__.py 0000664 0000000 0000000 00000000000 15000423051 0023567 0 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/fields/test_example_1.py 0000664 0000000 0000000 00000001546 15000423051 0024762 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from datetime import date, datetime
from enum import Enum
from typing import Any, Dict, List, Union
from uuid import UUID
from polyfactory.factories import DataclassFactory
class Species(str, Enum):
CAT = "Cat"
DOG = "Dog"
@dataclass
class Pet:
name: str
species: Species
sound: str
@dataclass
class Person:
id: UUID
name: str
hobbies: List[str]
age: Union[float, int]
birthday: Union[datetime, date]
pets: List[Pet]
assets: List[Dict[str, Dict[str, Any]]]
pet_instance = Pet(name="Roxy", sound="woof woof", species=Species.DOG)
class PersonFactory(DataclassFactory[Person]):
pets = [pet_instance]
def test_is_pet_instance() -> None:
person_instance = PersonFactory.build()
assert len(person_instance.pets) == 1
assert person_instance.pets[0] == pet_instance
python-polyfactory-2.21.0/docs/examples/fields/test_example_2.py 0000664 0000000 0000000 00000002025 15000423051 0024754 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from datetime import date, datetime
from enum import Enum
from typing import Any, Dict, List, Union
from uuid import UUID
from polyfactory import Use
from polyfactory.factories import DataclassFactory
class Species(str, Enum):
CAT = "Cat"
DOG = "Dog"
@dataclass
class Pet:
name: str
species: Species
sound: str
@dataclass
class Person:
id: UUID
name: str
hobbies: List[str]
age: Union[float, int]
birthday: Union[datetime, date]
pets: List[Pet]
assets: List[Dict[str, Dict[str, Any]]]
class PetFactory(DataclassFactory[Pet]):
name = Use(DataclassFactory.__random__.choice, ["Ralph", "Roxy"])
species = Use(DataclassFactory.__random__.choice, list(Species))
class PersonFactory(DataclassFactory[Person]):
pets = Use(PetFactory.batch, size=2)
def test_pet_choices() -> None:
person_instance = PersonFactory.build()
assert len(person_instance.pets) == 2
assert all(pet.name in ["Ralph", "Roxy"] for pet in person_instance.pets)
python-polyfactory-2.21.0/docs/examples/fields/test_example_3.py 0000664 0000000 0000000 00000002033 15000423051 0024754 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from datetime import date, datetime
from enum import Enum
from typing import Any, Dict, List, Union
from uuid import UUID
from polyfactory import Use
from polyfactory.factories import DataclassFactory
class Species(str, Enum):
CAT = "Cat"
DOG = "Dog"
@dataclass
class Pet:
name: str
species: Species
sound: str
@dataclass
class Person:
id: UUID
name: str
hobbies: List[str]
age: Union[float, int]
birthday: Union[datetime, date]
pets: List[Pet]
assets: List[Dict[str, Dict[str, Any]]]
class PetFactory(DataclassFactory[Pet]):
name = lambda: DataclassFactory.__random__.choice(["Ralph", "Roxy"])
species = lambda: DataclassFactory.__random__.choice(list(Species))
class PersonFactory(DataclassFactory[Person]):
pets = Use(PetFactory.batch, size=2)
def test_pet_choices() -> None:
person_instance = PersonFactory.build()
assert len(person_instance.pets) == 2
assert all(pet.name in ["Ralph", "Roxy"] for pet in person_instance.pets)
python-polyfactory-2.21.0/docs/examples/fields/test_example_4.py 0000664 0000000 0000000 00000002120 15000423051 0024752 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from datetime import date, datetime
from enum import Enum
from typing import Any, Dict, List, Union
from uuid import UUID
from polyfactory import Use
from polyfactory.factories import DataclassFactory
class Species(str, Enum):
CAT = "Cat"
DOG = "Dog"
@dataclass
class Pet:
name: str
species: Species
sound: str
@dataclass
class Person:
id: UUID
name: str
hobbies: List[str]
age: Union[float, int]
birthday: Union[datetime, date]
pets: List[Pet]
assets: List[Dict[str, Dict[str, Any]]]
class PetFactory(DataclassFactory[Pet]):
@classmethod
def name(cls) -> str:
return cls.__random__.choice(["Ralph", "Roxy"])
@classmethod
def species(cls) -> str:
return cls.__random__.choice(list(Species))
class PersonFactory(DataclassFactory[Person]):
pets = Use(PetFactory.batch, size=2)
def test_pet_choices() -> None:
person_instance = PersonFactory.build()
assert len(person_instance.pets) == 2
assert all(pet.name in ["Ralph", "Roxy"] for pet in person_instance.pets)
python-polyfactory-2.21.0/docs/examples/fields/test_example_5.py 0000664 0000000 0000000 00000000615 15000423051 0024762 0 ustar 00root root 0000000 0000000 from typing import TypedDict
from polyfactory import Ignore
from polyfactory.factories import TypedDictFactory
class Person(TypedDict):
id: int
name: str
class PersonFactory(TypedDictFactory[Person]):
id = Ignore()
def test_id_is_ignored() -> None:
person_instance = PersonFactory.build()
assert person_instance.get("name")
assert person_instance.get("id") is None
python-polyfactory-2.21.0/docs/examples/fields/test_example_6.py 0000664 0000000 0000000 00000001230 15000423051 0024755 0 ustar 00root root 0000000 0000000 from typing import TypedDict
import pytest
from polyfactory import Require
from polyfactory.exceptions import MissingBuildKwargException
from polyfactory.factories import TypedDictFactory
class Person(TypedDict):
id: int
name: str
class PersonFactory(TypedDictFactory[Person]):
id = Require()
def test_id_is_required() -> None:
# this will not raise an exception
person_instance = PersonFactory.build(id=1)
assert person_instance.get("name")
assert person_instance.get("id") == 1
# but when no kwarg is passed, an exception will be raised:
with pytest.raises(MissingBuildKwargException):
PersonFactory.build()
python-polyfactory-2.21.0/docs/examples/fields/test_example_7.py 0000664 0000000 0000000 00000001376 15000423051 0024771 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass, field
from datetime import datetime, timedelta
from typing import Any, Dict
from polyfactory import PostGenerated
from polyfactory.factories import DataclassFactory
def add_timedelta(name: str, values: Dict[str, datetime], *args: Any, **kwargs: Any) -> datetime:
delta = timedelta(days=1)
return values["from_dt"] + delta
@dataclass
class DatetimeRange:
to_dt: datetime
from_dt: datetime = field(default_factory=datetime.now)
class DatetimeRangeFactory(DataclassFactory[DatetimeRange]):
to_dt = PostGenerated(add_timedelta)
def test_post_generated() -> None:
date_range_instance = DatetimeRangeFactory.build()
assert date_range_instance.to_dt == date_range_instance.from_dt + timedelta(days=1)
python-polyfactory-2.21.0/docs/examples/fields/test_example_8.py 0000664 0000000 0000000 00000002035 15000423051 0024763 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from datetime import date, datetime
from enum import Enum
from typing import Any, Dict, List, Union
from uuid import UUID
from polyfactory.factories import DataclassFactory
class Species(str, Enum):
CAT = "Cat"
DOG = "Dog"
@dataclass
class Pet:
name: str
species: Species
sound: str
@dataclass
class Person:
id: UUID
name: str
hobbies: List[str]
age: Union[float, int]
birthday: Union[datetime, date]
pet: Pet
assets: List[Dict[str, Dict[str, Any]]]
class PetFactory(DataclassFactory[Pet]):
name = lambda: DataclassFactory.__random__.choice(["Ralph", "Roxy"])
class PersonFactory(DataclassFactory[Person]):
pet = PetFactory
def test_subfactory() -> None:
person_instance = PersonFactory.build()
assert isinstance(person_instance.pet, Pet)
assert person_instance.pet.name in ["Ralph", "Roxy"]
person_instance_with_pet_name = PersonFactory.build(pet={"name": "Winston"})
assert person_instance_with_pet_name.pet.name == "Winston"
python-polyfactory-2.21.0/docs/examples/fields/test_example_sqla_pre_fetched_data.py 0000664 0000000 0000000 00000003241 15000423051 0031075 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from sqlalchemy import ForeignKey, select
from sqlalchemy.ext.asyncio import AsyncSession, create_async_engine
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
from polyfactory.factories.sqlalchemy_factory import SQLAlchemyFactory
async_engine = create_async_engine("sqlite+aiosqlite:///:memory:")
class Base(DeclarativeBase): ...
class User(Base):
__tablename__ = "users"
id: Mapped[int] = mapped_column(primary_key=True)
class Department(Base):
__tablename__ = "departments"
id: Mapped[int] = mapped_column(primary_key=True)
director_id: Mapped[str] = mapped_column(ForeignKey("users.id"))
class UserFactory(SQLAlchemyFactory[User]): ...
class DepartmentFactory(SQLAlchemyFactory[Department]): ...
async def get_director_ids() -> int:
async with AsyncSession(async_engine) as session:
result = (await session.scalars(select(User.id))).all()
return UserFactory.__random__.choice(result)
async def test_factory_with_pre_fetched_async_data() -> None:
async with async_engine.begin() as conn:
await conn.run_sync(Base.metadata.drop_all)
await conn.run_sync(Base.metadata.create_all)
async with AsyncSession(async_engine) as session:
UserFactory.__async_session__ = session
await UserFactory.create_batch_async(3)
async with AsyncSession(async_engine) as session:
DepartmentFactory.__async_session__ = session
department = await DepartmentFactory.create_async(director_id=await get_director_ids())
user = await session.scalar(select(User).where(User.id == department.director_id))
assert isinstance(user, User)
python-polyfactory-2.21.0/docs/examples/fixtures/ 0000775 0000000 0000000 00000000000 15000423051 0022073 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/fixtures/__init__.py 0000664 0000000 0000000 00000000000 15000423051 0024172 0 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/fixtures/test_example_1.py 0000664 0000000 0000000 00000001435 15000423051 0025362 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from datetime import date, datetime
from typing import List, Optional, Union
from uuid import UUID
from polyfactory.factories import DataclassFactory
from polyfactory.pytest_plugin import register_fixture
@dataclass
class Person:
id: UUID
name: str
hobbies: Optional[List[str]]
nicks: List[str]
age: Union[float, int]
birthday: Union[datetime, date]
@register_fixture
class PersonFactory(DataclassFactory[Person]): ...
def test_person_factory(person_factory: PersonFactory) -> None:
person_instance = person_factory.build()
assert isinstance(person_instance, Person)
# The factory class itself can still be used
another_person_instance = PersonFactory.build()
assert isinstance(another_person_instance, Person)
python-polyfactory-2.21.0/docs/examples/fixtures/test_example_2.py 0000664 0000000 0000000 00000001220 15000423051 0025353 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from datetime import date, datetime
from typing import List, Optional, Union
from uuid import UUID
from polyfactory.factories import DataclassFactory
from polyfactory.pytest_plugin import register_fixture
@dataclass
class Person:
id: UUID
name: str
hobbies: Optional[List[str]]
nicks: List[str]
age: Union[float, int]
birthday: Union[datetime, date]
class PersonFactory(DataclassFactory[Person]): ...
register_fixture(PersonFactory)
def test_person_factory(person_factory: PersonFactory) -> None:
person_instance = person_factory.build()
assert isinstance(person_instance, Person)
python-polyfactory-2.21.0/docs/examples/fixtures/test_example_3.py 0000664 0000000 0000000 00000001257 15000423051 0025366 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from datetime import date, datetime
from typing import List, Optional, Union
from uuid import UUID
from polyfactory.factories import DataclassFactory
from polyfactory.pytest_plugin import register_fixture
@dataclass
class Person:
id: UUID
name: str
hobbies: Optional[List[str]]
nicks: List[str]
age: Union[float, int]
birthday: Union[datetime, date]
@register_fixture(name="aliased_person_factory")
class PersonFactory(DataclassFactory[Person]): ...
def test_person_factory(aliased_person_factory: PersonFactory) -> None:
person_instance = aliased_person_factory.build()
assert isinstance(person_instance, Person)
python-polyfactory-2.21.0/docs/examples/handling_custom_types/ 0000775 0000000 0000000 00000000000 15000423051 0024624 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/handling_custom_types/__init__.py 0000664 0000000 0000000 00000000000 15000423051 0026723 0 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/handling_custom_types/test_example_1.py 0000664 0000000 0000000 00000002304 15000423051 0030107 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from typing import Any, Dict, Type
from uuid import UUID
from polyfactory.factories import DataclassFactory
# we created a special class we will use in our code
class CustomSecret:
def __init__(self, value: str) -> None:
self.value = value
def __repr__(self) -> str:
return "*" * len(self.value)
def __str__(self) -> str:
return "*" * len(self.value)
@dataclass
class Person:
id: UUID
secret: CustomSecret
# by default the factory class cannot handle unknown types,
# so we need to override the provider map to add it:
class PersonFactory(DataclassFactory[Person]):
@classmethod
def get_provider_map(cls) -> Dict[Type, Any]:
providers_map = super().get_provider_map()
return {
CustomSecret: lambda: CustomSecret("jeronimo"),
**providers_map,
}
def test_custom_secret_creation() -> None:
person_instance = PersonFactory.build()
assert isinstance(person_instance.secret, CustomSecret)
assert repr(person_instance.secret) == "*" * len("jeronimo")
assert str(person_instance.secret) == "*" * len("jeronimo")
assert person_instance.secret.value == "jeronimo"
python-polyfactory-2.21.0/docs/examples/handling_custom_types/test_example_2.py 0000664 0000000 0000000 00000002605 15000423051 0030114 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from typing import Any, Dict, Generic, Type, TypeVar
from uuid import UUID
from polyfactory.factories import DataclassFactory
# we created a special class we will use in our code
class CustomSecret:
def __init__(self, value: str) -> None:
self.value = value
def __repr__(self) -> str:
return "*" * len(self.value)
def __str__(self) -> str:
return "*" * len(self.value)
T = TypeVar("T")
# we create a custom base factory to handle dataclasses, with an extended provider map
class CustomDataclassFactory(Generic[T], DataclassFactory[T]):
__is_base_factory__ = True
@classmethod
def get_provider_map(cls) -> Dict[Type, Any]:
providers_map = super().get_provider_map()
return {
CustomSecret: lambda: CustomSecret("jeronimo"),
**providers_map,
}
@dataclass
class Person:
id: UUID
secret: CustomSecret
# we use our CustomDataclassFactory as a base for the PersonFactory
class PersonFactory(CustomDataclassFactory[Person]): ...
def test_custom_dataclass_base_factory() -> None:
person_instance = PersonFactory.build()
assert isinstance(person_instance.secret, CustomSecret)
assert repr(person_instance.secret) == "*" * len("jeronimo")
assert str(person_instance.secret) == "*" * len("jeronimo")
assert person_instance.secret.value == "jeronimo"
python-polyfactory-2.21.0/docs/examples/handling_custom_types/test_example_3.py 0000664 0000000 0000000 00000002132 15000423051 0030110 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from typing import TypeVar
from uuid import UUID
from polyfactory.factories import DataclassFactory
from polyfactory.factories.base import BaseFactory
# we created a special class we will use in our code
class CustomSecret:
def __init__(self, value: str) -> None:
self.value = value
def __repr__(self) -> str:
return "*" * len(self.value)
def __str__(self) -> str:
return "*" * len(self.value)
T = TypeVar("T")
# we add a function to generate the custom type
BaseFactory.add_provider(CustomSecret, lambda: CustomSecret("jeronimo"))
@dataclass
class Person:
id: UUID
secret: CustomSecret
# we don't have to use a custom base factory!
class PersonFactory(DataclassFactory[Person]): ...
def test_custom_dataclass_base_factory() -> None:
person_instance = PersonFactory.build()
assert isinstance(person_instance.secret, CustomSecret)
assert repr(person_instance.secret) == "*" * len("jeronimo")
assert str(person_instance.secret) == "*" * len("jeronimo")
assert person_instance.secret.value == "jeronimo"
python-polyfactory-2.21.0/docs/examples/library_factories/ 0000775 0000000 0000000 00000000000 15000423051 0023725 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/library_factories/__init__.py 0000664 0000000 0000000 00000000000 15000423051 0026024 0 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/library_factories/sqlalchemy_factory/ 0000775 0000000 0000000 00000000000 15000423051 0027616 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/library_factories/sqlalchemy_factory/__init__.py 0000664 0000000 0000000 00000000000 15000423051 0031715 0 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/library_factories/sqlalchemy_factory/conftest.py 0000664 0000000 0000000 00000000462 15000423051 0032017 0 ustar 00root root 0000000 0000000 from collections.abc import Iterable
import pytest
from docs.examples.library_factories.sqlalchemy_factory.test_example_4 import BaseFactory
@pytest.fixture(scope="module")
def _remove_default_factories() -> Iterable[None]:
yield
BaseFactory._base_factories.remove(BaseFactory) # noqa: SLF001
python-polyfactory-2.21.0/docs/examples/library_factories/sqlalchemy_factory/test_example_1.py 0000664 0000000 0000000 00000000720 15000423051 0033101 0 ustar 00root root 0000000 0000000 from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
from polyfactory.factories.sqlalchemy_factory import SQLAlchemyFactory
class Base(DeclarativeBase): ...
class Author(Base):
__tablename__ = "authors"
id: Mapped[int] = mapped_column(primary_key=True)
name: Mapped[str]
class AuthorFactory(SQLAlchemyFactory[Author]): ...
def test_sqla_factory() -> None:
author = AuthorFactory.build()
assert isinstance(author, Author)
python-polyfactory-2.21.0/docs/examples/library_factories/sqlalchemy_factory/test_example_2.py 0000664 0000000 0000000 00000002036 15000423051 0033104 0 ustar 00root root 0000000 0000000 from typing import List
from sqlalchemy import ForeignKey
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship
from polyfactory.factories.sqlalchemy_factory import SQLAlchemyFactory
class Base(DeclarativeBase): ...
class Author(Base):
__tablename__ = "authors"
id: Mapped[int] = mapped_column(primary_key=True)
name: Mapped[str]
books: Mapped[List["Book"]] = relationship("Book", uselist=True)
class Book(Base):
__tablename__ = "books"
id: Mapped[int] = mapped_column(primary_key=True)
author_id: Mapped[int] = mapped_column(ForeignKey(Author.id))
class AuthorFactory(SQLAlchemyFactory[Author]): ...
class AuthorFactoryWithRelationship(SQLAlchemyFactory[Author]):
__set_relationships__ = True
def test_sqla_factory() -> None:
author = AuthorFactory.build()
assert author.books == []
def test_sqla_factory_with_relationship() -> None:
author = AuthorFactoryWithRelationship.build()
assert isinstance(author, Author)
assert isinstance(author.books[0], Book)
python-polyfactory-2.21.0/docs/examples/library_factories/sqlalchemy_factory/test_example_3.py 0000664 0000000 0000000 00000002110 15000423051 0033076 0 ustar 00root root 0000000 0000000 from typing import List
from sqlalchemy import ForeignKey, create_engine
from sqlalchemy.orm import DeclarativeBase, Mapped, Session, mapped_column, relationship
from polyfactory.factories.sqlalchemy_factory import SQLAlchemyFactory
class Base(DeclarativeBase): ...
class Author(Base):
__tablename__ = "authors"
id: Mapped[int] = mapped_column(primary_key=True)
name: Mapped[str]
books: Mapped[List["Book"]] = relationship("Book", uselist=True)
class Book(Base):
__tablename__ = "books"
id: Mapped[int] = mapped_column(primary_key=True)
author_id: Mapped[int] = mapped_column(ForeignKey(Author.id))
class AuthorFactory(SQLAlchemyFactory[Author]):
__set_relationships__ = True
def test_sqla_factory_persistence() -> None:
engine = create_engine("sqlite:///:memory:")
Base.metadata.create_all(engine)
session = Session(engine)
AuthorFactory.__session__ = session # Or using a callable that returns a session
author = AuthorFactory.create_sync()
assert author.id is not None
assert author.id == author.books[0].author_id
python-polyfactory-2.21.0/docs/examples/library_factories/sqlalchemy_factory/test_example_4.py 0000664 0000000 0000000 00000003001 15000423051 0033077 0 ustar 00root root 0000000 0000000 from typing import List
from sqlalchemy import ForeignKey, create_engine
from sqlalchemy.orm import DeclarativeBase, Mapped, Session, mapped_column, relationship
from polyfactory.factories.sqlalchemy_factory import SQLAlchemyFactory, T
class Base(DeclarativeBase): ...
class Author(Base):
__tablename__ = "authors"
id: Mapped[int] = mapped_column(primary_key=True)
name: Mapped[str]
books: Mapped[List["Book"]] = relationship(
"Book",
uselist=True,
back_populates="author",
)
class Book(Base):
__tablename__ = "books"
id: Mapped[int] = mapped_column(primary_key=True)
author_id: Mapped[int] = mapped_column(ForeignKey(Author.id), nullable=False)
author: Mapped[Author] = relationship(
"Author",
uselist=False,
back_populates="books",
)
class BaseFactory(SQLAlchemyFactory[T]):
__is_base_factory__ = True
__set_relationships__ = True
__randomize_collection_length__ = True
__min_collection_length__ = 3
def test_custom_sqla_factory() -> None:
engine = create_engine("sqlite:///:memory:")
Base.metadata.create_all(engine)
session = Session(engine)
BaseFactory.__session__ = session # Or using a callable that returns a session
author = BaseFactory.create_factory(Author).create_sync()
assert author.id is not None
assert author.id == author.books[0].author_id
book = BaseFactory.create_factory(Book).create_sync()
assert book.id is not None
assert book.author.books == [book]
python-polyfactory-2.21.0/docs/examples/library_factories/sqlalchemy_factory/test_example_5.py 0000664 0000000 0000000 00000001651 15000423051 0033111 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from collections.abc import Callable
from decimal import Decimal
from typing import Any
from sqlalchemy import types
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column
from polyfactory.factories.sqlalchemy_factory import SQLAlchemyFactory
class Location(types.TypeEngine):
cache_ok = True
class Base(DeclarativeBase): ...
class Place(Base):
__tablename__ = "location"
id: Mapped[int] = mapped_column(primary_key=True)
location: Mapped[tuple[Decimal, Decimal]] = mapped_column(Location)
class PlaceFactory(SQLAlchemyFactory[Place]):
@classmethod
def get_sqlalchemy_types(cls) -> dict[Any, Callable[[], Any]]:
mapping = super().get_sqlalchemy_types()
mapping[Location] = cls.__faker__.latlng
return mapping
def test_custom_sqla_factory() -> None:
result = PlaceFactory.build()
assert isinstance(result.location, tuple)
test_example_association_proxy.py 0000664 0000000 0000000 00000003440 15000423051 0036441 0 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/library_factories/sqlalchemy_factory from __future__ import annotations
from sqlalchemy import ForeignKey
from sqlalchemy.ext.associationproxy import AssociationProxy, association_proxy
from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship
from polyfactory.factories.sqlalchemy_factory import SQLAlchemyFactory
class Base(DeclarativeBase): ...
class User(Base):
__tablename__ = "users"
id: Mapped[int] = mapped_column(primary_key=True)
name: Mapped[str]
user_keyword_associations: Mapped[list["UserKeywordAssociation"]] = relationship(
back_populates="user",
)
keywords: AssociationProxy[list["Keyword"]] = association_proxy(
"user_keyword_associations",
"keyword",
creator=lambda keyword_obj: UserKeywordAssociation(keyword=keyword_obj),
)
class UserKeywordAssociation(Base):
__tablename__ = "user_keyword"
user_id: Mapped[int] = mapped_column(ForeignKey("users.id"), primary_key=True)
keyword_id: Mapped[int] = mapped_column(ForeignKey("keywords.id"), primary_key=True)
user: Mapped[User] = relationship(back_populates="user_keyword_associations")
keyword: Mapped["Keyword"] = relationship()
class Keyword(Base):
__tablename__ = "keywords"
id: Mapped[int] = mapped_column(primary_key=True)
keyword: Mapped[str]
class UserFactory(SQLAlchemyFactory[User]): ...
class UserFactoryWithAssociation(SQLAlchemyFactory[User]):
__set_association_proxy__ = True
def test_sqla_factory() -> None:
user = UserFactory.build()
assert not user.user_keyword_associations
assert not user.keywords
def test_sqla_factory_with_association() -> None:
user = UserFactoryWithAssociation.build()
assert isinstance(user.user_keyword_associations[0], UserKeywordAssociation)
assert isinstance(user.keywords[0], Keyword)
python-polyfactory-2.21.0/docs/examples/model_coverage/ 0000775 0000000 0000000 00000000000 15000423051 0023175 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/model_coverage/__init__.py 0000664 0000000 0000000 00000000000 15000423051 0025274 0 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/examples/model_coverage/test_example_1.py 0000664 0000000 0000000 00000001443 15000423051 0026463 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from dataclasses import dataclass
from typing import Literal
from polyfactory.factories.dataclass_factory import DataclassFactory
@dataclass
class Car:
model: str
@dataclass
class Boat:
can_float: bool
@dataclass
class Profile:
age: int
favourite_color: Literal["red", "green", "blue"]
vehicle: Car | Boat
class ProfileFactory(DataclassFactory[Profile]): ...
def test_profile_coverage() -> None:
profiles = list(ProfileFactory.coverage())
assert profiles[0].favourite_color == "red"
assert isinstance(profiles[0].vehicle, Car)
assert profiles[1].favourite_color == "green"
assert isinstance(profiles[1].vehicle, Boat)
assert profiles[2].favourite_color == "blue"
assert isinstance(profiles[2].vehicle, Car)
python-polyfactory-2.21.0/docs/examples/model_coverage/test_example_2.py 0000664 0000000 0000000 00000002000 15000423051 0026452 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from dataclasses import dataclass
from typing import Literal
from polyfactory.factories.dataclass_factory import DataclassFactory
@dataclass
class Car:
model: str
@dataclass
class Boat:
can_float: bool
@dataclass
class Profile:
age: int
favourite_color: Literal["red", "green", "blue"]
vehicle: Car | Boat
@dataclass
class SocialGroup:
members: list[Profile]
class SocialGroupFactory(DataclassFactory[SocialGroup]): ...
def test_social_group_coverage() -> None:
groups = list(SocialGroupFactory.coverage())
assert len(groups) == 3
for group in groups:
assert len(group.members) == 1
assert groups[0].members[0].favourite_color == "red"
assert isinstance(groups[0].members[0].vehicle, Car)
assert groups[1].members[0].favourite_color == "green"
assert isinstance(groups[1].members[0].vehicle, Boat)
assert groups[2].members[0].favourite_color == "blue"
assert isinstance(groups[2].members[0].vehicle, Car)
python-polyfactory-2.21.0/docs/getting-started.rst 0000664 0000000 0000000 00000003410 15000423051 0022241 0 ustar 00root root 0000000 0000000 ===============
Getting Started
===============
Polyfactory is a simple and powerful mock data generation library, based around type
hints and supporting :doc:`dataclasses <python:library/dataclasses>`, :class:`TypedDicts <typing.TypedDict>`,
Pydantic models, :class:`msgspec Struct's <msgspec.Struct>` and more.
Installation
------------
.. code-block:: bash
pip install polyfactory
Example
-------
.. literalinclude:: /examples/declaring_factories/test_example_1.py
:caption: Minimal example using a dataclass
:language: python
That is it - with almost no work, we are able to create a mock data object fitting the ``Person`` class model definition.
This is possible because of the typing information available on the dataclass, which are used as a
source of truth for data generation.
The factory parses the information stored in the dataclass and generates a dictionary of kwargs that are passed to
the ``Person`` class constructor.
Relation to ``pydantic-factories``
----------------------------------
Prior to version 2, this library was known as `pydantic-factories <https://pypi.org/project/pydantic-factories/>`_, a
name under which it gained quite a bit of popularity.
A main motivator for the 2.0 release was that we wanted to support more than just Pydantic models, something which also
required a change to its core architecture. As this library would no longer be directly tied to Pydantic, ``polyfactory``
was chosen as its new name to reflect its capabilities; It can generate mock data for
:doc:`dataclasses <python:library/dataclasses>`, :class:`TypedDicts <typing.TypedDict>`,
`Pydantic <https://docs.pydantic.dev/latest/>`_, `Odmantic <https://art049.github.io/odmantic/>`_,
and `Beanie ODM <https://beanie-odm.dev/>`_ models, as well as custom factories.
python-polyfactory-2.21.0/docs/index.rst 0000664 0000000 0000000 00000013112 15000423051 0020243 0 ustar 00root root 0000000 0000000 :layout: landing
:description: Polyfactory is a simple and powerful mock data generation library.
.. container::
:name: home-head
.. image:: https://raw.githubusercontent.com/litestar-org/branding/main/assets/Branding%20-%20SVG%20-%20Transparent/Badge%20-%20Blue%20and%20Yellow.svg
:alt: Litestar Framework
:width: 400
:height: 400
.. container::
.. raw:: html
<h1>Polyfactory</h1>
.. container:: badges
:name: badges
.. image:: https://img.shields.io/github/actions/workflow/status/litestar-org/polyfactory/publish.yml?labelColor=202235&logo=github&logoColor=edb641
:alt: GitHub Actions Latest Release Workflow Status
.. image:: https://img.shields.io/github/actions/workflow/status/litestar-org/polyfactory/ci.yml?labelColor=202235&logo=github&logoColor=edb641
:alt: GitHub Actions CI Workflow Status
.. image:: https://img.shields.io/github/actions/workflow/status/litestar-org/polyfactory/docs.yml?labelColor=202235&logo=github&logoColor=edb641
:alt: GitHub Actions Docs Build Workflow Status
.. image:: https://img.shields.io/codecov/c/github/litestar-org/polyfactory?labelColor=202235&logo=codecov&logoColor=edb641
:alt: Coverage
.. image:: https://img.shields.io/pypi/v/polyfactory?labelColor=202235&color=edb641&logo=python&logoColor=edb641
:alt: PyPI Version
.. image:: https://img.shields.io/github/all-contributors/litestar-org/polyfactory?labelColor=202235&color=edb641&logoColor=edb641
:alt: Contributor Count
.. image:: https://img.shields.io/pypi/dm/polyfactory?logo=python&label=polyfactory%20downloads&labelColor=202235&color=edb641&logoColor=edb641
:alt: PyPI Downloads
.. image:: https://img.shields.io/pypi/pyversions/polyfactory?labelColor=202235&color=edb641&logo=python&logoColor=edb641
:alt: Supported Python Versions
.. rst-class:: lead
Polyfactory is a simple and powerful mock data generation library, based around type
hints and supporting :doc:`dataclasses <python:library/dataclasses>`, :class:`TypedDicts <typing.TypedDict>`,
Pydantic models, :class:`msgspec Struct's <msgspec.Struct>` and more.
.. container:: buttons
:doc:`Get Started <getting-started>`
`Usage Docs <usage>`_
`API Docs <reference>`_
`Blog <https://blog.litestar.dev>`_
.. grid:: 1 1 2 2
:padding: 0
:gutter: 2
.. grid-item-card:: :octicon:`versions` Changelog
:link: changelog
:link-type: doc
The latest updates and enhancements to Polyfactory
.. grid-item-card:: :octicon:`comment-discussion` Discussions
:link: https://github.com/litestar-org/polyfactory/discussions
Join discussions, pose questions, or share insights.
.. grid-item-card:: :octicon:`issue-opened` Issues
:link: https://github.com/litestar-org/polyfactory/issues
Report issues or suggest new features.
.. grid-item-card:: :octicon:`beaker` Contributing
:link: contribution-guide
:link-type: doc
Contribute to Litestar's growth with code, docs, and more.
Sponsors
--------
.. rst-class:: lead
Litestar is a community-driven, open-source initiative that thrives on the generous contributions of our sponsors,
enabling us to pursue innovative developments and continue our mission to provide exceptional tools and resources
to our users.
A huge thank you to our current sponsors:
.. container::
:name: sponsors-section
.. grid:: 3
:class-row: surface
:padding: 0
:gutter: 2
.. grid-item-card::
:link: https://github.com/scalar/scalar
.. image:: https://raw.githubusercontent.com/litestar-org/branding/main/assets/sponsors/scalar.svg
:alt: Scalar.com
:class: sponsor
`Scalar.com <https://github.com/scalar/scalar>`_
.. grid-item-card::
:link: https://telemetrysports.com/
.. image:: https://raw.githubusercontent.com/litestar-org/branding/main/assets/sponsors/telemetry-sports/unofficial-telemetry-whitebg.svg
:alt: Telemetry Sports
:class: sponsor
`Telemetry Sports <https://telemetrysports.com/>`_
.. grid-item-card::
:link: https://www.stok.kr/
.. image:: https://avatars.githubusercontent.com/u/144093421
:alt: Stok
:class: sponsor
`Stok <https://www.stok.kr/>`_
We invite organizations and individuals to join our sponsorship program.
By becoming a sponsor on platforms like `Polar <sponsor-polar_>`_, `GitHub <sponsor-github_>`_
and `Open Collective <sponsor-oc_>`_, you can play a pivotal role in our project's growth.
On top of regular sponsorship, we engage in pledge-based sponsorship opportunities through `Polar <sponsor-polar_>`_,
where you can pledge an amount towards an issue or feature you would like to see implemented.
.. _sponsor-github: https://github.com/sponsors/litestar-org
.. _sponsor-oc: https://opencollective.com/litestar
.. _sponsor-polar: https://polar.sh/litestar-org
.. toctree::
:titlesonly:
:caption: Documentation
:hidden:
getting-started
usage/index
reference/index
.. toctree::
:titlesonly:
:caption: Contributing
:hidden:
changelog
contribution-guide
Available Issues <https://github.com/search?q=user%3Alitestar-org+state%3Aopen+label%3A%22good+first+issue%22+++no%3Aassignee+repo%3A%22polyfactory%22&type=issues>
Code of Conduct <https://github.com/litestar-org/.github?tab=coc-ov-file#readme>
python-polyfactory-2.21.0/docs/reference/ 0000775 0000000 0000000 00000000000 15000423051 0020342 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/reference/constants.rst 0000664 0000000 0000000 00000000277 15000423051 0023116 0 ustar 00root root 0000000 0000000 constants
=========
.. note:: Mapping of type annotations into concrete types.
This is used to normalize Python <= 3.9 annotations.
.. automodule:: polyfactory.constants
:members:
python-polyfactory-2.21.0/docs/reference/decorators.rst 0000664 0000000 0000000 00000000114 15000423051 0023235 0 ustar 00root root 0000000 0000000 decorators
==========
.. automodule:: polyfactory.decorators
:members:
python-polyfactory-2.21.0/docs/reference/exceptions.rst 0000664 0000000 0000000 00000000114 15000423051 0023251 0 ustar 00root root 0000000 0000000 exceptions
==========
.. automodule:: polyfactory.exceptions
:members:
python-polyfactory-2.21.0/docs/reference/factories/ 0000775 0000000 0000000 00000000000 15000423051 0022321 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/reference/factories/attrs_factory.rst 0000664 0000000 0000000 00000000142 15000423051 0025734 0 ustar 00root root 0000000 0000000 attrs_factory
================
.. automodule:: polyfactory.factories.attrs_factory
:members:
python-polyfactory-2.21.0/docs/reference/factories/base.rst 0000664 0000000 0000000 00000000106 15000423051 0023762 0 ustar 00root root 0000000 0000000 base_factory
============
.. automodule:: polyfactory.factories.base
python-polyfactory-2.21.0/docs/reference/factories/beanie_odm_factory.rst 0000664 0000000 0000000 00000000156 15000423051 0026666 0 ustar 00root root 0000000 0000000 beanie_odm_factory
==================
.. automodule:: polyfactory.factories.beanie_odm_factory
:members:
python-polyfactory-2.21.0/docs/reference/factories/dataclass_factory.rst 0000664 0000000 0000000 00000000136 15000423051 0026541 0 ustar 00root root 0000000 0000000 dataclass_factory
==================
.. automodule:: polyfactory.factories.dataclass_factory
python-polyfactory-2.21.0/docs/reference/factories/index.rst 0000664 0000000 0000000 00000000357 15000423051 0024167 0 ustar 00root root 0000000 0000000 factories
=========
.. toctree::
:maxdepth: 1
base
dataclass_factory
typed_dict_factory
pydantic_factory
msgspec_factory
odmantic_odm_factory
beanie_odm_factory
attrs_factory
sqlalchemy_factory
python-polyfactory-2.21.0/docs/reference/factories/msgspec_factory.rst 0000664 0000000 0000000 00000000146 15000423051 0026244 0 ustar 00root root 0000000 0000000 msgspec_factory
================
.. automodule:: polyfactory.factories.msgspec_factory
:members:
python-polyfactory-2.21.0/docs/reference/factories/odmantic_odm_factory.rst 0000664 0000000 0000000 00000000164 15000423051 0027240 0 ustar 00root root 0000000 0000000 odmantic_odm_factory
====================
.. automodule:: polyfactory.factories.odmantic_odm_factory
:members:
python-polyfactory-2.21.0/docs/reference/factories/pydantic_factory.rst 0000664 0000000 0000000 00000000150 15000423051 0026411 0 ustar 00root root 0000000 0000000 pydantic_factory
================
.. automodule:: polyfactory.factories.pydantic_factory
:members:
python-polyfactory-2.21.0/docs/reference/factories/sqlalchemy_factory.rst 0000664 0000000 0000000 00000000140 15000423051 0026737 0 ustar 00root root 0000000 0000000 sqlalchemy_factory
==================
.. automodule:: polyfactory.factories.sqlalchemy_factory
python-polyfactory-2.21.0/docs/reference/factories/typed_dict_factory.rst 0000664 0000000 0000000 00000000140 15000423051 0026725 0 ustar 00root root 0000000 0000000 typed_dict_factory
==================
.. automodule:: polyfactory.factories.typed_dict_factory
python-polyfactory-2.21.0/docs/reference/field_meta.rst 0000664 0000000 0000000 00000000114 15000423051 0023161 0 ustar 00root root 0000000 0000000 field_meta
==========
.. automodule:: polyfactory.field_meta
:members:
python-polyfactory-2.21.0/docs/reference/fields.rst 0000664 0000000 0000000 00000000100 15000423051 0022331 0 ustar 00root root 0000000 0000000 fields
======
.. automodule:: polyfactory.fields
:members:
python-polyfactory-2.21.0/docs/reference/index.rst 0000664 0000000 0000000 00000000534 15000423051 0022205 0 ustar 00root root 0000000 0000000 API Reference
=============
This section contains sections for API reference documentation for the ``polyfactory`` package.
.. toctree::
:titlesonly:
:maxdepth: 1
:caption: Articles
constants
exceptions
factories/index
field_meta
fields
decorators
persistence
pytest_plugin
value_generators/index
python-polyfactory-2.21.0/docs/reference/persistence.rst 0000664 0000000 0000000 00000000117 15000423051 0023417 0 ustar 00root root 0000000 0000000 persistence
===========
.. automodule:: polyfactory.persistence
:members:
python-polyfactory-2.21.0/docs/reference/pytest_plugin.rst 0000664 0000000 0000000 00000000125 15000423051 0024000 0 ustar 00root root 0000000 0000000 pytest_plugin
=============
.. automodule:: polyfactory.pytest_plugin
:members:
python-polyfactory-2.21.0/docs/reference/value_generators/ 0000775 0000000 0000000 00000000000 15000423051 0023707 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/reference/value_generators/complex_types.rst 0000664 0000000 0000000 00000000146 15000423051 0027335 0 ustar 00root root 0000000 0000000 complex_types
=============
.. automodule:: polyfactory.value_generators.complex_types
:members:
python-polyfactory-2.21.0/docs/reference/value_generators/constrained_collections.rst 0000664 0000000 0000000 00000000205 15000423051 0031345 0 ustar 00root root 0000000 0000000 constrained_collections
========================
.. automodule:: polyfactory.value_generators.constrained_collections
:members:
python-polyfactory-2.21.0/docs/reference/value_generators/constrained_dates.rst 0000664 0000000 0000000 00000000163 15000423051 0030132 0 ustar 00root root 0000000 0000000 constrained_dates
==================
.. automodule:: polyfactory.value_generators.constrained_dates
:members:
python-polyfactory-2.21.0/docs/reference/value_generators/constrained_numbers.rst 0000664 0000000 0000000 00000000170 15000423051 0030503 0 ustar 00root root 0000000 0000000 constrained_numbers
===================
.. automodule:: polyfactory.value_generators.constrained_numbers
:members:
python-polyfactory-2.21.0/docs/reference/value_generators/constrained_strings.rst 0000664 0000000 0000000 00000000170 15000423051 0030521 0 ustar 00root root 0000000 0000000 constrained_strings
===================
.. automodule:: polyfactory.value_generators.constrained_strings
:members:
python-polyfactory-2.21.0/docs/reference/value_generators/index.rst 0000664 0000000 0000000 00000000305 15000423051 0025546 0 ustar 00root root 0000000 0000000 value_generators
================
.. toctree::
:maxdepth: 1
complex_types
constrained_collections
constrained_dates
constrained_numbers
constrained_strings
primitives
python-polyfactory-2.21.0/docs/reference/value_generators/primitives.rst 0000664 0000000 0000000 00000000135 15000423051 0026633 0 ustar 00root root 0000000 0000000 primitives
==========
.. automodule:: polyfactory.value_generators.primitives
:members:
python-polyfactory-2.21.0/docs/releases.rst 0000664 0000000 0000000 00000005504 15000423051 0020745 0 ustar 00root root 0000000 0000000 :orphan:
====================
Polyfactory Releases
====================
This document outlines the release structure, versioning, and stability guarantees for the Polyfactory library.
Version Numbering
-----------------
This library follows the `Semantic Versioning standard <https://semver.org/>`_, using the ``<major>.<minor>.<patch>``
schema:
**Major**
Backwards incompatible changes have been made
**Minor**
Functionality was added in a backwards compatible manner
**Patch**
Bugfixes were applied in a backwards compatible manner
Pre-release Versions
++++++++++++++++++++
Before a new major release, we will make ``alpha``, ``beta``, and release candidate (``rc``) releases, numbered as
``<major>.<minor>.<patch><release_type><number>``. For example, ``2.0.0alpha1``, ``2.0.0beta1``, ``2.0.0rc1``.
- ``alpha``
Early developer preview. Features may not be complete and breaking changes can occur.
- ``beta``
More stable preview release. Feature complete, no major breaking changes expected.
- ``rc``
Release candidate. Feature freeze, only bugfixes until final release.
Suitable for testing migration to the upcoming major release.
Long-term Support Releases (LTS)
--------------------------------
Major releases are designated as LTS releases for the life of that major release series.
These releases will receive bugfixes for a guaranteed period of time as defined in
`Supported Versions <#supported-versions>`_.
Deprecation Policy
------------------
When a feature is going to be removed, a deprecation warning will be added in a **minor** release.
The feature will continue to work for all releases in that major series, and will be removed in the next major release.
For example, if a deprecation warning is added in ``1.1``, the feature will work throughout all ``1.x`` releases,
and be removed in ``2.0``.
Supported Versions
------------------
At any time, the Litestar organization will actively support:
- The current major release series
- The previous major release series
- Any other designated LTS releases (Special cases)
For example, if the current release is ``2.0``, we will actively support ``2.x`` and ``1.x``.
When ``3.0`` is released, we will drop support for ``1.x``.
Bugfixes will be applied to the current major release, and selectively backported to older
supported versions based on severity and feasibility.
Release Process
---------------
Each major release cycle consists of a few phases:
#. **Planning**: Define roadmap, spec out major features. Work should begin on implementation.
#. **Development**: Active development on planned features. Ends with an alpha release and branch of ``A.B.x``
branch from `main`.
#. **Bugfixes**: Only bugfixes, no new features. Progressively release beta, release candidates.
Feature freeze at RC. Become more selective with backports to avoid regressions.
python-polyfactory-2.21.0/docs/usage/ 0000775 0000000 0000000 00000000000 15000423051 0017510 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/usage/configuration.rst 0000664 0000000 0000000 00000013444 15000423051 0023117 0 ustar 00root root 0000000 0000000 Factory Configuration
=====================
Factories can be configured by setting special dunder (double underscore) class attributes.
You can read the reference for these in the API reference for
:class:`BaseFactory <polyfactory.factories.base.BaseFactory>`. Below we discuss some configuration options in some depth.
Seeding Randomness
------------------
.. literalinclude:: /examples/configuration/test_example_1.py
:caption: Seeding the factory's 'random.Random'
:language: python
Seeding randomness allows you to control the random generation of values produced by the factory. This affects all :class:`random.Random`
methods as well as faker.
Setting Random
--------------
.. literalinclude:: /examples/configuration/test_example_2.py
:caption: Setting the factory's 'random.Random'
:language: python
This configuration option is functionally identical to the previous, with the difference being that here we are setting
the actual instance of :class:`random.Random`. This is useful when embedding factories inside more complex logic, such as in
other libraries, as well as when factories are being dynamically generated.
Setting Faker
-------------
.. literalinclude:: /examples/configuration/test_example_3.py
:caption: Setting the factory's 'Faker'
:language: python
In the above example we are setting the factory's instance of ``Faker`` and configure its locale to Spanish. Because
we are also setting the random seed value, the results of the test are deterministic.
.. note::
To understand why we are using a classmethod here, see the documentation about :doc:`factory fields </usage/fields>`.
Persistence Handlers
--------------------
Factory classes have four optional persistence methods:
- ``.create_sync(**kwargs)`` - builds and persists a single instance of the factory's model synchronously
- ``.create_batch_sync(size: int, **kwargs)`` - builds and persists a list of size n instances synchronously
- ``.create_async(**kwargs)`` - builds and persists a single instance of the factory's model asynchronously
- ``.create_batch_async(size: int, **kwargs)`` - builds and persists a list of size n instances asynchronously
To use these methods, you must first specify a sync and/or async persistence handlers for the factory:
.. literalinclude:: /examples/configuration/test_example_4.py
:caption: Defining and using persistence handlers.
:language: python
With the persistence handlers in place, you can now use all persistence methods.
.. note::
You do not need to define both persistence handlers. If you will only use sync or async persistence, you only need
to define the respective handler to use these methods.
Defining Default Factories
--------------------------
As explained in the section about dynamic factory generation in :doc:`declaring factories </usage/declaring_factories>`,
factories generate new factories for supported types dynamically. This process requires no intervention from the user.
Once a factory is generated, it is then cached and reused - when the same type is used.
For example, when build is called for the ``PersonFactory`` below, a ``PetFactory`` will be dynamically generated and reused:
.. literalinclude:: /examples/declaring_factories/test_example_5.py
:caption: Dynamic factory generation
:language: python
You can also control the default factory for a type by declaring a factory as the type default:
.. literalinclude:: /examples/configuration/test_example_5.py
:caption: Setting a factory as a type default.
:language: python
Randomized Collection Length
----------------------------
Set of fields that allow you to generate a collection with random lengths. By default only one item is generated.
.. literalinclude:: /examples/configuration/test_example_6.py
:caption: Randomized collection length
:language: python
Allow None Optionals
--------------------
Allow `None` to be generated as a value for types marked as optional. When set to `True`, the outputted value will be randomly chosen between `None` and other allowed types. By default, this is set to `True`.
By setting to `False`, then optional types will always be treated as the wrapped type:
.. literalinclude:: /examples/configuration/test_example_7.py
:caption: Disable Allow None Optionals
:language: python
Check Factory Fields
--------------------
When `__check_model__` is set to `True`, declaring fields on the factory that don't exist on the model will trigger an exception.
This is only true when fields are declared with ``Use``, ``PostGenerated``, ``Ignore`` and ``Require``.
Any other field definition will not be checked.
.. literalinclude:: /examples/configuration/test_example_8.py
:caption: Enable Check Factory Fields
:language: python
Use Default Values
------------------
If ``__use_defaults__`` is set to ``True``, then the default value will be used instead of creating a random value
for a given field, provided there's a default value for that field.
By default, ``__use_defaults__`` is set to ``False.`` If you need more fine grained control, you can override the
:meth:`~polyfactory.factories.base.BaseFactory.should_use_default_value` classmethod.
.. note::
Setting ``__use_defaults__`` has no effect for ``TypedDictFactory`` since you cannot set default values for
``TypedDict``.
.. literalinclude:: /examples/configuration/test_example_9.py
:caption: Use Default Values
:language: python
Use Example Values (Pydantic >= V2)
-----------------------------------
If ``__use_examples__`` is set to ``True``, then a random value from examples attribute will be used for a given field,
provided there's a non-empty list of examples defined for that field.
By default, ``__use_examples__`` is set to ``False.``
.. literalinclude:: /examples/configuration/test_example_10.py
:caption: Use Examples Values
:language: python
python-polyfactory-2.21.0/docs/usage/declaring_factories.rst 0000664 0000000 0000000 00000005725 15000423051 0024242 0 ustar 00root root 0000000 0000000 Declaring Factories
===================
Defining factories is done using a declarative syntax. That is - users declare factory classes, which are subclasses of
base factories.
.. literalinclude:: /examples/declaring_factories/test_example_1.py
:caption: Declaring a factory for a dataclass
:language: python
You can also specify the model type by only specifying the factory generic type parameter.
.. code-block:: python
@dataclass
class Person:
name: str
age: float
height: float
weight: float
class PersonFactory(DataclassFactory[Person]):
...
.. note::
The syntax with the ``__model__`` class attribute omitting
is only available since version 2.13.0.
The same applies to the other factories exported by this library, for example:
.. literalinclude:: /examples/declaring_factories/test_example_2.py
:caption: Declaring a factory for a typed-dict
:language: python
Or for pydantic models:
.. literalinclude:: /examples/declaring_factories/test_example_3.py
:caption: Declaring a factory for a pydantic model
:language: python
.. note::
You can also define factories for any 3rd party implementation of dataclasses, as long as it fulfills the stdlib
dataclasses interface. For example, this is using the pydantic ``@dataclass`` decorator:
.. literalinclude:: /examples/declaring_factories/test_example_4.py
:caption: Declaring a factory for a pydantic dataclass
:language: python
Or for attrs models:
.. literalinclude:: /examples/declaring_factories/test_example_7.py
:caption: Declaring a factory for a attrs model
:language: python
.. note::
Validators are not currently supported - neither the built in validators that come
with `attrs` nor custom validators.
Imperative Factory Creation
---------------------------
Although the definition of factories is primarily meant to be done declaratively, factories expose the
:meth:`create_factory <polyfactory.factories.base.BaseFactory.create_factory>` method. This method is used internally
inside factories to dynamically create factories for models. For example, below the ``PersonFactory`` will dynamically
create a ``PetFactory``:
.. literalinclude:: /examples/declaring_factories/test_example_5.py
:caption: Dynamic factory generation
:language: python
You can also use this method to create factories imperatively:
.. literalinclude:: /examples/declaring_factories/test_example_6.py
:caption: Imperative factory creation
:language: python
Eventually you can use this method on an existing concrete factory to create a sub factory overriding some parent configuration:
.. literalinclude:: /examples/declaring_factories/test_example_8.py
:caption: Imperative sub factory creation
:language: python
In this case you don't need to specify the `model` argument to the :meth:`create_factory <polyfactory.factories.base.BaseFactory.create_factory>` method. The one from the parent factory will be used.
python-polyfactory-2.21.0/docs/usage/decorators.rst 0000664 0000000 0000000 00000001171 15000423051 0022407 0 ustar 00root root 0000000 0000000 The ``post_generated`` decorator
--------------------------------
The :class:`post_generated <polyfactory.decorators.post_generated>` decorator wraps a ``classmethod`` into a
:class:`PostGenerated <polyfactory.fields.PostGenerated>` field. This is useful when the post generated field depends
on the current factory, usually its ``__faker__`` and/or ``__random__`` attribute. For example:
.. literalinclude:: /examples/decorators/test_example_1.py
:caption: Using the ``post_generated`` decorator
:language: python
All classmethod parameters after ``cls`` must be named as the fields this post generated field depends on.
python-polyfactory-2.21.0/docs/usage/fields.rst 0000664 0000000 0000000 00000011050 15000423051 0021505 0 ustar 00root root 0000000 0000000 Factory Fields
==============
The factory api is designed to be as semantic and simple as possible, and by default it requires no customization to
mock data. Nonetheless, when you do need to customize and control the data being generated, polyfactory has you covered.
Lets look at a few examples:
.. literalinclude:: /examples/fields/test_example_1.py
:caption: Declaring a PersonFactory with hardcoded pets
:language: python
In the example above, the call to ``PersonFactory.build()`` results in a ``Person`` where all values are randomly
generated, except the ``pets`` list, which will be the hardcoded value we defined.
The ``Use`` Field
-----------------
This though is often not desirable. We could instead, define a factory for Pet where we restrict the choices to a range
we like. For example:
.. literalinclude:: /examples/fields/test_example_2.py
:caption: Using the ``Use`` field with a custom PetFactory to control the generation of a Person's pets list
:language: python
The :class:`Use <polyfactory.fields.Use>` class is merely a semantic abstraction that makes the factory cleaner and simpler
to understand, you can in fact use any callable (including classes) as values for a factory's attribute directly, and
these will be invoked at build-time. Thus, you could for example re-write the above PetFactory like so:
.. literalinclude:: /examples/fields/test_example_3.py
:caption: Using simple lambda functions to declare custom fields
:language: python
Or you can use a class method, which will give you easy and nice access to the factory itself:
.. literalinclude:: /examples/fields/test_example_4.py
:caption: Using class methods to declare custom fields
:language: python
.. note::
All the above examples used ``DataclassFactory.__random__.choice``, and this is intentional. While you can use
``random.choice`` or any other function exported from the stdlib random library, the factory class has its own instance
of ``random.Random`` attached under ``cls.__random__``. This instance can be affected by random seeding in several ways, e.g.
calling the factory seeding method, which will be scoped only to this instance. Thus, for consistent results when seeding
randomness, its important to use the factory ``random.Random`` instance rather than the global one from the stdlib.
The ``Ignore`` Field
--------------------
:class:`Ignore <polyfactory.fields.Ignore>` is used to designate an attribute as ignored, which means it will be completely
ignored by the factory:
.. literalinclude:: /examples/fields/test_example_5.py
:caption: Using the ``Ignore`` field
:language: python
The ``Require`` Field
---------------------
The :class:`Require <polyfactory.fields.Require>` class is used to designate a given attribute as a required kwarg. This means that the
factory will require passing a value for this attribute as a kwarg to the build method, or an exception will be raised:
.. literalinclude:: /examples/fields/test_example_6.py
:caption: Using the ``Require`` field
:language: python
The ``PostGenerated`` Field
---------------------------
The :class:`PostGenerated <polyfactory.fields.PostGenerated>` class allows for post generating fields based on already generated
values of other (non post generated) fields. In most cases this pattern is best avoided, but for the few valid cases
the PostGenerated helper is provided. For example:
.. literalinclude:: /examples/fields/test_example_7.py
:caption: Using the ``PostGenerated`` field
:language: python
The signature for use is: ``cb: Callable, *args, **defaults`` it can receive any sync callable. The signature for the
callable should be: ``name: str, values: dict[str, Any], *args, **defaults``. The already generated values are mapped by
name in the values dictionary.
Factories as Fields
-------------------
Factories themselves can be used as fields. In this usage, build parameters will be passed to the declared factory.
.. literalinclude:: /examples/fields/test_example_8.py
:caption: Using a factory as a field
:language: python
Handling Asynchronous Data in Factory Fields
--------------------------------------------
If you need to populate a factory field with data pre-fetched asynchronously (e.g., from a database using an ORM like SQLAlchemy or Beanie), the recommended approach is to handle the asynchronous call outside the factory and pass the resolved value as a regular argument.
.. literalinclude:: /examples/fields/test_example_sqla_pre_fetched_data.py
:caption: SQLAlchemy example
:language: python
:emphasize-lines: 34-37, 51
python-polyfactory-2.21.0/docs/usage/fixtures.rst 0000664 0000000 0000000 00000001550 15000423051 0022114 0 ustar 00root root 0000000 0000000 Pytest fixtures
===============
Polyfactory support registering factories as pytest fixtures using the
:func:`register_fixture <polyfactory.pytest_plugin.register_fixture>` decorator:
.. literalinclude:: /examples/fixtures/test_example_1.py
:caption: Using the ``register_fixture_decorator`` field.
:language: python
The fixture can be registered separately from the declaration of the class. This is useful when a different pytest fixture location to where the factory is defined.
.. literalinclude:: /examples/fixtures/test_example_2.py
:caption: Using the ``register_fixture_decorator`` field separately.
:language: python
You can also control the name of the fixture using the optional ``name`` kwarg:
.. literalinclude:: /examples/fixtures/test_example_3.py
:caption: Aliasing a factory fixture using the `name` kwarg.
:language: python
python-polyfactory-2.21.0/docs/usage/handling_custom_types.rst 0000664 0000000 0000000 00000003062 15000423051 0024645 0 ustar 00root root 0000000 0000000 Handling Custom Types
=====================
Sometimes you need to handle custom types, either from 3rd party libraries or from your own codebase. To achieve this,
you can extend what's referred as the `providers_map`:
.. literalinclude:: /examples/handling_custom_types/test_example_1.py
:caption: Extending the provider map
:language: python
In the above example we override the `get_provider_map` class method, which maps types to callables. Each callable in the map
returns an appropriate mock value for the type. In the above example, an instance of `CustomSecret` with the hardcoded
string 'jeronimo'.
Add a Type Provider
-------------------
Alternatively, you can add a provider for your custom type to `BaseFactory`.
.. literalinclude:: /examples/handling_custom_types/test_example_3.py
:caption: Creating a custom type factory using add_provider
:language: python
Creating Custom Base Factories
------------------------------
The above works great when you need to do this in a localised fashion, but if you need to use some custom types in many
places it will lead to unnecessary duplication. The solution for this is to create a custom base factory, in this case
for handling dataclasses:
.. literalinclude:: /examples/handling_custom_types/test_example_2.py
:caption: Creating a custom dataclass factory with extended provider map
:language: python
.. note::
If extra configs values are defined for custom base classes, then ``__config_keys__`` should be extended so
that these values are correctly passed onto to concrete factories.
python-polyfactory-2.21.0/docs/usage/index.rst 0000664 0000000 0000000 00000000477 15000423051 0021361 0 ustar 00root root 0000000 0000000 Usage Guide
===========
This section contains articles that explain how to use Polyfactory.
.. toctree::
:titlesonly:
:maxdepth: 1
:caption: Articles
declaring_factories
library_factories/index
configuration
fields
decorators
fixtures
handling_custom_types
model_coverage
python-polyfactory-2.21.0/docs/usage/library_factories/ 0000775 0000000 0000000 00000000000 15000423051 0023213 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/docs/usage/library_factories/index.rst 0000664 0000000 0000000 00000004044 15000423051 0025056 0 ustar 00root root 0000000 0000000 Polyfactory Factories
=====================
The factories exported by this library are classes that extend the
Abstract Base Class (ABC) :class:`BaseFactory <polyfactory.factories.base.BaseFactory>`.
These include:
:class:`DataclassFactory <polyfactory.factories.dataclass_factory.DataclassFactory>`
a base factory for dataclasses
:class:`TypedDictFactory <polyfactory.factories.typed_dict_factory.TypedDictFactory>`
a base factory for typed-dicts
:class:`ModelFactory <polyfactory.factories.pydantic_factory.ModelFactory>`
a base factory for `pydantic <https://docs.pydantic.dev/>`_ models
:class:`BeanieDocumentFactory <polyfactory.factories.beanie_odm_factory.BeanieDocumentFactory>`
a base factory for `beanie <https://beanie-odm.dev/>`_ documents
:class:`OdmanticModelFactory <polyfactory.factories.odmantic_odm_factory.OdmanticModelFactory>`
a base factory for `odmantic <https://art049.github.io/odmantic/>`_ models.
:class:`MsgspecFactory <polyfactory.factories.msgspec_factory.MsgspecFactory>`
a base factory for `msgspec <https://jcristharif.com/msgspec/>`_ Structs
:class:`AttrsFactory <polyfactory.factories.attrs_factory.AttrsFactory>`
a base factory for `attrs <https://www.attrs.org/en/stable/index.html>`_ models.
:class:`SQLAlchemyFactory <polyfactory.factories.sqlalchemy_factory.SQLAlchemyFactory>`
a base factory for `SQLAlchemy <https://www.sqlalchemy.org/>`_ models.
.. note::
All factories exported from ``polyfactory.factories`` do not require any additional dependencies. The other factories,
such as :class:`ModelFactory <polyfactory.factories.pydantic_factory.ModelFactory>`, require an additional but optional
dependency, in this case `pydantic <https://docs.pydantic.dev/>`_. As such, they are exported only from their respective
namespaced module, e.g. ``polyfactory.factories.pydantic_factory.ModelFactory``.
.. note::
We will be adding additional factories to this package, so make sure to checkout the above list from time to time.
.. toctree::
:maxdepth: 1
sqlalchemy_factory
python-polyfactory-2.21.0/docs/usage/library_factories/sqlalchemy_factory.rst 0000664 0000000 0000000 00000007124 15000423051 0027642 0 ustar 00root root 0000000 0000000 SQLAlchemyFactory
=================
Basic usage is like other factories
.. literalinclude:: /examples/library_factories/sqlalchemy_factory/test_example_1.py
:caption: Declaring a factory for a SQLAlchemy model
:language: python
.. note::
The examples here require SQLAlchemy 2 to be installed. The factory itself supports both 1.4 and 2.
Configuration
-------------
SQLAlchemyFactory allows to override some configuration attributes so that a described factory can use a behavior from SQLAlchemy ORM such as `relationship() <https://docs.sqlalchemy.org/en/20/orm/relationship_api.html#sqlalchemy.orm.relationship>`_ or `Association Proxy <https://docs.sqlalchemy.org/en/20/orm/extensions/associationproxy.html#module-sqlalchemy.ext.associationproxy>`_.
Relationship
++++++++++++
By default, ``__set_relationships__`` is set to ``False``. If it is ``True``, all fields with the SQLAlchemy `relationship() <relationship()_>`_ will be included in the result created by ``build`` method.
.. literalinclude:: /examples/library_factories/sqlalchemy_factory/test_example_2.py
:caption: Setting relationships
:language: python
.. note::
If ``__set_relationships__ = True``, ForeignKey fields associated with relationship() will be automatically generated by ``build`` method because :class:`__set_foreign_keys__ <polyfactory.factories.sqlalchemy_factory.SQLAlchemyFactory.__set_foreign_keys__>` is set to ``True`` by default. But their values will be overwritten by using ``create_sync``/ ``create_async`` methods, so SQLAlchemy ORM creates them.
Association Proxy
+++++++++++++++++
By default, ``__set_association_proxy__`` is set to ``False``. If it is ``True``, all SQLAlchemy fields mapped to ORM `Association Proxy <Association Proxy_>`_ class will be included in the result created by ``build`` method.
.. literalinclude:: /examples/library_factories/sqlalchemy_factory/test_example_association_proxy.py
:caption: Setting association_proxy
:language: python
.. note::
If ``__set_relationships__ = True``, the Polyfactory will create both fields from a particular SQLAlchemy model (association_proxy and its relationship), but eventually a relationship field will be overwritten by using ``create_sync``/ ``create_async`` methods via SQLAlchemy ORM with a proper instance from an Association Proxy relation.
Persistence
-----------
A handler is provided to allow persistence. This can be used by setting ``__session__`` attribute on a factory.
.. literalinclude:: /examples/library_factories/sqlalchemy_factory/test_example_3.py
:caption: Using persistence
:language: python
By default, this will add generated models to the session and then commit. This can be customised further by setting ``__sync_persistence__``.
Similarly for ``__async_session__`` and ``create_async``.
Adding global overrides
-----------------------
By combining the above and using other settings, a global base factory can be set up for other factories.
.. literalinclude:: /examples/library_factories/sqlalchemy_factory/test_example_4.py
:caption: Using persistence
:language: python
Add column type mapping
-----------------------
Columns types and normally automatically mapped to Python type. This can be overridden for cases where Python type is not available or need to provide extra information to correctly generate.
.. literalinclude:: /examples/library_factories/sqlalchemy_factory/test_example_5.py
:caption: Overriding SQLA column type mapping
:language: python
API reference
-------------
Full API docs are available :class:`here <polyfactory.factories.sqlalchemy_factory.SQLAlchemyFactory>`.
python-polyfactory-2.21.0/docs/usage/model_coverage.rst 0000664 0000000 0000000 00000003264 15000423051 0023222 0 ustar 00root root 0000000 0000000 Model coverage generation
=========================
The ``BaseFactory.coverage()`` function is an alternative approach to ``BaseFactory.batch()``, where the examples that are generated attempt to provide full coverage of all the forms a model can take with the minimum number of instances. For example:
.. literalinclude:: /examples/model_coverage/test_example_1.py
:caption: Defining a factory and generating examples with coverage
:language: python
As you can see in the above example, the ``Profile`` model has 3 options for ``favourite_color``, and 2 options for ``vehicle``. In the output you can expect to see instances of ``Profile`` that have each of these options. The largest variance dictates the length of the output, in this case ``favourite_color`` has the most, at 3 options, so expect to see 3 ``Profile`` instances.
.. note::
Notice that the same ``Car`` instance is used in the first and final generated example. When the coverage examples for a field are exhausted before another field, values for that field are reused.
Notes on collection types
-------------------------
When generating coverage for models with fields that are collections, in particular collections that contain sub-models, the contents of the collection will be the all coverage examples for that sub-model. For example:
.. literalinclude:: /examples/model_coverage/test_example_2.py
:caption: Coverage output for the SocialGroup model
:language: python
Known Limitations
-----------------
- Recursive models will cause an error: ``RecursionError: maximum recursion depth exceeded``.
- ``__min_collection_length__`` and ``__max_collection_length__`` are currently ignored in coverage generation.
python-polyfactory-2.21.0/polyfactory/ 0000775 0000000 0000000 00000000000 15000423051 0020027 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/polyfactory/__init__.py 0000664 0000000 0000000 00000000651 15000423051 0022142 0 ustar 00root root 0000000 0000000 from .exceptions import ConfigurationException
from .factories import BaseFactory
from .fields import Fixture, Ignore, PostGenerated, Require, Use
from .persistence import AsyncPersistenceProtocol, SyncPersistenceProtocol
__all__ = (
"AsyncPersistenceProtocol",
"BaseFactory",
"ConfigurationException",
"Fixture",
"Ignore",
"PostGenerated",
"Require",
"SyncPersistenceProtocol",
"Use",
)
python-polyfactory-2.21.0/polyfactory/__metadata__.py 0000664 0000000 0000000 00000000474 15000423051 0022762 0 ustar 00root root 0000000 0000000 """Metadata for the Project."""
from __future__ import annotations
import importlib.metadata
__all__ = ["__project__", "__version__"]
__version__ = importlib.metadata.version("polyfactory")
"""Version of the project."""
__project__ = importlib.metadata.metadata("polyfactory")["Name"]
"""Name of the project."""
python-polyfactory-2.21.0/polyfactory/collection_extender.py 0000664 0000000 0000000 00000005204 15000423051 0024433 0 ustar 00root root 0000000 0000000 from __future__ import annotations
import random
from abc import ABC, abstractmethod
from collections import deque
from typing import Any
from polyfactory.utils.deprecation import deprecated
from polyfactory.utils.predicates import is_safe_subclass
class CollectionExtender(ABC):
__types__: tuple[type, ...]
@staticmethod
@abstractmethod
def _extend_type_args(type_args: tuple[Any, ...], number_of_args: int) -> tuple[Any, ...]:
raise NotImplementedError
@classmethod
def _subclass_for_type(cls, annotation_alias: Any) -> type[CollectionExtender]:
return next(
(
subclass
for subclass in cls.__subclasses__()
if any(is_safe_subclass(annotation_alias, t) for t in subclass.__types__)
),
FallbackExtender,
)
@classmethod
@deprecated("2.20.0")
def extend_type_args(
cls,
annotation_alias: Any,
type_args: tuple[Any, ...],
number_of_args: int,
) -> tuple[Any, ...]:
return cls._subclass_for_type(annotation_alias)._extend_type_args(type_args, number_of_args)
class TupleExtender(CollectionExtender):
__types__ = (tuple,)
@staticmethod
def _extend_type_args(type_args: tuple[Any, ...], number_of_args: int) -> tuple[Any, ...]:
if not type_args:
return type_args
if type_args[-1] is not ...:
return type_args
type_to_extend = type_args[-2]
return type_args[:-2] + (type_to_extend,) * number_of_args
class ListLikeExtender(CollectionExtender):
__types__ = (list, deque)
@staticmethod
def _extend_type_args(type_args: tuple[Any, ...], number_of_args: int) -> tuple[Any, ...]:
if not type_args:
return type_args
return tuple(random.choice(type_args) for _ in range(number_of_args))
class SetExtender(CollectionExtender):
__types__ = (set, frozenset)
@staticmethod
def _extend_type_args(type_args: tuple[Any, ...], number_of_args: int) -> tuple[Any, ...]:
if not type_args:
return type_args
return tuple(random.choice(type_args) for _ in range(number_of_args))
class DictExtender(CollectionExtender):
__types__ = (dict,)
@staticmethod
def _extend_type_args(type_args: tuple[Any, ...], number_of_args: int) -> tuple[Any, ...]:
return type_args * number_of_args
class FallbackExtender(CollectionExtender):
__types__ = ()
@staticmethod
def _extend_type_args(
type_args: tuple[Any, ...],
number_of_args: int, # noqa: ARG004
) -> tuple[Any, ...]: # - investigate @guacs
return type_args
python-polyfactory-2.21.0/polyfactory/constants.py 0000664 0000000 0000000 00000003050 15000423051 0022413 0 ustar 00root root 0000000 0000000 from __future__ import annotations
import sys
from collections import abc, defaultdict, deque
from random import Random
from typing import (
DefaultDict,
Deque,
Dict,
FrozenSet,
Iterable,
List,
Mapping,
Sequence,
Set,
Tuple,
Union,
)
try:
from types import UnionType
except ImportError:
UnionType = Union # type: ignore[misc,assignment]
PY_38 = sys.version_info.major == 3 and sys.version_info.minor == 8 # noqa: PLR2004
# Mapping of type annotations into concrete types. This is used to normalize python <= 3.9 annotations.
INSTANTIABLE_TYPE_MAPPING = {
DefaultDict: defaultdict,
Deque: deque,
Dict: dict,
FrozenSet: frozenset,
Iterable: list,
List: list,
Mapping: dict,
Sequence: list,
Set: set,
Tuple: tuple,
abc.Iterable: list,
abc.Mapping: dict,
abc.Sequence: list,
abc.Set: set,
UnionType: Union,
}
if not PY_38:
TYPE_MAPPING = INSTANTIABLE_TYPE_MAPPING
else:
# For 3.8, we have to keep the types from typing since dict[str] syntax is not supported in 3.8.
TYPE_MAPPING = {
DefaultDict: DefaultDict,
Deque: Deque,
Dict: Dict,
FrozenSet: FrozenSet,
Iterable: List,
List: List,
Mapping: Dict,
Sequence: List,
Set: Set,
Tuple: Tuple,
abc.Iterable: List,
abc.Mapping: Dict,
abc.Sequence: List,
abc.Set: Set,
}
DEFAULT_RANDOM = Random()
RANDOMIZE_COLLECTION_LENGTH = False
MIN_COLLECTION_LENGTH = 0
MAX_COLLECTION_LENGTH = 5
python-polyfactory-2.21.0/polyfactory/decorators.py 0000664 0000000 0000000 00000002176 15000423051 0022554 0 ustar 00root root 0000000 0000000 from __future__ import annotations
import contextlib
import inspect
from typing import Any, Callable
from polyfactory import PostGenerated
class post_generated: # noqa: N801
"""Descriptor class for wrapping a classmethod into a ``PostGenerated`` field."""
__slots__ = ("cache", "method")
def __init__(self, method: Callable | classmethod) -> None:
if not isinstance(method, classmethod):
msg = "post_generated decorator can only be used on classmethods"
raise TypeError(msg)
self.method = method
self.cache: dict[type, PostGenerated] = {}
def __get__(self, obj: Any, objtype: type) -> PostGenerated:
with contextlib.suppress(KeyError):
return self.cache[objtype]
fn = self.method.__func__ # pyright: ignore[reportFunctionMemberAccess]
fn_args = inspect.getfullargspec(fn).args[1:]
def new_fn(name: str, values: dict[str, Any]) -> Any: # noqa: ARG001 - investigate @guacs
return fn(objtype, **{arg: values[arg] for arg in fn_args if arg in values})
return self.cache.setdefault(objtype, PostGenerated(new_fn))
python-polyfactory-2.21.0/polyfactory/exceptions.py 0000664 0000000 0000000 00000001117 15000423051 0022562 0 ustar 00root root 0000000 0000000 class FactoryException(Exception):
"""Base Factory error class"""
class ConfigurationException(FactoryException):
"""Configuration Error class - used for misconfiguration"""
class ParameterException(FactoryException):
"""Parameter exception - used when wrong parameters are used"""
class MissingBuildKwargException(FactoryException):
"""Missing Build Kwarg exception - used when a required build kwarg is not provided"""
class MissingDependencyException(FactoryException, ImportError):
"""Missing dependency exception - used when a dependency is not installed"""
python-polyfactory-2.21.0/polyfactory/factories/ 0000775 0000000 0000000 00000000000 15000423051 0022006 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/polyfactory/factories/__init__.py 0000664 0000000 0000000 00000000401 15000423051 0024112 0 ustar 00root root 0000000 0000000 from polyfactory.factories.base import BaseFactory
from polyfactory.factories.dataclass_factory import DataclassFactory
from polyfactory.factories.typed_dict_factory import TypedDictFactory
__all__ = ("BaseFactory", "DataclassFactory", "TypedDictFactory")
python-polyfactory-2.21.0/polyfactory/factories/attrs_factory.py 0000664 0000000 0000000 00000004607 15000423051 0025253 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from inspect import isclass
from typing import TYPE_CHECKING, Generic, TypeVar
from polyfactory.exceptions import MissingDependencyException
from polyfactory.factories.base import BaseFactory
from polyfactory.field_meta import FieldMeta, Null
if TYPE_CHECKING:
from typing import Any, TypeGuard
try:
import attrs
from attr._make import Factory
from attrs import AttrsInstance
except ImportError as ex:
msg = "attrs is not installed"
raise MissingDependencyException(msg) from ex
T = TypeVar("T", bound=AttrsInstance)
class AttrsFactory(Generic[T], BaseFactory[T]):
"""Base factory for attrs classes."""
__model__: type[T]
__is_base_factory__ = True
@classmethod
def is_supported_type(cls, value: Any) -> TypeGuard[type[T]]:
return isclass(value) and hasattr(value, "__attrs_attrs__")
@classmethod
def get_model_fields(cls) -> list[FieldMeta]:
field_metas: list[FieldMeta] = []
none_type = type(None)
cls.resolve_types(cls.__model__)
fields = attrs.fields(cls.__model__)
for field in fields:
if not field.init:
continue
annotation = none_type if field.type is None else field.type
default = field.default
if isinstance(default, Factory):
# The default value is not currently being used when generating
# the field values. When that is implemented, this would need
# to be handled differently since the `default.factory` could
# take a `self` argument.
default_value = default.factory
elif default is None:
default_value = Null
else:
default_value = default
field_metas.append(
FieldMeta.from_type(
annotation=annotation,
name=field.alias,
default=default_value,
),
)
return field_metas
@classmethod
def resolve_types(cls, model: type[T], **kwargs: Any) -> None:
"""Resolve any strings and forward annotations in type annotations.
:param model: The model to resolve the type annotations for.
:param kwargs: Any parameters that need to be passed to `attrs.resolve_types`.
"""
attrs.resolve_types(model, **kwargs)
python-polyfactory-2.21.0/polyfactory/factories/base.py 0000664 0000000 0000000 00000140634 15000423051 0023302 0 ustar 00root root 0000000 0000000 from __future__ import annotations
import copy
import inspect
from abc import ABC, abstractmethod
from collections import Counter, abc, deque
from contextlib import suppress
from datetime import date, datetime, time, timedelta
from decimal import Decimal
from enum import EnumMeta
from functools import partial
from importlib import import_module
from ipaddress import (
IPv4Address,
IPv4Interface,
IPv4Network,
IPv6Address,
IPv6Interface,
IPv6Network,
ip_address,
ip_interface,
ip_network,
)
from os.path import realpath
from pathlib import Path
from random import Random
from typing import (
TYPE_CHECKING,
Any,
Callable,
ClassVar,
Collection,
Generic,
Hashable,
Iterable,
Mapping,
Sequence,
Type,
TypedDict,
TypeVar,
cast,
overload,
)
from uuid import UUID
from faker import Faker
from typing_extensions import Self, get_args, get_origin, get_original_bases
from polyfactory.constants import (
DEFAULT_RANDOM,
MAX_COLLECTION_LENGTH,
MIN_COLLECTION_LENGTH,
RANDOMIZE_COLLECTION_LENGTH,
)
from polyfactory.exceptions import ConfigurationException, MissingBuildKwargException, ParameterException
from polyfactory.field_meta import Null
from polyfactory.fields import Fixture, Ignore, PostGenerated, Require, Use
from polyfactory.utils.helpers import (
flatten_annotation,
get_collection_type,
unwrap_annotation,
unwrap_args,
unwrap_optional,
)
from polyfactory.utils.model_coverage import CoverageContainer, CoverageContainerCallable, resolve_kwargs_coverage
from polyfactory.utils.predicates import get_type_origin, is_literal, is_optional, is_safe_subclass, is_union
from polyfactory.utils.types import NoneType
from polyfactory.value_generators.complex_types import handle_collection_type, handle_collection_type_coverage
from polyfactory.value_generators.constrained_collections import (
handle_constrained_collection,
handle_constrained_mapping,
)
from polyfactory.value_generators.constrained_dates import handle_constrained_date
from polyfactory.value_generators.constrained_numbers import (
handle_constrained_decimal,
handle_constrained_float,
handle_constrained_int,
)
from polyfactory.value_generators.constrained_path import handle_constrained_path
from polyfactory.value_generators.constrained_strings import handle_constrained_string_or_bytes
from polyfactory.value_generators.constrained_url import handle_constrained_url
from polyfactory.value_generators.constrained_uuid import handle_constrained_uuid
from polyfactory.value_generators.primitives import create_random_boolean, create_random_bytes, create_random_string
if TYPE_CHECKING:
from typing_extensions import TypeGuard
from polyfactory.field_meta import Constraints, FieldMeta
from polyfactory.persistence import AsyncPersistenceProtocol, SyncPersistenceProtocol
T = TypeVar("T")
U = TypeVar("U")
F = TypeVar("F", bound="BaseFactory[Any]")
class BuildContext(TypedDict):
seen_models: set[type]
class BaseFactory(ABC, Generic[T]):
"""Base Factory class - this class holds the main logic of the library"""
# configuration attributes
__model__: type[T]
"""
The model for the factory.
This attribute is required for non-base factories and an exception will be raised if it's not set. Can be automatically inferred from the factory generic argument.
"""
__check_model__: bool = False
"""
Flag dictating whether to check if fields defined on the factory exists on the model or not.
If 'True', checks will be done against Use, PostGenerated, Ignore, Require constructs fields only.
"""
__allow_none_optionals__: ClassVar[bool] = True
"""
Flag dictating whether to allow 'None' for optional values.
If 'True', 'None' will be randomly generated as a value for optional model fields
"""
__sync_persistence__: type[SyncPersistenceProtocol[T]] | SyncPersistenceProtocol[T] | None = None
"""A sync persistence handler. Can be a class or a class instance."""
__async_persistence__: type[AsyncPersistenceProtocol[T]] | AsyncPersistenceProtocol[T] | None = None
"""An async persistence handler. Can be a class or a class instance."""
__set_as_default_factory_for_type__ = False
"""
Flag dictating whether to set as the default factory for the given type.
If 'True' the factory will be used instead of dynamically generating a factory for the type.
"""
__is_base_factory__: bool = False
"""
Flag dictating whether the factory is a 'base' factory. Base factories are registered globally as handlers for types.
For example, the 'DataclassFactory', 'TypedDictFactory' and 'ModelFactory' are all base factories.
"""
__base_factory_overrides__: dict[Any, type[BaseFactory[Any]]] | None = None
"""
A base factory to override with this factory. If this value is set, the given factory will replace the given base factory.
Note: this value can only be set when '__is_base_factory__' is 'True'.
"""
__faker__: ClassVar["Faker"] = Faker()
"""
A faker instance to use. Can be a user provided value.
"""
__random__: ClassVar["Random"] = DEFAULT_RANDOM
"""
An instance of 'random.Random' to use.
"""
__random_seed__: ClassVar[int]
"""
An integer to seed the factory's Faker and Random instances with.
This attribute can be used to control random generation.
"""
__randomize_collection_length__: ClassVar[bool] = RANDOMIZE_COLLECTION_LENGTH
"""
Flag dictating whether to randomize collections lengths.
"""
__min_collection_length__: ClassVar[int] = MIN_COLLECTION_LENGTH
"""
An integer value that defines minimum length of a collection.
"""
__max_collection_length__: ClassVar[int] = MAX_COLLECTION_LENGTH
"""
An integer value that defines maximum length of a collection.
"""
__use_defaults__: ClassVar[bool] = False
"""
Flag indicating whether to use the default value on a specific field, if provided.
"""
__config_keys__: tuple[str, ...] = (
"__check_model__",
"__allow_none_optionals__",
"__set_as_default_factory_for_type__",
"__faker__",
"__random__",
"__randomize_collection_length__",
"__min_collection_length__",
"__max_collection_length__",
"__use_defaults__",
)
"""Keys to be considered as config values to pass on to dynamically created factories."""
# cached attributes
_fields_metadata: list[FieldMeta]
# BaseFactory only attributes
_factory_type_mapping: ClassVar[dict[Any, type[BaseFactory[Any]]]]
_base_factories: ClassVar[list[type[BaseFactory[Any]]]]
_providers: ClassVar[dict[Any, Callable[[], Any]]]
"""Mapping of type providers that apply to all factories"""
# Non-public attributes
_extra_providers: dict[Any, Callable[[], Any]] | None = None
"""Used to copy providers from once base factory to another dynamically generated factory for a class"""
def __init_subclass__(cls, *args: Any, **kwargs: Any) -> None: # noqa: C901, PLR0912
super().__init_subclass__(*args, **kwargs)
if not hasattr(BaseFactory, "_base_factories"):
BaseFactory._base_factories = []
if not hasattr(BaseFactory, "_factory_type_mapping"):
BaseFactory._factory_type_mapping = {}
if not hasattr(BaseFactory, "_providers"):
BaseFactory._providers = {}
if cls.__min_collection_length__ > cls.__max_collection_length__:
msg = "Minimum collection length shouldn't be greater than maximum collection length"
raise ConfigurationException(
msg,
)
if "__is_base_factory__" not in cls.__dict__ or not cls.__is_base_factory__:
model: type[T] | None = getattr(cls, "__model__", None) or cls._infer_model_type()
if not model:
msg = f"required configuration attribute '__model__' is not set on {cls.__name__}"
raise ConfigurationException(
msg,
)
cls.__model__ = model
if not cls.is_supported_type(model):
for factory in BaseFactory._base_factories:
if factory.is_supported_type(model):
msg = f"{cls.__name__} does not support {model.__name__}, but this type is supported by the {factory.__name__} base factory class. To resolve this error, subclass the factory from {factory.__name__} instead of {cls.__name__}"
raise ConfigurationException(
msg,
)
msg = f"Model type {model.__name__} is not supported. To support it, register an appropriate base factory and subclass it for your factory."
raise ConfigurationException(
msg,
)
if cls.__check_model__:
cls._check_declared_fields_exist_in_model()
else:
BaseFactory._base_factories.append(cls)
random_seed = getattr(cls, "__random_seed__", None)
if random_seed is not None:
cls.seed_random(random_seed)
if cls.__set_as_default_factory_for_type__ and hasattr(cls, "__model__"):
BaseFactory._factory_type_mapping[cls.__model__] = cls
@classmethod
def _get_build_context(cls, build_context: BuildContext | None) -> BuildContext:
"""Return a BuildContext instance.
:returns: BuildContext
"""
if build_context is None:
return {"seen_models": set()}
return copy.deepcopy(build_context)
@classmethod
def _infer_model_type(cls) -> type[T] | None:
"""Return model type inferred from class declaration.
class Foo(ModelFactory[MyModel]): # <<< MyModel
...
If more than one base class and/or generic arguments specified return None.
:returns: Inferred model type or None
"""
factory_bases: Iterable[type[BaseFactory[T]]] = (
b for b in get_original_bases(cls) if get_origin(b) and issubclass(get_origin(b), BaseFactory)
)
generic_args: Sequence[type[T]] = [
arg for factory_base in factory_bases for arg in get_args(factory_base) if not isinstance(arg, TypeVar)
]
if len(generic_args) != 1:
return None
return generic_args[0]
@classmethod
def _get_sync_persistence(cls) -> SyncPersistenceProtocol[T]:
"""Return a SyncPersistenceHandler if defined for the factory, otherwise raises a ConfigurationException.
:raises: ConfigurationException
:returns: SyncPersistenceHandler
"""
if cls.__sync_persistence__:
return cls.__sync_persistence__() if callable(cls.__sync_persistence__) else cls.__sync_persistence__
msg = "A '__sync_persistence__' handler must be defined in the factory to use this method"
raise ConfigurationException(
msg,
)
@classmethod
def _get_async_persistence(cls) -> AsyncPersistenceProtocol[T]:
"""Return a AsyncPersistenceHandler if defined for the factory, otherwise raises a ConfigurationException.
:raises: ConfigurationException
:returns: AsyncPersistenceHandler
"""
if cls.__async_persistence__:
return cls.__async_persistence__() if callable(cls.__async_persistence__) else cls.__async_persistence__
msg = "An '__async_persistence__' handler must be defined in the factory to use this method"
raise ConfigurationException(
msg,
)
@classmethod
def _handle_factory_field( # noqa: PLR0911
cls,
field_value: Any,
build_context: BuildContext,
field_build_parameters: Any | None = None,
) -> Any:
"""Handle a value defined on the factory class itself.
:param field_value: A value defined as an attribute on the factory class.
:param field_build_parameters: Any build parameters passed to the factory as kwarg values.
:returns: An arbitrary value correlating with the given field_meta value.
"""
if is_safe_subclass(field_value, BaseFactory):
if isinstance(field_build_parameters, Mapping):
return field_value.build(_build_context=build_context, **field_build_parameters)
if isinstance(field_build_parameters, Sequence):
return [
field_value.build(_build_context=build_context, **parameter) for parameter in field_build_parameters
]
return field_value.build(_build_context=build_context)
if isinstance(field_value, Use):
return field_value.to_value()
if isinstance(field_value, Fixture):
return field_value.to_value()
if callable(field_value):
return field_value()
return field_value if isinstance(field_value, Hashable) else copy.deepcopy(field_value)
@classmethod
def _handle_factory_field_coverage(
cls,
field_value: Any,
field_build_parameters: Any | None = None,
build_context: BuildContext | None = None,
) -> Any:
"""Handle a value defined on the factory class itself.
:param field_value: A value defined as an attribute on the factory class.
:param field_build_parameters: Any build parameters passed to the factory as kwarg values.
:returns: An arbitrary value correlating with the given field_meta value.
"""
if is_safe_subclass(field_value, BaseFactory):
if isinstance(field_build_parameters, Mapping):
return CoverageContainer(field_value.coverage(_build_context=build_context, **field_build_parameters))
if isinstance(field_build_parameters, Sequence):
return [
CoverageContainer(field_value.coverage(_build_context=build_context, **parameter))
for parameter in field_build_parameters
]
return CoverageContainer(field_value.coverage())
if isinstance(field_value, Use):
return field_value.to_value()
if isinstance(field_value, Fixture):
return CoverageContainerCallable(field_value.to_value)
return CoverageContainerCallable(field_value) if callable(field_value) else field_value
@classmethod
def _get_config(cls) -> dict[str, Any]:
return {
**{key: getattr(cls, key) for key in cls.__config_keys__},
"_extra_providers": cls.get_provider_map(),
}
@classmethod
def _get_or_create_factory(cls, model: type[U]) -> type[BaseFactory[U]]:
"""Get a factory from registered factories or generate a factory dynamically.
:param model: A model type.
:returns: A Factory sub-class.
"""
if factory := BaseFactory._factory_type_mapping.get(model):
return factory
config = cls._get_config()
if cls.__base_factory_overrides__:
for model_ancestor in model.mro():
if factory := cls.__base_factory_overrides__.get(model_ancestor):
return factory.create_factory(model, **config)
for factory in reversed(BaseFactory._base_factories):
if factory.is_supported_type(model):
return factory.create_factory(model, **config)
msg = f"unsupported model type {model.__name__}"
raise ParameterException(msg) # pragma: no cover
@classmethod
def _get_initial_variables(cls, kwargs: Any) -> tuple[dict[str, Any], dict[str, PostGenerated], BuildContext]:
"""Prepare the given kwargs and generate initial variables for further usage.
:param kwargs: Any build kwargs.
:returns: A tuple of build results.
"""
_build_context = cls._get_build_context(kwargs.pop("_build_context", None))
_build_context["seen_models"].add(cls.__model__)
result: dict[str, Any] = {**kwargs}
generate_post: dict[str, PostGenerated] = {}
return result, generate_post, _build_context
# Public Methods
@classmethod
def add_provider(cls, provider_type: Any, provider_function: Callable[[], Any]) -> None:
"""Add a provider for a custom type to be available to all factories"""
cls._providers[provider_type] = provider_function
@classmethod
def is_factory_type(cls, annotation: Any) -> bool:
"""Determine whether a given field is annotated with a type that is supported by a base factory.
:param annotation: A type annotation.
:returns: Boolean dictating whether the annotation is a factory type
"""
return not inspect.isabstract(annotation) and any(
factory.is_supported_type(annotation) for factory in BaseFactory._base_factories
)
@classmethod
def is_batch_factory_type(cls, annotation: Any) -> bool:
"""Determine whether a given field is annotated with a sequence of supported factory types.
:param annotation: A type annotation.
:returns: Boolean dictating whether the annotation is a batch factory type
"""
origin = get_type_origin(annotation) or annotation
if is_safe_subclass(origin, Sequence) and (args := unwrap_args(annotation, random=cls.__random__)):
return len(args) == 1 and BaseFactory.is_factory_type(annotation=args[0])
return False
@classmethod
def extract_field_build_parameters(cls, field_meta: FieldMeta, build_args: dict[str, Any]) -> Any:
"""Extract from the build kwargs any build parameters passed for a given field meta - if it is a factory type.
:param field_meta: A field meta instance.
:param build_args: Any kwargs passed to the factory.
:returns: Any values
"""
if build_arg := build_args.get(field_meta.name):
annotation = unwrap_optional(field_meta.annotation)
if (
BaseFactory.is_factory_type(annotation=annotation)
and isinstance(build_arg, Mapping)
and not BaseFactory.is_factory_type(annotation=type(build_arg))
):
return build_args.pop(field_meta.name)
if (
BaseFactory.is_batch_factory_type(annotation=annotation)
and isinstance(build_arg, Sequence)
and not any(BaseFactory.is_factory_type(annotation=type(value)) for value in build_arg)
):
return build_args.pop(field_meta.name)
return None
@classmethod
@abstractmethod
def is_supported_type(cls, value: Any) -> "TypeGuard[type[T]]": # pragma: no cover
"""Determine whether the given value is supported by the factory.
:param value: An arbitrary value.
:returns: A typeguard
"""
raise NotImplementedError
@classmethod
def seed_random(cls, seed: int) -> None:
"""Seed faker and random with the given integer.
:param seed: An integer to set as seed.
:returns: 'None'
"""
cls.__random__ = Random(seed)
cls.__faker__.seed_instance(seed)
@classmethod
def is_ignored_type(cls, value: Any) -> bool:
"""Check whether a given value is an ignored type.
:param value: An arbitrary value.
:notes:
- This method is meant to be overwritten by extension factories and other subclasses
:returns: A boolean determining whether the value should be ignored.
"""
return value is None
@classmethod
def get_provider_map(cls) -> dict[Any, Callable[[], Any]]:
"""Map types to callables which accept no arguments and return a random value of the given type.
:notes:
- This method is distinct to allow overriding.
:returns: a dictionary mapping types to callables.
"""
def _create_generic_fn() -> Callable:
"""Return a generic lambda"""
return lambda *args: None
return {
Any: lambda: create_random_string(cls.__random__, min_length=1, max_length=10),
# primitives
object: object,
float: cls.__faker__.pyfloat,
int: cls.__faker__.pyint,
bool: cls.__faker__.pybool,
str: cls.__faker__.pystr,
bytes: partial(create_random_bytes, cls.__random__),
# built-in objects
dict: cls.__faker__.pydict,
tuple: cls.__faker__.pytuple,
list: cls.__faker__.pylist,
set: cls.__faker__.pyset,
frozenset: lambda: frozenset(cls.__faker__.pylist()),
deque: lambda: deque(cls.__faker__.pylist()),
# standard library objects
Path: lambda: Path(realpath(__file__)),
Decimal: cls.__faker__.pydecimal,
UUID: lambda: UUID(str(cls.__faker__.uuid4())),
# datetime
datetime: cls.__faker__.date_time_between,
date: cls.__faker__.date_this_decade,
time: cls.__faker__.time_object,
timedelta: cls.__faker__.time_delta,
# ip addresses
IPv4Address: lambda: ip_address(cls.__faker__.ipv4()),
IPv4Interface: lambda: ip_interface(cls.__faker__.ipv4()),
IPv4Network: lambda: ip_network(cls.__faker__.ipv4(network=True)),
IPv6Address: lambda: ip_address(cls.__faker__.ipv6()),
IPv6Interface: lambda: ip_interface(cls.__faker__.ipv6()),
IPv6Network: lambda: ip_network(cls.__faker__.ipv6(network=True)),
# types
Callable: _create_generic_fn,
abc.Callable: _create_generic_fn,
Counter: lambda: Counter(cls.__faker__.pystr()),
**(cls._providers or {}),
**(cls._extra_providers or {}),
}
@overload
@classmethod
def create_factory(
cls,
model: None = None,
bases: tuple[type[BaseFactory[Any]], ...] | None = None,
**kwargs: Any,
) -> type[Self]: ...
@overload
@classmethod
def create_factory(
cls,
model: type[U],
bases: tuple[type[BaseFactory[Any]], ...] | None = None,
**kwargs: Any,
) -> type[BaseFactory[U]]: ...
@classmethod
def create_factory(
cls,
model: type[U] | None = None,
bases: tuple[type[BaseFactory[Any]], ...] | None = None,
**kwargs: Any,
) -> type[Self | BaseFactory[U]]:
"""Generate a factory for the given type dynamically.
:param model: A type to model. Defaults to current factory __model__ if any.
Otherwise, raise an error
:param bases: Base classes to use when generating the new class.
:param kwargs: Any kwargs.
:returns: A 'ModelFactory' subclass.
"""
if model is None:
try:
model = cls.__model__ # pyright: ignore[reportAssignmentType]
except AttributeError as ex:
msg = "A 'model' argument is required when creating a new factory from a base one"
raise TypeError(msg) from ex
return cast(
"Type[Self]",
type(
f"{model.__name__}Factory", # pyright: ignore[reportOptionalMemberAccess]
(*(bases or ()), cls),
{"__model__": model, **kwargs},
),
)
@classmethod
def get_constrained_field_value( # noqa: C901, PLR0911
cls,
annotation: Any,
field_meta: FieldMeta,
field_build_parameters: Any | None = None,
build_context: BuildContext | None = None,
) -> Any:
try:
constraints = cast("Constraints", field_meta.constraints)
if is_safe_subclass(annotation, float):
return handle_constrained_float(
random=cls.__random__,
multiple_of=cast("Any", constraints.get("multiple_of")),
gt=cast("Any", constraints.get("gt")),
ge=cast("Any", constraints.get("ge")),
lt=cast("Any", constraints.get("lt")),
le=cast("Any", constraints.get("le")),
)
if is_safe_subclass(annotation, int):
return handle_constrained_int(
random=cls.__random__,
multiple_of=cast("Any", constraints.get("multiple_of")),
gt=cast("Any", constraints.get("gt")),
ge=cast("Any", constraints.get("ge")),
lt=cast("Any", constraints.get("lt")),
le=cast("Any", constraints.get("le")),
)
if is_safe_subclass(annotation, Decimal):
return handle_constrained_decimal(
random=cls.__random__,
decimal_places=cast("Any", constraints.get("decimal_places")),
max_digits=cast("Any", constraints.get("max_digits")),
multiple_of=cast("Any", constraints.get("multiple_of")),
gt=cast("Any", constraints.get("gt")),
ge=cast("Any", constraints.get("ge")),
lt=cast("Any", constraints.get("lt")),
le=cast("Any", constraints.get("le")),
)
if url_constraints := constraints.get("url"):
return handle_constrained_url(constraints=url_constraints)
if is_safe_subclass(annotation, str) or is_safe_subclass(annotation, bytes):
return handle_constrained_string_or_bytes(
random=cls.__random__,
t_type=str if is_safe_subclass(annotation, str) else bytes,
lower_case=constraints.get("lower_case") or False,
upper_case=constraints.get("upper_case") or False,
min_length=constraints.get("min_length"),
max_length=constraints.get("max_length"),
pattern=constraints.get("pattern"),
)
try:
collection_type = get_collection_type(annotation)
except ValueError:
collection_type = None
if collection_type is not None:
if collection_type is dict:
return handle_constrained_mapping(
factory=cls,
field_meta=field_meta,
min_items=constraints.get("min_length"),
max_items=constraints.get("max_length"),
field_build_parameters=field_build_parameters,
build_context=build_context,
)
return handle_constrained_collection(
collection_type=collection_type, # type: ignore[type-var]
factory=cls,
field_meta=field_meta.children[0] if field_meta.children else field_meta,
item_type=constraints.get("item_type"),
max_items=constraints.get("max_length"),
min_items=constraints.get("min_length"),
unique_items=constraints.get("unique_items", False),
field_build_parameters=field_build_parameters,
build_context=build_context,
)
if is_safe_subclass(annotation, date):
return handle_constrained_date(
faker=cls.__faker__,
ge=cast("Any", constraints.get("ge")),
gt=cast("Any", constraints.get("gt")),
le=cast("Any", constraints.get("le")),
lt=cast("Any", constraints.get("lt")),
tz=cast("Any", constraints.get("tz")),
)
if is_safe_subclass(annotation, UUID) and (uuid_version := constraints.get("uuid_version")):
return handle_constrained_uuid(
uuid_version=uuid_version,
faker=cls.__faker__,
)
if is_safe_subclass(annotation, Path) and (path_constraint := constraints.get("path_type")):
return handle_constrained_path(constraint=path_constraint, faker=cls.__faker__)
except TypeError as e:
raise ParameterException from e
msg = f"received constraints for unsupported type {annotation}"
raise ParameterException(msg)
@classmethod
def get_field_value( # noqa: C901, PLR0911, PLR0912
cls,
field_meta: FieldMeta,
field_build_parameters: Any | None = None,
build_context: BuildContext | None = None,
) -> Any:
"""Return a field value on the subclass if existing, otherwise returns a mock value.
:param field_meta: FieldMeta instance.
:param field_build_parameters: Any build parameters passed to the factory as kwarg values.
:param build_context: BuildContext data for current build.
:returns: An arbitrary value.
"""
build_context = cls._get_build_context(build_context)
if cls.is_ignored_type(field_meta.annotation):
return None
if field_build_parameters is None and cls.should_set_none_value(field_meta=field_meta):
return None
unwrapped_annotation = unwrap_annotation(field_meta.annotation, random=cls.__random__)
if is_literal(annotation=unwrapped_annotation) and (literal_args := get_args(unwrapped_annotation)):
return cls.__random__.choice(literal_args)
if isinstance(unwrapped_annotation, EnumMeta):
return cls.__random__.choice(list(unwrapped_annotation))
if field_meta.constraints:
return cls.get_constrained_field_value(
annotation=unwrapped_annotation,
field_meta=field_meta,
field_build_parameters=field_build_parameters,
build_context=build_context,
)
if is_union(field_meta.annotation) and field_meta.children:
seen_models = build_context["seen_models"]
children = [child for child in field_meta.children if child.annotation not in seen_models]
# `None` is removed from the children when creating FieldMeta so when `children`
# is empty, it must mean that the field meta is an optional type.
if not children:
return None
return cls.get_field_value(cls.__random__.choice(children), field_build_parameters, build_context)
if BaseFactory.is_factory_type(annotation=unwrapped_annotation):
if not field_build_parameters and unwrapped_annotation in build_context["seen_models"]:
return None if is_optional(field_meta.annotation) else Null
return cls._get_or_create_factory(model=unwrapped_annotation).build(
_build_context=build_context,
**(field_build_parameters if isinstance(field_build_parameters, Mapping) else {}),
)
if BaseFactory.is_batch_factory_type(annotation=unwrapped_annotation):
factory = cls._get_or_create_factory(model=field_meta.type_args[0])
if isinstance(field_build_parameters, Sequence):
return [
factory.build(_build_context=build_context, **field_parameters)
for field_parameters in field_build_parameters
]
if field_meta.type_args[0] in build_context["seen_models"]:
return []
if not cls.__randomize_collection_length__:
return [factory.build(_build_context=build_context)]
batch_size = cls.__random__.randint(cls.__min_collection_length__, cls.__max_collection_length__)
return factory.batch(size=batch_size, _build_context=build_context)
if (origin := get_type_origin(unwrapped_annotation)) and is_safe_subclass(origin, Collection):
collection_type = get_collection_type(unwrapped_annotation)
is_fixed_length = collection_type is tuple and (
not field_meta.children or field_meta.children[-1].annotation != Ellipsis
)
if cls.__randomize_collection_length__ and not is_fixed_length:
if collection_type is not dict:
return handle_constrained_collection(
collection_type=collection_type, # type: ignore[type-var]
factory=cls,
item_type=Any,
field_meta=field_meta.children[0] if field_meta.children else field_meta,
min_items=cls.__min_collection_length__,
max_items=cls.__max_collection_length__,
field_build_parameters=field_build_parameters,
build_context=build_context,
)
return handle_constrained_mapping(
factory=cls,
field_meta=field_meta,
min_items=cls.__min_collection_length__,
max_items=cls.__max_collection_length__,
field_build_parameters=field_build_parameters,
build_context=build_context,
)
return handle_collection_type(
field_meta,
origin,
cls,
field_build_parameters=field_build_parameters,
build_context=build_context,
)
provider_map = cls.get_provider_map()
if provider := (provider_map.get(field_meta.annotation) or provider_map.get(unwrapped_annotation)):
return provider()
if isinstance(unwrapped_annotation, TypeVar):
return create_random_string(cls.__random__, min_length=1, max_length=10)
if callable(unwrapped_annotation):
# if value is a callable we can try to naively call it.
# this will work for callables that do not require any parameters passed
with suppress(Exception):
return unwrapped_annotation()
msg = (
f"Unsupported type: {unwrapped_annotation!r} on field '{field_meta.name}' from class {cls.__name__}."
"\n\nEither use 'add_provider', extend the providers map, or add a factory function for the field on the model."
)
raise ParameterException(
msg,
)
@classmethod
def get_field_value_coverage( # noqa: C901,PLR0912
cls,
field_meta: FieldMeta,
field_build_parameters: Any | None = None,
build_context: BuildContext | None = None,
) -> Iterable[Any]:
"""Return a field value on the subclass if existing, otherwise returns a mock value.
:param field_meta: FieldMeta instance.
:param field_build_parameters: Any build parameters passed to the factory as kwarg values.
:param build_context: BuildContext data for current build.
:returns: An iterable of values.
"""
if cls.is_ignored_type(field_meta.annotation):
return
for unwrapped_annotation in flatten_annotation(field_meta.annotation):
if unwrapped_annotation in (None, NoneType):
yield None
elif is_literal(annotation=unwrapped_annotation) and (literal_args := get_args(unwrapped_annotation)):
yield CoverageContainer(literal_args)
elif isinstance(unwrapped_annotation, EnumMeta):
yield CoverageContainer(list(unwrapped_annotation))
elif field_meta.constraints:
yield CoverageContainerCallable(
cls.get_constrained_field_value,
annotation=unwrapped_annotation,
field_meta=field_meta,
)
elif BaseFactory.is_factory_type(annotation=unwrapped_annotation):
yield CoverageContainer(
cls._get_or_create_factory(model=unwrapped_annotation).coverage(
_build_context=build_context,
**(field_build_parameters if isinstance(field_build_parameters, Mapping) else {}),
),
)
elif (origin := get_type_origin(unwrapped_annotation)) and issubclass(origin, Collection):
if not field_meta.children:
msg = "A subclass of Collection should always have children in it's field_meta"
raise ParameterException(msg)
# We actually want to use the parent in cases where the collection is the parent
# such as tuple so default to the parent if this annotation is not present in the children
child_meta = next(
(meta for meta in field_meta.children if meta.annotation == unwrapped_annotation),
field_meta,
)
yield handle_collection_type_coverage(child_meta, origin, cls, build_context=build_context)
elif provider := (
(provider_map := cls.get_provider_map()).get(field_meta.annotation)
or provider_map.get(unwrapped_annotation)
):
yield CoverageContainerCallable(provider)
elif isinstance(unwrapped_annotation, TypeVar):
yield create_random_string(cls.__random__, min_length=1, max_length=10)
elif callable(unwrapped_annotation):
# if value is a callable we can try to naively call it.
# this will work for callables that do not require any parameters passed
yield CoverageContainerCallable(unwrapped_annotation)
else:
msg = f"Unsupported type: {unwrapped_annotation!r}\n\nEither extend the providers map or add a factory function for this type."
raise ParameterException(
msg,
)
@classmethod
def should_set_none_value(cls, field_meta: FieldMeta) -> bool:
"""Determine whether a given model field_meta should be set to None.
:param field_meta: Field metadata.
:notes:
- This method is distinct to allow overriding.
:returns: A boolean determining whether 'None' should be set for the given field_meta.
"""
return (
cls.__allow_none_optionals__
and is_optional(field_meta.annotation)
and create_random_boolean(random=cls.__random__)
)
@classmethod
def should_use_default_value(cls, field_meta: FieldMeta) -> bool:
"""Determine whether to use the default value for the given field.
:param field_meta: FieldMeta instance.
:notes:
- This method is distinct to allow overriding.
:returns: A boolean determining whether the default value should be used for the given field_meta.
"""
return cls.__use_defaults__ and field_meta.default is not Null
@classmethod
def should_set_field_value(cls, field_meta: FieldMeta, **kwargs: Any) -> bool:
"""Determine whether to set a value for a given field_name.
:param field_meta: FieldMeta instance.
:param kwargs: Any kwargs passed to the factory.
:notes:
- This method is distinct to allow overriding.
:returns: A boolean determining whether a value should be set for the given field_meta.
"""
return not field_meta.name.startswith("_") and field_meta.name not in kwargs
@classmethod
@abstractmethod
def get_model_fields(cls) -> list[FieldMeta]: # pragma: no cover
"""Retrieve a list of fields from the factory's model.
:returns: A list of field MetaData instances.
"""
raise NotImplementedError
@classmethod
def get_factory_fields(cls) -> list[tuple[str, Any]]:
"""Retrieve a list of fields from the factory.
Trying to be smart about what should be considered a field on the model,
ignoring dunder methods and some parent class attributes.
:returns: A list of tuples made of field name and field definition
"""
factory_fields = cls.__dict__.items()
return [
(field_name, field_value)
for field_name, field_value in factory_fields
if not (field_name.startswith("__") or field_name == "_abc_impl")
]
@classmethod
def _check_declared_fields_exist_in_model(cls) -> None:
model_fields_names = {field_meta.name for field_meta in cls.get_model_fields()}
factory_fields = cls.get_factory_fields()
for field_name, field_value in factory_fields:
if field_name in model_fields_names:
continue
error_message = (
f"{field_name} is declared on the factory {cls.__name__}"
f" but it is not part of the model {cls.__model__.__name__}"
)
if isinstance(field_value, (Use, PostGenerated, Ignore, Require)):
raise ConfigurationException(error_message)
@classmethod
def process_kwargs(cls, **kwargs: Any) -> dict[str, Any]:
"""Process the given kwargs and generate values for the factory's model.
:param kwargs: Any build kwargs.
:returns: A dictionary of build results.
"""
result, generate_post, _build_context = cls._get_initial_variables(kwargs)
for field_meta in cls.get_model_fields():
field_build_parameters = cls.extract_field_build_parameters(field_meta=field_meta, build_args=kwargs)
if cls.should_set_field_value(field_meta, **kwargs) and not cls.should_use_default_value(field_meta):
if hasattr(cls, field_meta.name) and not hasattr(BaseFactory, field_meta.name):
field_value = getattr(cls, field_meta.name)
if isinstance(field_value, Ignore):
continue
if isinstance(field_value, Require) and field_meta.name not in kwargs:
msg = f"Require kwarg {field_meta.name} is missing"
raise MissingBuildKwargException(msg)
if isinstance(field_value, PostGenerated):
generate_post[field_meta.name] = field_value
continue
result[field_meta.name] = cls._handle_factory_field(
field_value=field_value,
field_build_parameters=field_build_parameters,
build_context=_build_context,
)
continue
field_result = cls.get_field_value(
field_meta,
field_build_parameters=field_build_parameters,
build_context=_build_context,
)
if field_result is Null:
continue
result[field_meta.name] = field_result
for field_name, post_generator in generate_post.items():
result[field_name] = post_generator.to_value(field_name, result)
return result
@classmethod
def process_kwargs_coverage(cls, **kwargs: Any) -> abc.Iterable[dict[str, Any]]:
"""Process the given kwargs and generate values for the factory's model.
:param kwargs: Any build kwargs.
:param build_context: BuildContext data for current build.
:returns: A dictionary of build results.
"""
result, generate_post, _build_context = cls._get_initial_variables(kwargs)
for field_meta in cls.get_model_fields():
field_build_parameters = cls.extract_field_build_parameters(field_meta=field_meta, build_args=kwargs)
if cls.should_set_field_value(field_meta, **kwargs):
if hasattr(cls, field_meta.name) and not hasattr(BaseFactory, field_meta.name):
field_value = getattr(cls, field_meta.name)
if isinstance(field_value, Ignore):
continue
if isinstance(field_value, Require) and field_meta.name not in kwargs:
msg = f"Require kwarg {field_meta.name} is missing"
raise MissingBuildKwargException(msg)
if isinstance(field_value, PostGenerated):
generate_post[field_meta.name] = field_value
continue
result[field_meta.name] = cls._handle_factory_field_coverage(
field_value=field_value,
field_build_parameters=field_build_parameters,
build_context=_build_context,
)
continue
result[field_meta.name] = CoverageContainer(
cls.get_field_value_coverage(
field_meta,
field_build_parameters=field_build_parameters,
build_context=_build_context,
),
)
for resolved in resolve_kwargs_coverage(result):
for field_name, post_generator in generate_post.items():
resolved[field_name] = post_generator.to_value(field_name, resolved)
yield resolved
@classmethod
def build(cls, *_: Any, **kwargs: Any) -> T:
"""Build an instance of the factory's __model__
:param kwargs: Any kwargs. If field names are set in kwargs, their values will be used.
:returns: An instance of type T.
"""
return cast("T", cls.__model__(**cls.process_kwargs(**kwargs)))
@classmethod
def batch(cls, size: int, **kwargs: Any) -> list[T]:
"""Build a batch of size n of the factory's Meta.model.
:param size: Size of the batch.
:param kwargs: Any kwargs. If field_meta names are set in kwargs, their values will be used.
:returns: A list of instances of type T.
"""
return [cls.build(**kwargs) for _ in range(size)]
@classmethod
def coverage(cls, **kwargs: Any) -> abc.Iterator[T]:
"""Build a batch of the factory's Meta.model with full coverage of the sub-types of the model.
:param kwargs: Any kwargs. If field_meta names are set in kwargs, their values will be used.
:returns: A iterator of instances of type T.
"""
for data in cls.process_kwargs_coverage(**kwargs):
instance = cls.__model__(**data)
yield cast("T", instance)
@classmethod
def create_sync(cls, **kwargs: Any) -> T:
"""Build and persists synchronously a single model instance.
:param kwargs: Any kwargs. If field_meta names are set in kwargs, their values will be used.
:returns: An instance of type T.
"""
return cls._get_sync_persistence().save(data=cls.build(**kwargs))
@classmethod
def create_batch_sync(cls, size: int, **kwargs: Any) -> list[T]:
"""Build and persists synchronously a batch of n size model instances.
:param size: Size of the batch.
:param kwargs: Any kwargs. If field_meta names are set in kwargs, their values will be used.
:returns: A list of instances of type T.
"""
return cls._get_sync_persistence().save_many(data=cls.batch(size, **kwargs))
@classmethod
async def create_async(cls, **kwargs: Any) -> T:
"""Build and persists asynchronously a single model instance.
:param kwargs: Any kwargs. If field_meta names are set in kwargs, their values will be used.
:returns: An instance of type T.
"""
return await cls._get_async_persistence().save(data=cls.build(**kwargs))
@classmethod
async def create_batch_async(cls, size: int, **kwargs: Any) -> list[T]:
"""Build and persists asynchronously a batch of n size model instances.
:param size: Size of the batch.
:param kwargs: Any kwargs. If field_meta names are set in kwargs, their values will be used.
:returns: A list of instances of type T.
"""
return await cls._get_async_persistence().save_many(data=cls.batch(size, **kwargs))
def _register_builtin_factories() -> None:
"""This function is used to register the base factories, if present.
:returns: None
"""
import polyfactory.factories.dataclass_factory
import polyfactory.factories.typed_dict_factory # noqa: F401
for module in [
"polyfactory.factories.pydantic_factory",
"polyfactory.factories.beanie_odm_factory",
"polyfactory.factories.odmantic_odm_factory",
"polyfactory.factories.msgspec_factory",
# `AttrsFactory` is not being registered by default since not all versions of `attrs` are supported.
# Issue: https://github.com/litestar-org/polyfactory/issues/356
# "polyfactory.factories.attrs_factory",
]:
try:
import_module(module)
except ImportError: # noqa: PERF203
continue
_register_builtin_factories()
python-polyfactory-2.21.0/polyfactory/factories/beanie_odm_factory.py 0000664 0000000 0000000 00000005753 15000423051 0026203 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from typing import TYPE_CHECKING, Any, Generic, TypeVar
from typing_extensions import get_args
from polyfactory.exceptions import MissingDependencyException
from polyfactory.factories.pydantic_factory import ModelFactory
from polyfactory.persistence import AsyncPersistenceProtocol
from polyfactory.utils.predicates import is_safe_subclass
if TYPE_CHECKING:
from typing_extensions import TypeGuard
from polyfactory.factories.base import BuildContext
from polyfactory.field_meta import FieldMeta
try:
from beanie import Document
except ImportError as e:
msg = "beanie is not installed"
raise MissingDependencyException(msg) from e
T = TypeVar("T", bound=Document)
class BeaniePersistenceHandler(Generic[T], AsyncPersistenceProtocol[T]):
"""Persistence Handler using beanie logic"""
async def save(self, data: T) -> T:
"""Persist a single instance in mongoDB."""
return await data.insert() # pyright: ignore[reportGeneralTypeIssues]
async def save_many(self, data: list[T]) -> list[T]:
"""Persist multiple instances in mongoDB.
.. note:: we cannot use the ``.insert_many`` method from Beanie here because it doesn't
return the created instances
"""
return [await doc.insert() for doc in data] # pyright: ignore[reportGeneralTypeIssues]
class BeanieDocumentFactory(Generic[T], ModelFactory[T]):
"""Base factory for Beanie Documents"""
__async_persistence__ = BeaniePersistenceHandler
__is_base_factory__ = True
@classmethod
def is_supported_type(cls, value: Any) -> "TypeGuard[type[T]]":
"""Determine whether the given value is supported by the factory.
:param value: An arbitrary value.
:returns: A typeguard
"""
return is_safe_subclass(value, Document)
@classmethod
def get_field_value(
cls,
field_meta: "FieldMeta",
field_build_parameters: Any | None = None,
build_context: BuildContext | None = None,
) -> Any:
"""Return a field value on the subclass if existing, otherwise returns a mock value.
:param field_meta: FieldMeta instance.
:param field_build_parameters: Any build parameters passed to the factory as kwarg values.
:param build_context: BuildContext instance.
:returns: An arbitrary value.
"""
if hasattr(field_meta.annotation, "__name__"):
if "Indexed " in field_meta.annotation.__name__:
base_type = field_meta.annotation.__bases__[0]
field_meta.annotation = base_type
if "Link" in field_meta.annotation.__name__:
link_class = get_args(field_meta.annotation)[0]
field_meta.annotation = link_class
field_meta.annotation = link_class
return super().get_field_value(
field_meta=field_meta,
field_build_parameters=field_build_parameters,
build_context=build_context,
)
python-polyfactory-2.21.0/polyfactory/factories/dataclass_factory.py 0000664 0000000 0000000 00000003240 15000423051 0026045 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from dataclasses import MISSING, fields, is_dataclass
from typing import Any, Generic
from typing_extensions import TypeGuard, get_type_hints
from polyfactory.factories.base import BaseFactory, T
from polyfactory.field_meta import FieldMeta, Null
class DataclassFactory(Generic[T], BaseFactory[T]):
"""Dataclass base factory"""
__is_base_factory__ = True
@classmethod
def is_supported_type(cls, value: Any) -> TypeGuard[type[T]]:
"""Determine whether the given value is supported by the factory.
:param value: An arbitrary value.
:returns: A typeguard
"""
return bool(is_dataclass(value))
@classmethod
def get_model_fields(cls) -> list["FieldMeta"]:
"""Retrieve a list of fields from the factory's model.
:returns: A list of field MetaData instances.
"""
fields_meta: list["FieldMeta"] = []
model_type_hints = get_type_hints(cls.__model__, include_extras=True)
for field in fields(cls.__model__): # type: ignore[arg-type]
if not field.init:
continue
if field.default_factory and field.default_factory is not MISSING:
default_value = field.default_factory()
elif field.default is not MISSING:
default_value = field.default
else:
default_value = Null
fields_meta.append(
FieldMeta.from_type(
annotation=model_type_hints[field.name],
name=field.name,
default=default_value,
),
)
return fields_meta
python-polyfactory-2.21.0/polyfactory/factories/msgspec_factory.py 0000664 0000000 0000000 00000004565 15000423051 0025562 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from inspect import isclass
from typing import TYPE_CHECKING, Any, Callable, Generic, TypeVar
from typing_extensions import get_type_hints
from polyfactory.exceptions import MissingDependencyException
from polyfactory.factories.base import BaseFactory
from polyfactory.field_meta import FieldMeta, Null
from polyfactory.value_generators.constrained_numbers import handle_constrained_int
from polyfactory.value_generators.primitives import create_random_bytes
if TYPE_CHECKING:
from typing_extensions import TypeGuard
try:
import msgspec
from msgspec.structs import fields
except ImportError as e:
msg = "msgspec is not installed"
raise MissingDependencyException(msg) from e
T = TypeVar("T", bound=msgspec.Struct)
class MsgspecFactory(Generic[T], BaseFactory[T]):
"""Base factory for msgspec Structs."""
__is_base_factory__ = True
@classmethod
def get_provider_map(cls) -> dict[Any, Callable[[], Any]]:
def get_msgpack_ext() -> msgspec.msgpack.Ext:
code = handle_constrained_int(cls.__random__, ge=-128, le=127)
data = create_random_bytes(cls.__random__)
return msgspec.msgpack.Ext(code, data)
msgspec_provider_map = {msgspec.UnsetType: lambda: msgspec.UNSET, msgspec.msgpack.Ext: get_msgpack_ext}
provider_map = super().get_provider_map()
provider_map.update(msgspec_provider_map)
return provider_map
@classmethod
def is_supported_type(cls, value: Any) -> TypeGuard[type[T]]:
return isclass(value) and hasattr(value, "__struct_fields__")
@classmethod
def get_model_fields(cls) -> list[FieldMeta]:
fields_meta: list[FieldMeta] = []
type_hints = get_type_hints(cls.__model__, include_extras=True)
for field in fields(cls.__model__):
annotation = type_hints[field.name]
if field.default is not msgspec.NODEFAULT:
default_value = field.default
elif field.default_factory is not msgspec.NODEFAULT:
default_value = field.default_factory()
else:
default_value = Null
fields_meta.append(
FieldMeta.from_type(
annotation=annotation,
name=field.name,
default=default_value,
),
)
return fields_meta
python-polyfactory-2.21.0/polyfactory/factories/odmantic_odm_factory.py 0000664 0000000 0000000 00000004237 15000423051 0026552 0 ustar 00root root 0000000 0000000 from __future__ import annotations
import decimal
from typing import TYPE_CHECKING, Any, Callable, Generic, TypeVar, Union
from polyfactory.exceptions import MissingDependencyException
from polyfactory.factories.pydantic_factory import ModelFactory
from polyfactory.utils.predicates import is_safe_subclass
from polyfactory.value_generators.primitives import create_random_bytes
try:
from bson.decimal128 import Decimal128, create_decimal128_context
from odmantic import EmbeddedModel, Model
from odmantic import bson as odbson
except ImportError as e:
msg = "odmantic is not installed"
raise MissingDependencyException(msg) from e
T = TypeVar("T", bound=Union[Model, EmbeddedModel])
if TYPE_CHECKING:
from typing_extensions import TypeGuard
class OdmanticModelFactory(Generic[T], ModelFactory[T]):
"""Base factory for odmantic models"""
__is_base_factory__ = True
@classmethod
def is_supported_type(cls, value: Any) -> "TypeGuard[type[T]]":
"""Determine whether the given value is supported by the factory.
:param value: An arbitrary value.
:returns: A typeguard
"""
return is_safe_subclass(value, (Model, EmbeddedModel))
@classmethod
def get_provider_map(cls) -> dict[Any, Callable[[], Any]]:
provider_map = super().get_provider_map()
provider_map.update(
{
odbson.Int64: lambda: odbson.Int64.validate(cls.__faker__.pyint()),
odbson.Decimal128: lambda: _to_decimal128(cls.__faker__.pydecimal()),
odbson.Binary: lambda: odbson.Binary.validate(create_random_bytes(cls.__random__)),
odbson._datetime: lambda: odbson._datetime.validate(cls.__faker__.date_time_between()),
# bson.Regex and bson._Pattern not supported as there is no way to generate
# a random regular expression with Faker
# bson.Regex:
# bson._Pattern:
},
)
return provider_map
def _to_decimal128(value: decimal.Decimal) -> Decimal128:
with decimal.localcontext(create_decimal128_context()) as ctx:
return Decimal128(ctx.create_decimal(value))
python-polyfactory-2.21.0/polyfactory/factories/pydantic_factory.py 0000664 0000000 0000000 00000063070 15000423051 0025730 0 ustar 00root root 0000000 0000000 from __future__ import annotations
import copy
from contextlib import suppress
from datetime import timezone
from functools import partial
from os.path import realpath
from pathlib import Path
from typing import TYPE_CHECKING, Any, ClassVar, ForwardRef, Generic, Mapping, TypeVar, cast
from uuid import NAMESPACE_DNS, uuid1, uuid3, uuid5
from typing_extensions import Literal, get_args
from polyfactory.exceptions import MissingDependencyException
from polyfactory.factories.base import BaseFactory, BuildContext
from polyfactory.factories.base import BuildContext as BaseBuildContext
from polyfactory.field_meta import Constraints, FieldMeta, Null
from polyfactory.utils.deprecation import check_for_deprecated_parameters
from polyfactory.utils.helpers import unwrap_new_type, unwrap_optional
from polyfactory.utils.predicates import is_optional, is_safe_subclass, is_union
from polyfactory.utils.types import NoneType
from polyfactory.value_generators.primitives import create_random_bytes
try:
import pydantic
from pydantic import (
VERSION,
AnyHttpUrl,
AnyUrl,
ByteSize,
EmailStr,
FutureDate,
HttpUrl,
IPvAnyAddress,
IPvAnyInterface,
IPvAnyNetwork,
Json,
NameEmail,
NegativeFloat,
NegativeInt,
NonNegativeInt,
NonPositiveFloat,
PastDate,
PaymentCardNumber,
PositiveFloat,
PositiveInt,
SecretBytes,
SecretStr,
StrictBool,
StrictBytes,
StrictFloat,
StrictInt,
StrictStr,
)
from pydantic.fields import FieldInfo
except ImportError as e:
msg = "pydantic is not installed"
raise MissingDependencyException(msg) from e
try:
# pydantic v1
import pydantic as pydantic_v1
from pydantic import BaseModel as BaseModelV1
# Keep this import last to prevent warnings from pydantic if pydantic v2
# is installed.
from pydantic.color import Color
from pydantic.fields import ( # type: ignore[attr-defined]
DeferredType, # pyright: ignore[attr-defined,reportAttributeAccessIssue]
ModelField, # pyright: ignore[attr-defined,reportAttributeAccessIssue]
Undefined, # pyright: ignore[attr-defined,reportAttributeAccessIssue]
)
# prevent unbound variable warnings
BaseModelV2 = BaseModelV1
UndefinedV2 = Undefined
except ImportError:
# pydantic v2
# v2 specific imports
from pydantic import BaseModel as BaseModelV2
from pydantic_core import PydanticUndefined as UndefinedV2
from pydantic_core import to_json
import pydantic.v1 as pydantic_v1 # type: ignore[no-redef]
from pydantic.v1 import BaseModel as BaseModelV1 # type: ignore[assignment]
from pydantic.v1.color import Color # type: ignore[assignment]
from pydantic.v1.fields import DeferredType, ModelField, Undefined
if TYPE_CHECKING:
from collections import abc
from random import Random
from typing import Callable, Sequence
from typing_extensions import NotRequired, TypeGuard
from pydantic import BaseModel
T = TypeVar("T", bound="BaseModel")
_IS_PYDANTIC_V1 = VERSION.startswith("1")
class PydanticBuildContext(BaseBuildContext):
factory_use_construct: bool
class PydanticConstraints(Constraints):
"""Metadata regarding a Pydantic type constraints, if any"""
json: NotRequired[bool]
class PydanticFieldMeta(FieldMeta):
"""Field meta subclass capable of handling pydantic ModelFields"""
def __init__(
self,
*,
name: str,
annotation: type,
random: Random | None = None,
default: Any = ...,
children: list[FieldMeta] | None = None,
constraints: PydanticConstraints | None = None,
examples: list[Any] | None = None,
) -> None:
super().__init__(
name=name,
annotation=annotation,
random=random,
default=default,
children=children,
constraints=constraints,
)
self.examples = examples
@classmethod
def from_field_info(
cls,
field_name: str,
field_info: FieldInfo,
use_alias: bool,
random: Random | None = None,
randomize_collection_length: bool | None = None,
min_collection_length: int | None = None,
max_collection_length: int | None = None,
) -> PydanticFieldMeta:
"""Create an instance from a pydantic field info.
:param field_name: The name of the field.
:param field_info: A pydantic FieldInfo instance.
:param use_alias: Whether to use the field alias.
:param random: A random.Random instance.
:param randomize_collection_length: Whether to randomize collection length.
:param min_collection_length: Minimum collection length.
:param max_collection_length: Maximum collection length.
:returns: A PydanticFieldMeta instance.
"""
check_for_deprecated_parameters(
"2.11.0",
parameters=(
("randomize_collection_length", randomize_collection_length),
("min_collection_length", min_collection_length),
("max_collection_length", max_collection_length),
("random", random),
),
)
if callable(field_info.default_factory):
default_value = field_info.default_factory
else:
default_value = field_info.default if field_info.default is not UndefinedV2 else Null
annotation = unwrap_new_type(field_info.annotation)
children: list[FieldMeta,] | None = None
name = field_info.alias if field_info.alias and use_alias else field_name
constraints: PydanticConstraints
# pydantic v2 does not always propagate metadata for Union types
if is_union(annotation):
constraints = {}
children = []
for arg in get_args(annotation):
if arg is NoneType:
continue
child_field_info = FieldInfo.from_annotation(arg)
merged_field_info = FieldInfo.merge_field_infos(field_info, child_field_info)
children.append(
cls.from_field_info(
field_name="",
field_info=merged_field_info,
use_alias=use_alias,
),
)
else:
metadata, is_json = [], False
for m in field_info.metadata:
if not is_json and isinstance(m, Json): # type: ignore[misc]
is_json = True
elif m is not None:
metadata.append(m)
constraints = cast(
"PydanticConstraints",
cls.parse_constraints(metadata=metadata) if metadata else {},
)
if "url" in constraints:
# pydantic uses a sentinel value for url constraints
annotation = str
if is_json:
constraints["json"] = True
result = PydanticFieldMeta.from_type(
annotation=annotation,
children=children,
constraints=cast("Constraints", {k: v for k, v in constraints.items() if v is not None}) or None,
default=default_value,
name=name,
)
result.examples = field_info.examples
return result
@classmethod
def from_model_field( # pragma: no cover
cls,
model_field: ModelField, # pyright: ignore[reportGeneralTypeIssues]
use_alias: bool,
randomize_collection_length: bool | None = None,
min_collection_length: int | None = None,
max_collection_length: int | None = None,
random: Random | None = None,
) -> PydanticFieldMeta:
"""Create an instance from a pydantic model field.
:param model_field: A pydantic ModelField.
:param use_alias: Whether to use the field alias.
:param randomize_collection_length: A boolean flag whether to randomize collections lengths
:param min_collection_length: Minimum number of elements in randomized collection
:param max_collection_length: Maximum number of elements in randomized collection
:param random: An instance of random.Random.
:returns: A PydanticFieldMeta instance.
"""
check_for_deprecated_parameters(
"2.11.0",
parameters=(
("randomize_collection_length", randomize_collection_length),
("min_collection_length", min_collection_length),
("max_collection_length", max_collection_length),
("random", random),
),
)
if model_field.default is not Undefined:
default_value = model_field.default
elif callable(model_field.default_factory):
default_value = model_field.default_factory()
else:
default_value = model_field.default if model_field.default is not Undefined else Null
name = model_field.alias if model_field.alias and use_alias else model_field.name
outer_type = unwrap_new_type(model_field.outer_type_)
annotation = (
model_field.outer_type_
if isinstance(model_field.annotation, (DeferredType, ForwardRef))
else unwrap_new_type(model_field.annotation)
)
constraints = cast(
"Constraints",
{
"ge": getattr(outer_type, "ge", model_field.field_info.ge),
"gt": getattr(outer_type, "gt", model_field.field_info.gt),
"le": getattr(outer_type, "le", model_field.field_info.le),
"lt": getattr(outer_type, "lt", model_field.field_info.lt),
"min_length": (
getattr(outer_type, "min_length", model_field.field_info.min_length)
or getattr(outer_type, "min_items", model_field.field_info.min_items)
),
"max_length": (
getattr(outer_type, "max_length", model_field.field_info.max_length)
or getattr(outer_type, "max_items", model_field.field_info.max_items)
),
"pattern": getattr(outer_type, "regex", model_field.field_info.regex),
"unique_items": getattr(outer_type, "unique_items", model_field.field_info.unique_items),
"decimal_places": getattr(outer_type, "decimal_places", None),
"max_digits": getattr(outer_type, "max_digits", None),
"multiple_of": getattr(outer_type, "multiple_of", None),
"upper_case": getattr(outer_type, "to_upper", None),
"lower_case": getattr(outer_type, "to_lower", None),
"item_type": getattr(outer_type, "item_type", None),
},
)
# pydantic v1 has constraints set for these values, but we generate them using faker
if unwrap_optional(annotation) in (
AnyUrl,
AnyHttpUrl,
HttpUrl,
pydantic_v1.AnyUrl,
pydantic_v1.AnyHttpUrl,
pydantic_v1.HttpUrl,
pydantic_v1.KafkaDsn,
pydantic_v1.PostgresDsn,
pydantic_v1.RedisDsn,
pydantic_v1.AmqpDsn,
pydantic_v1.EmailStr,
pydantic_v1.NameEmail,
):
constraints = {}
if model_field.field_info.const and (
default_value is None or isinstance(default_value, (int, bool, str, bytes))
):
annotation = Literal[default_value]
children: list[FieldMeta] = []
# Refer #412.
args = get_args(model_field.annotation)
if is_optional(model_field.annotation) and len(args) == 2: # noqa: PLR2004
child_annotation = args[0] if args[0] is not NoneType else args[1]
children.append(PydanticFieldMeta.from_type(child_annotation))
elif model_field.key_field or model_field.sub_fields:
fields_to_iterate = (
([model_field.key_field, *model_field.sub_fields])
if model_field.key_field is not None
else model_field.sub_fields
)
children.extend(
PydanticFieldMeta.from_model_field(
model_field=arg,
use_alias=use_alias,
)
for arg in fields_to_iterate
)
examples = None
return PydanticFieldMeta(
name=name,
annotation=annotation, # pyright: ignore[reportArgumentType]
children=children or None,
default=default_value,
constraints=cast("PydanticConstraints", {k: v for k, v in constraints.items() if v is not None}) or None,
examples=examples,
)
if not _IS_PYDANTIC_V1:
@classmethod
def get_constraints_metadata(cls, annotation: Any) -> Sequence[Any]:
metadata = []
for m in super().get_constraints_metadata(annotation):
if isinstance(m, FieldInfo):
metadata.extend(m.metadata)
else:
metadata.append(m)
return metadata
class ModelFactory(Generic[T], BaseFactory[T]):
"""Base factory for pydantic models"""
__forward_ref_resolution_type_mapping__: ClassVar[Mapping[str, type]] = {}
__is_base_factory__ = True
__use_examples__: ClassVar[bool] = False # for backwards compatibility
"""
Flag indicating whether to use a random example, if provided (Pydantic >=V2)
Example code::
class Payment(BaseModel):
amount: int = Field(0)
currency: str = Field(examples=['USD', 'EUR', 'INR'])
class PaymentFactory(ModelFactory[Payment]):
__use_examples__ = True
>>> payment = PaymentFactory.build()
>>> payment
Payment(amount=120, currency="EUR")
"""
__config_keys__ = (
*BaseFactory.__config_keys__,
"__use_examples__",
)
def __init_subclass__(cls, *args: Any, **kwargs: Any) -> None:
super().__init_subclass__(*args, **kwargs)
if (
getattr(cls, "__model__", None)
and _is_pydantic_v1_model(cls.__model__)
and hasattr(cls.__model__, "update_forward_refs")
):
with suppress(NameError): # pragma: no cover
cls.__model__.update_forward_refs(**cls.__forward_ref_resolution_type_mapping__) # type: ignore[attr-defined]
@classmethod
def is_supported_type(cls, value: Any) -> TypeGuard[type[T]]:
"""Determine whether the given value is supported by the factory.
:param value: An arbitrary value.
:returns: A typeguard
"""
return _is_pydantic_v1_model(value) or _is_pydantic_v2_model(value)
@classmethod
def get_model_fields(cls) -> list["FieldMeta"]:
"""Retrieve a list of fields from the factory's model.
:returns: A list of field MetaData instances.
"""
if "_fields_metadata" not in cls.__dict__:
if _is_pydantic_v1_model(cls.__model__):
cls._fields_metadata = [
PydanticFieldMeta.from_model_field(
field,
use_alias=not cls.__model__.__config__.allow_population_by_field_name, # type: ignore[attr-defined]
)
for field in cls.__model__.__fields__.values()
]
else:
cls._fields_metadata = [
PydanticFieldMeta.from_field_info(
field_info=field_info,
field_name=field_name,
use_alias=not cls.__model__.model_config.get( # pyright: ignore[reportGeneralTypeIssues]
"populate_by_name",
False,
),
)
for field_name, field_info in cls.__model__.model_fields.items() # pyright: ignore[reportGeneralTypeIssues]
]
return cls._fields_metadata
@classmethod
def get_constrained_field_value(
cls,
annotation: Any,
field_meta: FieldMeta,
field_build_parameters: Any | None = None,
build_context: BuildContext | None = None,
) -> Any:
constraints = cast("PydanticConstraints", field_meta.constraints)
if constraints.pop("json", None):
value = cls.get_field_value(
field_meta, field_build_parameters=field_build_parameters, build_context=build_context
)
return to_json(value) # pyright: ignore[reportPossiblyUnboundVariable]
return super().get_constrained_field_value(
annotation, field_meta, field_build_parameters=field_build_parameters, build_context=build_context
)
@classmethod
def get_field_value(
cls,
field_meta: FieldMeta,
field_build_parameters: Any | None = None,
build_context: BuildContext | None = None,
) -> Any:
"""Return a value from examples if exists, else random value.
:param field_meta: FieldMeta instance.
:param field_build_parameters: Any build parameters passed to the factory as kwarg values.
:param build_context: BuildContext data for current build.
:returns: An arbitrary value.
"""
result: Any
field_meta = cast("PydanticFieldMeta", field_meta)
if cls.__use_examples__ and field_meta.examples:
result = cls.__random__.choice(field_meta.examples)
else:
result = super().get_field_value(
field_meta=field_meta, field_build_parameters=field_build_parameters, build_context=build_context
)
return result
@classmethod
def build(
cls,
factory_use_construct: bool = False,
**kwargs: Any,
) -> T:
"""Build an instance of the factory's __model__
:param factory_use_construct: A boolean that determines whether validations will be made when instantiating the
model. This is supported only for pydantic models.
:param kwargs: Any kwargs. If field_meta names are set in kwargs, their values will be used.
:returns: An instance of type T.
"""
if "_build_context" not in kwargs:
kwargs["_build_context"] = PydanticBuildContext(
seen_models=set(),
factory_use_construct=factory_use_construct,
)
processed_kwargs = cls.process_kwargs(**kwargs)
return cls._create_model(kwargs["_build_context"], **processed_kwargs)
@classmethod
def _get_build_context(cls, build_context: BaseBuildContext | PydanticBuildContext | None) -> PydanticBuildContext:
"""Return a PydanticBuildContext instance. If build_context is None, return a new PydanticBuildContext.
:returns: PydanticBuildContext
"""
if build_context is None:
return {"seen_models": set(), "factory_use_construct": False}
factory_use_construct = bool(build_context.get("factory_use_construct", False))
return {
"seen_models": copy.deepcopy(build_context["seen_models"]),
"factory_use_construct": factory_use_construct,
}
@classmethod
def _create_model(cls, _build_context: PydanticBuildContext, **kwargs: Any) -> T:
"""Create an instance of the factory's __model__
:param _build_context: BuildContext instance.
:param kwargs: Model kwargs.
:returns: An instance of type T.
"""
if cls._get_build_context(_build_context).get("factory_use_construct"):
if _is_pydantic_v1_model(cls.__model__):
return cls.__model__.construct(**kwargs) # type: ignore[return-value]
return cls.__model__.model_construct(**kwargs)
return cls.__model__(**kwargs)
@classmethod
def coverage(cls, factory_use_construct: bool = False, **kwargs: Any) -> abc.Iterator[T]:
"""Build a batch of the factory's Meta.model will full coverage of the sub-types of the model.
:param kwargs: Any kwargs. If field_meta names are set in kwargs, their values will be used.
:returns: A iterator of instances of type T.
"""
if "_build_context" not in kwargs:
kwargs["_build_context"] = PydanticBuildContext(
seen_models=set(), factory_use_construct=factory_use_construct
)
for data in cls.process_kwargs_coverage(**kwargs):
yield cls._create_model(_build_context=kwargs["_build_context"], **data)
@classmethod
def is_custom_root_field(cls, field_meta: FieldMeta) -> bool:
"""Determine whether the field is a custom root field.
:param field_meta: FieldMeta instance.
:returns: A boolean determining whether the field is a custom root.
"""
return field_meta.name == "__root__"
@classmethod
def should_set_field_value(cls, field_meta: FieldMeta, **kwargs: Any) -> bool:
"""Determine whether to set a value for a given field_name.
This is an override of BaseFactory.should_set_field_value.
:param field_meta: FieldMeta instance.
:param kwargs: Any kwargs passed to the factory.
:returns: A boolean determining whether a value should be set for the given field_meta.
"""
return field_meta.name not in kwargs and (
not field_meta.name.startswith("_") or cls.is_custom_root_field(field_meta)
)
@classmethod
def get_provider_map(cls) -> dict[Any, Callable[[], Any]]:
mapping: dict[Any, Callable[[], Any]] = {
ByteSize: cls.__faker__.pyint,
PositiveInt: cls.__faker__.pyint,
NegativeFloat: lambda: cls.__random__.uniform(-100, -1),
NegativeInt: lambda: cls.__faker__.pyint() * -1,
PositiveFloat: cls.__faker__.pyint,
NonPositiveFloat: lambda: cls.__random__.uniform(-100, 0),
NonNegativeInt: cls.__faker__.pyint,
StrictInt: cls.__faker__.pyint,
StrictBool: cls.__faker__.pybool,
StrictBytes: lambda: create_random_bytes(cls.__random__),
StrictFloat: cls.__faker__.pyfloat,
StrictStr: cls.__faker__.pystr,
EmailStr: cls.__faker__.free_email,
NameEmail: cls.__faker__.free_email,
Json: cls.__faker__.json,
PaymentCardNumber: cls.__faker__.credit_card_number,
AnyUrl: cls.__faker__.url,
AnyHttpUrl: cls.__faker__.url,
HttpUrl: cls.__faker__.url,
SecretBytes: lambda: create_random_bytes(cls.__random__),
SecretStr: cls.__faker__.pystr,
IPvAnyAddress: cls.__faker__.ipv4,
IPvAnyInterface: cls.__faker__.ipv4,
IPvAnyNetwork: lambda: cls.__faker__.ipv4(network=True),
PastDate: cls.__faker__.past_date,
FutureDate: cls.__faker__.future_date,
}
# v1 only values
mapping.update(
{
pydantic_v1.AnyUrl: cls.__faker__.url,
pydantic_v1.AnyHttpUrl: cls.__faker__.url,
pydantic_v1.HttpUrl: cls.__faker__.url,
pydantic_v1.PyObject: lambda: "decimal.Decimal",
pydantic_v1.AmqpDsn: lambda: "amqps://example.com",
pydantic_v1.KafkaDsn: lambda: "kafka://localhost:9092",
pydantic_v1.PostgresDsn: lambda: "postgresql://user@localhost",
pydantic_v1.RedisDsn: lambda: "redis://localhost:6379/0",
pydantic_v1.FilePath: lambda: Path(realpath(__file__)),
pydantic_v1.DirectoryPath: lambda: Path(realpath(__file__)).parent,
pydantic_v1.UUID1: uuid1,
pydantic_v1.UUID3: lambda: uuid3(NAMESPACE_DNS, cls.__faker__.pystr()),
pydantic_v1.UUID4: cls.__faker__.uuid4,
pydantic_v1.UUID5: lambda: uuid5(NAMESPACE_DNS, cls.__faker__.pystr()),
Color: cls.__faker__.hex_color, # pyright: ignore[reportGeneralTypeIssues]
pydantic_v1.EmailStr: cls.__faker__.free_email,
pydantic_v1.NameEmail: cls.__faker__.free_email,
},
)
if not _IS_PYDANTIC_V1:
mapping.update(
{
# pydantic v2 specific types
pydantic.PastDatetime: cls.__faker__.past_datetime,
pydantic.FutureDatetime: cls.__faker__.future_datetime,
pydantic.AwareDatetime: partial(cls.__faker__.date_time, timezone.utc),
pydantic.NaiveDatetime: cls.__faker__.date_time,
pydantic.networks.AmqpDsn: lambda: "amqps://example.com",
pydantic.networks.KafkaDsn: lambda: "kafka://localhost:9092",
pydantic.networks.PostgresDsn: lambda: "postgresql://user@localhost",
pydantic.networks.RedisDsn: lambda: "redis://localhost:6379/0",
pydantic.networks.MongoDsn: lambda: "mongodb://mongodb0.example.com:27017",
pydantic.networks.MariaDBDsn: lambda: "mariadb://example.com:3306",
pydantic.networks.CockroachDsn: lambda: "cockroachdb://example.com:5432",
pydantic.networks.MySQLDsn: lambda: "mysql://example.com:5432",
},
)
mapping.update(super().get_provider_map())
return mapping
def _is_pydantic_v1_model(model: Any) -> TypeGuard[BaseModelV1]:
return is_safe_subclass(model, BaseModelV1)
def _is_pydantic_v2_model(model: Any) -> TypeGuard[BaseModelV2]: # pyright: ignore[reportInvalidTypeForm]
return not _IS_PYDANTIC_V1 and is_safe_subclass(model, BaseModelV2)
python-polyfactory-2.21.0/polyfactory/factories/sqlalchemy_factory.py 0000664 0000000 0000000 00000025514 15000423051 0026260 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from datetime import date, datetime
from typing import TYPE_CHECKING, Any, Callable, ClassVar, Generic, List, Protocol, TypeVar, Union
from typing_extensions import Annotated
from polyfactory.exceptions import MissingDependencyException, ParameterException
from polyfactory.factories.base import BaseFactory
from polyfactory.field_meta import Constraints, FieldMeta
from polyfactory.persistence import AsyncPersistenceProtocol, SyncPersistenceProtocol
from polyfactory.utils.types import Frozendict
try:
from sqlalchemy import ARRAY, Column, Numeric, String, inspect, types
from sqlalchemy.dialects import mssql, mysql, postgresql, sqlite
from sqlalchemy.exc import NoInspectionAvailable
from sqlalchemy.ext.associationproxy import AssociationProxy
from sqlalchemy.orm import InstanceState, Mapper
except ImportError as e:
msg = "sqlalchemy is not installed"
raise MissingDependencyException(msg) from e
if TYPE_CHECKING:
from sqlalchemy.ext.asyncio import AsyncSession
from sqlalchemy.orm import Session
from sqlalchemy.sql.type_api import TypeEngine
from typing_extensions import TypeGuard
T = TypeVar("T")
class SQLASyncPersistence(SyncPersistenceProtocol[T]):
def __init__(self, session: Session) -> None:
"""Sync persistence handler for SQLAFactory."""
self.session = session
def save(self, data: T) -> T:
self.session.add(data)
self.session.commit()
return data
def save_many(self, data: list[T]) -> list[T]:
self.session.add_all(data)
self.session.commit()
return data
class SQLAASyncPersistence(AsyncPersistenceProtocol[T]):
def __init__(self, session: AsyncSession) -> None:
"""Async persistence handler for SQLAFactory."""
self.session = session
async def save(self, data: T) -> T:
async with self.session as session:
session.add(data)
await session.commit()
await session.refresh(data)
return data
async def save_many(self, data: list[T]) -> list[T]:
async with self.session as session:
session.add_all(data)
await session.commit()
for batch_item in data:
await session.refresh(batch_item)
return data
_T_co = TypeVar("_T_co", covariant=True)
class _SessionMaker(Protocol[_T_co]):
@staticmethod
def __call__() -> _T_co: ...
class SQLAlchemyFactory(Generic[T], BaseFactory[T]):
"""Base factory for SQLAlchemy models."""
__is_base_factory__ = True
__set_primary_key__: ClassVar[bool] = True
"""Configuration to consider primary key columns as a field or not."""
__set_foreign_keys__: ClassVar[bool] = True
"""Configuration to consider columns with foreign keys as a field or not."""
__set_relationships__: ClassVar[bool] = False
"""Configuration to consider relationships property as a model field or not."""
__set_association_proxy__: ClassVar[bool] = False
"""Configuration to consider AssociationProxy property as a model field or not."""
__session__: ClassVar[Session | _SessionMaker[Session] | None] = None
__async_session__: ClassVar[AsyncSession | _SessionMaker[AsyncSession] | None] = None
__config_keys__ = (
*BaseFactory.__config_keys__,
"__set_primary_key__",
"__set_foreign_keys__",
"__set_relationships__",
"__set_association_proxy__",
)
@classmethod
def get_sqlalchemy_types(cls) -> dict[Any, Callable[[], Any]]:
"""Get mapping of types where column type should be used directly.
For sqlalchemy dialect `JSON` type, accepted only basic types in pydict in case sqlalchemy process `JSON` raise serialize error.
"""
return {
types.TupleType: cls.__faker__.pytuple,
mssql.JSON: lambda: cls.__faker__.pydict(value_types=(str, int, bool, float)),
mysql.YEAR: lambda: cls.__random__.randint(1901, 2155),
mysql.JSON: lambda: cls.__faker__.pydict(value_types=(str, int, bool, float)),
postgresql.CIDR: lambda: cls.__faker__.ipv4(network=True),
postgresql.DATERANGE: lambda: (cls.__faker__.past_date(), date.today()), # noqa: DTZ011
postgresql.INET: lambda: cls.__faker__.ipv4(network=False),
postgresql.INT4RANGE: lambda: tuple(sorted([cls.__faker__.pyint(), cls.__faker__.pyint()])),
postgresql.INT8RANGE: lambda: tuple(sorted([cls.__faker__.pyint(), cls.__faker__.pyint()])),
postgresql.MACADDR: lambda: cls.__faker__.hexify(text="^^:^^:^^:^^:^^:^^", upper=True),
postgresql.NUMRANGE: lambda: tuple(sorted([cls.__faker__.pyint(), cls.__faker__.pyint()])),
postgresql.TSRANGE: lambda: (cls.__faker__.past_datetime(), datetime.now()), # noqa: DTZ005
postgresql.TSTZRANGE: lambda: (cls.__faker__.past_datetime(), datetime.now()), # noqa: DTZ005
postgresql.HSTORE: lambda: cls.__faker__.pydict(value_types=(str, int, bool, float)),
postgresql.JSON: lambda: cls.__faker__.pydict(value_types=(str, int, bool, float)),
postgresql.JSONB: lambda: cls.__faker__.pydict(value_types=(str, int, bool, float)),
sqlite.JSON: lambda: cls.__faker__.pydict(value_types=(str, int, bool, float)),
types.JSON: lambda: cls.__faker__.pydict(value_types=(str, int, bool, float)),
}
@classmethod
def get_sqlalchemy_constraints(cls) -> dict[type[TypeEngine], dict[str, str]]:
"""Get mapping of SQLA type engine to attribute to constraints key."""
return {
String: {
"length": "max_length",
},
Numeric: {
"precision": "max_digits",
"scale": "decimal_places",
},
}
@classmethod
def get_provider_map(cls) -> dict[Any, Callable[[], Any]]:
providers_map = super().get_provider_map()
providers_map.update(cls.get_sqlalchemy_types())
return providers_map
@classmethod
def is_supported_type(cls, value: Any) -> TypeGuard[type[T]]:
try:
inspected = inspect(value)
except NoInspectionAvailable:
return False
return isinstance(inspected, (Mapper, InstanceState))
@classmethod
def should_column_be_set(cls, column: Any) -> bool:
if not isinstance(column, Column):
return False
if not cls.__set_primary_key__ and column.primary_key:
return False
return bool(cls.__set_foreign_keys__ or not column.foreign_keys)
@classmethod
def _get_type_from_type_engine(cls, type_engine: TypeEngine) -> type:
if type(type_engine) in cls.get_sqlalchemy_types():
return type(type_engine)
annotation: type
try:
annotation = type_engine.python_type
except NotImplementedError:
if not hasattr(type_engine, "impl"):
msg = f"Unsupported type engine: {type_engine}.\nOverride get_sqlalchemy_types to support"
raise ParameterException(msg) from None
annotation = type_engine.impl.python_type # pyright: ignore[reportAttributeAccessIssue]
constraints: Constraints = {}
for type_, constraint_fields in cls.get_sqlalchemy_constraints().items():
if not isinstance(type_engine, type_):
continue
for sqlalchemy_field, constraint_field in constraint_fields.items():
if (value := getattr(type_engine, sqlalchemy_field, None)) is not None:
constraints[constraint_field] = value # type: ignore[literal-required]
if constraints:
annotation = Annotated[annotation, Frozendict(constraints)] # type: ignore[assignment]
return annotation
@classmethod
def get_type_from_column(cls, column: Column) -> type:
annotation: type
if isinstance(column.type, (ARRAY, postgresql.ARRAY)):
item_type = cls._get_type_from_type_engine(column.type.item_type)
annotation = List[item_type] # type: ignore[valid-type]
else:
annotation = cls._get_type_from_type_engine(column.type)
if column.nullable:
annotation = Union[annotation, None] # type: ignore[assignment]
return annotation
@classmethod
def get_model_fields(cls) -> list[FieldMeta]:
fields_meta: list[FieldMeta] = []
table: Mapper = inspect(cls.__model__) # type: ignore[assignment]
fields_meta.extend(
FieldMeta.from_type(
annotation=cls.get_type_from_column(column),
name=name,
)
for name, column in table.columns.items()
if cls.should_column_be_set(column)
)
if cls.__set_relationships__:
for name, relationship in table.relationships.items():
class_ = relationship.entity.class_
annotation = class_ if not relationship.uselist else List[class_] # type: ignore[valid-type]
fields_meta.append(
FieldMeta.from_type(
name=name,
annotation=annotation,
),
)
if cls.__set_association_proxy__:
for name, attr in table.all_orm_descriptors.items():
if isinstance(attr, AssociationProxy):
target_collection = table.relationships.get(attr.target_collection)
if target_collection:
target_class = target_collection.entity.class_
target_attr = getattr(target_class, attr.value_attr)
if target_attr:
class_ = target_attr.entity.class_
annotation = class_ if not target_collection.uselist else List[class_] # type: ignore[valid-type]
fields_meta.append(
FieldMeta.from_type(
name=name,
annotation=annotation,
)
)
return fields_meta
@classmethod
def _get_sync_persistence(cls) -> SyncPersistenceProtocol[T]:
if cls.__session__ is not None:
return (
SQLASyncPersistence(cls.__session__())
if callable(cls.__session__)
else SQLASyncPersistence(cls.__session__)
)
return super()._get_sync_persistence()
@classmethod
def _get_async_persistence(cls) -> AsyncPersistenceProtocol[T]:
if cls.__async_session__ is not None:
return (
SQLAASyncPersistence(cls.__async_session__())
if callable(cls.__async_session__)
else SQLAASyncPersistence(cls.__async_session__)
)
return super()._get_async_persistence()
python-polyfactory-2.21.0/polyfactory/factories/typed_dict_factory.py 0000664 0000000 0000000 00000003310 15000423051 0026234 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from typing import Any, Generic, TypeVar, get_args
from typing_extensions import ( # type: ignore[attr-defined]
NotRequired,
Required,
TypeGuard,
_TypedDictMeta, # pyright: ignore[reportAttributeAccessIssue]
get_origin,
get_type_hints,
is_typeddict,
)
from polyfactory.factories.base import BaseFactory
from polyfactory.field_meta import FieldMeta, Null
TypedDictT = TypeVar("TypedDictT", bound=_TypedDictMeta)
class TypedDictFactory(Generic[TypedDictT], BaseFactory[TypedDictT]):
"""TypedDict base factory"""
__is_base_factory__ = True
@classmethod
def is_supported_type(cls, value: Any) -> TypeGuard[type[TypedDictT]]:
"""Determine whether the given value is supported by the factory.
:param value: An arbitrary value.
:returns: A typeguard
"""
return is_typeddict(value)
@classmethod
def get_model_fields(cls) -> list["FieldMeta"]:
"""Retrieve a list of fields from the factory's model.
:returns: A list of field MetaData instances.
"""
model_type_hints = get_type_hints(cls.__model__, include_extras=True)
field_metas: list[FieldMeta] = []
for field_name, annotation in model_type_hints.items():
origin = get_origin(annotation)
if origin in (Required, NotRequired):
annotation = get_args(annotation)[0] # noqa: PLW2901
field_metas.append(
FieldMeta.from_type(
annotation=annotation,
name=field_name,
default=getattr(cls.__model__, field_name, Null),
),
)
return field_metas
python-polyfactory-2.21.0/polyfactory/field_meta.py 0000664 0000000 0000000 00000021676 15000423051 0022506 0 ustar 00root root 0000000 0000000 from __future__ import annotations
import functools
from dataclasses import asdict
from typing import TYPE_CHECKING, Any, Hashable, Literal, Mapping, Pattern, TypedDict, cast
from typing_extensions import get_args, get_origin
from polyfactory.constants import DEFAULT_RANDOM, TYPE_MAPPING
from polyfactory.utils.deprecation import check_for_deprecated_parameters
from polyfactory.utils.helpers import get_annotation_metadata, is_dataclass_instance, unwrap_annotated, unwrap_new_type
from polyfactory.utils.predicates import is_annotated
from polyfactory.utils.types import NoneType
if TYPE_CHECKING:
import datetime
from decimal import Decimal
from random import Random
from typing import Sequence
from typing_extensions import NotRequired, Self
class Null:
"""Sentinel class for empty values"""
class UrlConstraints(TypedDict):
max_length: NotRequired[int]
allowed_schemes: NotRequired[list[str]]
host_required: NotRequired[bool]
default_host: NotRequired[str]
default_port: NotRequired[int]
default_path: NotRequired[str]
class Constraints(TypedDict):
"""Metadata regarding a type constraints, if any"""
allow_inf_nan: NotRequired[bool]
decimal_places: NotRequired[int]
ge: NotRequired[int | float | Decimal]
gt: NotRequired[int | float | Decimal]
item_type: NotRequired[Any]
le: NotRequired[int | float | Decimal]
lower_case: NotRequired[bool]
lt: NotRequired[int | float | Decimal]
max_digits: NotRequired[int]
max_length: NotRequired[int]
min_length: NotRequired[int]
multiple_of: NotRequired[int | float | Decimal]
path_type: NotRequired[Literal["file", "dir", "new"]]
pattern: NotRequired[str | Pattern]
tz: NotRequired[datetime.tzinfo]
unique_items: NotRequired[bool]
upper_case: NotRequired[bool]
url: NotRequired[UrlConstraints]
uuid_version: NotRequired[Literal[1, 3, 4, 5]]
class FieldMeta:
"""Factory field metadata container. This class is used to store the data about a field of a factory's model."""
__slots__ = ("__dict__", "annotation", "children", "constraints", "default", "name", "random")
annotation: Any
random: Random
children: list[FieldMeta] | None
default: Any
name: str
constraints: Constraints | None
def __init__(
self,
*,
name: str,
annotation: type,
random: Random | None = None,
default: Any = Null,
children: list[FieldMeta] | None = None,
constraints: Constraints | None = None,
) -> None:
"""Create a factory field metadata instance."""
check_for_deprecated_parameters("2.20.0", parameters=(("random", random),))
self.annotation = annotation
self.random = random or DEFAULT_RANDOM
self.children = children
self.default = default
self.name = name
self.constraints = constraints
@functools.cached_property
def type_args(self) -> tuple[Any, ...]:
"""Return the normalized type args of the annotation, if any.
:returns: a tuple of types.
"""
annotation = self.annotation
if is_annotated(annotation):
annotation = get_args(self.annotation)[0]
return tuple(
TYPE_MAPPING.get(arg, arg) if isinstance(arg, Hashable) else arg # pyright: ignore[reportCallIssue,reportArgumentType]
for arg in get_args(annotation)
)
@classmethod
def from_type(
cls,
annotation: Any,
random: Random | None = None,
name: str = "",
default: Any = Null,
constraints: Constraints | None = None,
randomize_collection_length: bool | None = None,
min_collection_length: int | None = None,
max_collection_length: int | None = None,
children: list[FieldMeta] | None = None,
) -> Self:
"""Builder method to create a FieldMeta from a type annotation.
:param annotation: A type annotation.
:param random: An instance of random.Random.
:param name: Field name
:param default: Default value, if any.
:param constraints: A dictionary of constraints, if any.
:param randomize_collection_length: A boolean flag whether to randomize collections lengths
:param min_collection_length: Minimum number of elements in randomized collection
:param max_collection_length: Maximum number of elements in randomized collection
:returns: A field meta instance.
"""
check_for_deprecated_parameters(
"2.11.0",
parameters=(
("randomize_collection_length", randomize_collection_length),
("min_collection_length", min_collection_length),
("max_collection_length", max_collection_length),
("random", random),
),
)
annotated = is_annotated(annotation)
if not constraints and annotated:
metadata = cls.get_constraints_metadata(annotation)
constraints = cls.parse_constraints(metadata)
if not annotated and (origin := get_origin(annotation)) and origin in TYPE_MAPPING:
container = TYPE_MAPPING[origin]
annotation = container[get_args(annotation)] # type: ignore[index]
field = cls(
annotation=annotation,
name=name,
default=default,
children=children,
constraints=constraints,
)
if field.type_args and not field.children:
field.children = [
cls.from_type(annotation=unwrap_new_type(arg)) for arg in field.type_args if arg is not NoneType
]
return field
@classmethod
def parse_constraints(cls, metadata: Sequence[Any]) -> "Constraints":
constraints = {}
for value in metadata:
if is_annotated(value):
_, inner_metadata = unwrap_annotated(value, random=DEFAULT_RANDOM)
constraints.update(cast("dict[str, Any]", cls.parse_constraints(metadata=inner_metadata)))
elif func := getattr(value, "func", None):
if func is str.islower:
constraints["lower_case"] = True
elif func is str.isupper:
constraints["upper_case"] = True
elif func is str.isascii:
constraints["pattern"] = "[[:ascii:]]"
elif func is str.isdigit:
constraints["pattern"] = "[[:digit:]]"
elif is_dataclass_instance(value) and (value_dict := asdict(value)) and ("allowed_schemes" in value_dict):
constraints["url"] = {k: v for k, v in value_dict.items() if v is not None}
# This is to support `Constraints`, but we can't do a isinstance with `Constraints` since isinstance
# checks with `TypedDict` is not supported.
elif isinstance(value, Mapping):
constraints.update(value)
else:
constraints.update(
{
k: v
for k, v in {
"allow_inf_nan": getattr(value, "allow_inf_nan", None),
"decimal_places": getattr(value, "decimal_places", None),
"ge": getattr(value, "ge", None),
"gt": getattr(value, "gt", None),
"item_type": getattr(value, "item_type", None),
"le": getattr(value, "le", None),
"lower_case": getattr(value, "to_lower", None),
"lt": getattr(value, "lt", None),
"max_digits": getattr(value, "max_digits", None),
"max_length": getattr(value, "max_length", getattr(value, "max_length", None)),
"min_length": getattr(value, "min_length", getattr(value, "min_items", None)),
"multiple_of": getattr(value, "multiple_of", None),
"path_type": getattr(value, "path_type", None),
"pattern": getattr(value, "regex", getattr(value, "pattern", None)),
"tz": getattr(value, "tz", None),
"unique_items": getattr(value, "unique_items", None),
"upper_case": getattr(value, "to_upper", None),
"uuid_version": getattr(value, "uuid_version", None),
}.items()
if v is not None
},
)
return cast("Constraints", constraints)
@classmethod
def get_constraints_metadata(cls, annotation: Any) -> Sequence[Any]:
"""Get the metadatas of the constraints from the given annotation.
:param annotation: A type annotation.
:param random: An instance of random.Random.
:returns: A list of the metadata in the annotation.
"""
return get_annotation_metadata(annotation)
python-polyfactory-2.21.0/polyfactory/fields.py 0000664 0000000 0000000 00000006717 15000423051 0021662 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from typing import Any, Callable, Generic, TypedDict, TypeVar, cast
from typing_extensions import ParamSpec
from polyfactory.exceptions import ParameterException
from polyfactory.utils import deprecation
from polyfactory.utils.predicates import is_safe_subclass
T = TypeVar("T")
P = ParamSpec("P")
class WrappedCallable(TypedDict):
"""A ref storing a callable. This class is a utility meant to prevent binding of methods."""
value: Callable
class Require:
"""A factory field that marks an attribute as a required build-time kwarg."""
class Ignore:
"""A factory field that marks an attribute as ignored."""
class Use(Generic[P, T]):
"""Factory field used to wrap a callable.
The callable will be invoked whenever building the given factory attribute.
"""
__slots__ = ("args", "fn", "kwargs")
def __init__(self, fn: Callable[P, T], *args: P.args, **kwargs: P.kwargs) -> None:
"""Wrap a callable.
:param fn: A callable to wrap.
:param args: Any args to pass to the callable.
:param kwargs: Any kwargs to pass to the callable.
"""
self.fn: WrappedCallable = {"value": fn}
self.kwargs = kwargs
self.args = args
def to_value(self) -> T:
"""Invoke the callable.
:returns: The output of the callable.
"""
return cast("T", self.fn["value"](*self.args, **self.kwargs))
class PostGenerated:
"""Factory field that allows generating values after other fields are generated by the factory."""
__slots__ = ("args", "fn", "kwargs")
def __init__(self, fn: Callable, *args: Any, **kwargs: Any) -> None:
"""Designate field as post-generated.
:param fn: A callable.
:param args: Args for the callable.
:param kwargs: Kwargs for the callable.
"""
self.fn: WrappedCallable = {"value": fn}
self.kwargs = kwargs
self.args = args
def to_value(self, name: str, values: dict[str, Any]) -> Any:
"""Invoke the post-generation callback passing to it the build results.
:param name: Field name.
:param values: Generated values.
:returns: An arbitrary value.
"""
return self.fn["value"](name, values, *self.args, **self.kwargs)
class Fixture:
"""Factory field to create a pytest fixture from a factory."""
__slots__ = ("kwargs", "ref", "size")
@deprecation.deprecated(version="2.20.0", alternative="Use factory directly")
def __init__(self, fixture: Callable, size: int | None = None, **kwargs: Any) -> None:
"""Create a fixture from a factory.
:param fixture: A factory that was registered as a fixture.
:param size: Optional batch size.
:param kwargs: Any build kwargs.
"""
self.ref: WrappedCallable = {"value": fixture}
self.size = size
self.kwargs = kwargs
def to_value(self) -> Any:
"""Call the factory's build or batch method.
:raises: ParameterException
:returns: The build result.
"""
from polyfactory.factories.base import BaseFactory
factory = self.ref["value"]
if not is_safe_subclass(factory, BaseFactory):
msg = "fixture has not been registered using the register_factory decorator"
raise ParameterException(msg)
if self.size is not None:
return factory.batch(self.size, **self.kwargs)
return factory.build(**self.kwargs)
python-polyfactory-2.21.0/polyfactory/persistence.py 0000664 0000000 0000000 00000002250 15000423051 0022724 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from typing import Protocol, TypeVar, runtime_checkable
T = TypeVar("T")
@runtime_checkable
class SyncPersistenceProtocol(Protocol[T]):
"""Protocol for sync persistence"""
def save(self, data: T) -> T:
"""Persist a single instance synchronously.
:param data: A single instance to persist.
:returns: The persisted result.
"""
...
def save_many(self, data: list[T]) -> list[T]:
"""Persist multiple instances synchronously.
:param data: A list of instances to persist.
:returns: The persisted result
"""
...
@runtime_checkable
class AsyncPersistenceProtocol(Protocol[T]):
"""Protocol for async persistence"""
async def save(self, data: T) -> T:
"""Persist a single instance asynchronously.
:param data: A single instance to persist.
:returns: The persisted result.
"""
...
async def save_many(self, data: list[T]) -> list[T]:
"""Persist multiple instances asynchronously.
:param data: A list of instances to persist.
:returns: The persisted result
"""
...
python-polyfactory-2.21.0/polyfactory/py.typed 0000664 0000000 0000000 00000000000 15000423051 0021514 0 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/polyfactory/pytest_plugin.py 0000664 0000000 0000000 00000006376 15000423051 0023323 0 ustar 00root root 0000000 0000000 from __future__ import annotations
import inspect
import re
from typing import (
Any,
Callable,
Literal,
Type,
TypeVar,
Union,
cast,
overload,
)
import pytest
from polyfactory.exceptions import ParameterException
from polyfactory.factories.base import BaseFactory
from polyfactory.utils.predicates import is_safe_subclass
Scope = Union[
Literal["session", "package", "module", "class", "function"],
Callable[[str, pytest.Config], Literal["session", "package", "module", "class", "function"]],
]
T = TypeVar("T", bound=BaseFactory[Any])
split_pattern_1 = re.compile(r"([A-Z]+)([A-Z][a-z])")
split_pattern_2 = re.compile(r"([a-z\d])([A-Z])")
def _get_fixture_name(name: str) -> str:
"""From inflection.underscore.
:param name: str: A name.
:returns: Normalized fixture name.
"""
name = re.sub(split_pattern_1, r"\1_\2", name)
name = re.sub(split_pattern_2, r"\1_\2", name)
name = name.replace("-", "_")
return name.lower()
class FactoryFixture:
"""Decorator that creates a pytest fixture from a factory"""
__slots__ = ("autouse", "name", "scope")
def __init__(
self,
scope: Scope = "function",
autouse: bool = False,
name: str | None = None,
) -> None:
"""Create a factory fixture decorator
:param scope: Fixture scope
:param autouse: Autouse the fixture
:param name: Fixture name
"""
self.scope = scope
self.autouse = autouse
self.name = name
def __call__(self, factory: type[T], depth: int = 1) -> type[T]:
if not is_safe_subclass(factory, BaseFactory):
msg = f"{factory.__name__} is not a BaseFactory subclass."
raise ParameterException(msg)
fixture_name = self.name or _get_fixture_name(factory.__name__)
fixture_register = pytest.fixture(
scope=self.scope, # pyright: ignore[reportArgumentType]
name=fixture_name,
autouse=self.autouse,
)
def _factory_fixture() -> type[T]:
"""The wrapped factory"""
return cast("Type[T]", factory)
caller_globals = inspect.stack()[depth][0].f_globals
caller_globals[fixture_name] = fixture_register(_factory_fixture)
return factory # type: ignore[return-value]
@overload
def register_fixture(
factory: None = None,
*,
scope: Scope = "function",
autouse: bool = False,
name: str | None = None,
) -> FactoryFixture: ...
@overload
def register_fixture(
factory: type[T],
*,
scope: Scope = "function",
autouse: bool = False,
name: str | None = None,
) -> type[T]: ...
def register_fixture(
factory: type[T] | None = None,
*,
scope: Scope = "function",
autouse: bool = False,
name: str | None = None,
) -> type[T] | FactoryFixture:
"""A decorator that allows registering model factories as fixtures.
:param factory: An optional factory class to decorate.
:param scope: Pytest scope.
:param autouse: Auto use fixture.
:param name: Fixture name.
:returns: A fixture factory instance.
"""
factory_fixture = FactoryFixture(scope=scope, autouse=autouse, name=name)
return factory_fixture(factory, depth=2) if factory else factory_fixture
python-polyfactory-2.21.0/polyfactory/utils/ 0000775 0000000 0000000 00000000000 15000423051 0021167 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/polyfactory/utils/__init__.py 0000664 0000000 0000000 00000000000 15000423051 0023266 0 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/polyfactory/utils/deprecation.py 0000664 0000000 0000000 00000011575 15000423051 0024047 0 ustar 00root root 0000000 0000000 from __future__ import annotations
import inspect
from functools import wraps
from typing import Any, Callable, Literal, TypeVar
from warnings import warn
from typing_extensions import ParamSpec
__all__ = ("check_for_deprecated_parameters", "deprecated", "warn_deprecation")
T = TypeVar("T")
P = ParamSpec("P")
DeprecatedKind = Literal["function", "method", "classmethod", "attribute", "property", "class", "parameter", "import"]
def warn_deprecation(
version: str,
deprecated_name: str,
kind: DeprecatedKind,
*,
removal_in: str | None = None,
alternative: str | None = None,
info: str | None = None,
pending: bool = False,
) -> None:
"""Warn about a call to a (soon to be) deprecated function.
Args:
version: Polyfactory version where the deprecation will occur.
deprecated_name: Name of the deprecated function.
removal_in: Polyfactory version where the deprecated function will be removed.
alternative: Name of a function that should be used instead.
info: Additional information.
pending: Use ``PendingDeprecationWarning`` instead of ``DeprecationWarning``.
kind: Type of the deprecated thing.
"""
parts = []
if kind == "import":
access_type = "Import of"
elif kind in {"function", "method"}:
access_type = "Call to"
else:
access_type = "Use of"
if pending:
parts.append(f"{access_type} {kind} awaiting deprecation {deprecated_name!r}")
else:
parts.append(f"{access_type} deprecated {kind} {deprecated_name!r}")
parts.extend(
(
f"Deprecated in polyfactory {version}",
f"This {kind} will be removed in {removal_in or 'the next major version'}",
)
)
if alternative:
parts.append(f"Use {alternative!r} instead")
if info:
parts.append(info)
text = ". ".join(parts)
warning_class = PendingDeprecationWarning if pending else DeprecationWarning
warn(text, warning_class, stacklevel=2)
def deprecated(
version: str,
*,
removal_in: str | None = None,
alternative: str | None = None,
info: str | None = None,
pending: bool = False,
kind: Literal["function", "method", "classmethod", "property"] | None = None,
) -> Callable[[Callable[P, T]], Callable[P, T]]:
"""Create a decorator wrapping a function, method or property with a warning call about a (pending) deprecation.
Args:
version: Polyfactory version where the deprecation will occur.
removal_in: Polyfactory version where the deprecated function will be removed.
alternative: Name of a function that should be used instead.
info: Additional information.
pending: Use ``PendingDeprecationWarning`` instead of ``DeprecationWarning``.
kind: Type of the deprecated callable. If ``None``, will use ``inspect`` to figure
out if it's a function or method.
Returns:
A decorator wrapping the function call with a warning
"""
def decorator(func: Callable[P, T]) -> Callable[P, T]:
@wraps(func)
def wrapped(*args: P.args, **kwargs: P.kwargs) -> T:
warn_deprecation(
version=version,
deprecated_name=func.__name__,
info=info,
alternative=alternative,
pending=pending,
removal_in=removal_in,
kind=kind or ("method" if inspect.ismethod(func) else "function"),
)
return func(*args, **kwargs)
return wrapped
return decorator
def check_for_deprecated_parameters(
version: str,
*,
parameters: tuple[tuple[str, Any], ...],
default_value: Any = None,
removal_in: str | None = None,
alternative: str | None = None,
info: str | None = None,
pending: bool = False,
) -> None:
"""Warn about a call to a (soon to be) deprecated argument to a function.
Args:
version: Polyfactory version where the deprecation will occur.
parameters: Parameters to trigger warning if used.
default_value: Default value for parameter to detect if supplied or not.
removal_in: Polyfactory version where the deprecated function will be removed.
alternative: Name of a function that should be used instead.
info: Additional information.
pending: Use ``PendingDeprecationWarning`` instead of ``DeprecationWarning``.
kind: Type of the deprecated callable. If ``None``, will use ``inspect`` to figure
out if it's a function or method.
"""
for parameter_name, value in parameters:
if value == default_value:
continue
warn_deprecation(
version=version,
deprecated_name=parameter_name,
info=info,
alternative=alternative,
pending=pending,
removal_in=removal_in,
kind="parameter",
)
python-polyfactory-2.21.0/polyfactory/utils/helpers.py 0000664 0000000 0000000 00000013623 15000423051 0023210 0 ustar 00root root 0000000 0000000 from __future__ import annotations
import sys
from collections import deque
from dataclasses import is_dataclass
from typing import TYPE_CHECKING, Any, Mapping, Sequence
from typing_extensions import get_args, get_origin
from polyfactory.constants import TYPE_MAPPING
from polyfactory.utils.predicates import (
is_annotated,
is_new_type,
is_optional,
is_safe_subclass,
is_type_alias,
is_union,
)
from polyfactory.utils.types import NoneType
if TYPE_CHECKING:
from random import Random
def unwrap_new_type(annotation: Any) -> Any:
"""Return base type if given annotation is a type derived with NewType, otherwise annotation.
:param annotation: A type annotation, possibly one created using 'types.NewType'
:returns: The unwrapped annotation.
"""
while is_new_type(annotation):
annotation = annotation.__supertype__
return annotation
def unwrap_union(annotation: Any, random: Random) -> Any:
"""Unwraps union types - recursively.
:param annotation: A type annotation, possibly a type union.
:param random: An instance of random.Random.
:returns: A type annotation
"""
while is_union(annotation):
args = list(get_args(annotation))
annotation = random.choice(args)
return annotation
def unwrap_optional(annotation: Any) -> Any:
"""Unwraps optional union types - recursively.
:param annotation: A type annotation, possibly an optional union.
:returns: A type annotation
"""
while is_optional(annotation):
annotation = next(arg for arg in get_args(annotation) if arg not in (NoneType, None))
return annotation
def unwrap_annotation(annotation: Any, random: Random) -> Any:
"""Unwraps an annotation.
:param annotation: A type annotation.
:param random: An instance of random.Random.
:returns: The unwrapped annotation.
"""
while (
is_optional(annotation)
or is_union(annotation)
or is_new_type(annotation)
or is_annotated(annotation)
or is_type_alias(annotation)
):
if is_new_type(annotation):
annotation = unwrap_new_type(annotation)
elif is_optional(annotation):
annotation = unwrap_optional(annotation)
elif is_annotated(annotation):
annotation = unwrap_annotated(annotation, random=random)[0]
elif is_type_alias(annotation):
annotation = annotation.__value__
else:
annotation = unwrap_union(annotation, random=random)
return annotation
def flatten_annotation(annotation: Any) -> list[Any]:
"""Flattens an annotation.
:param annotation: A type annotation.
:returns: The flattened annotations.
"""
flat = []
if is_new_type(annotation):
flat.extend(flatten_annotation(unwrap_new_type(annotation)))
elif is_optional(annotation):
for a in get_args(annotation):
flat.extend(flatten_annotation(a))
elif is_annotated(annotation):
flat.extend(flatten_annotation(get_args(annotation)[0]))
elif is_union(annotation):
for a in get_args(annotation):
flat.extend(flatten_annotation(a))
else:
flat.append(annotation)
return flat
def unwrap_args(annotation: Any, random: Random) -> tuple[Any, ...]:
"""Unwrap the annotation and return any type args.
:param annotation: A type annotation
:param random: An instance of random.Random.
:returns: A tuple of type args.
"""
return get_args(unwrap_annotation(annotation=annotation, random=random))
def unwrap_annotated(annotation: Any, random: Random) -> tuple[Any, list[Any]]:
"""Unwrap an annotated type and return a tuple of type args and optional metadata.
:param annotation: An annotated type annotation
:param random: An instance of random.Random.
:returns: A tuple of type args.
"""
args = [arg for arg in get_args(annotation) if arg is not None]
return unwrap_annotation(args[0], random=random), args[1:]
def normalize_annotation(annotation: Any, random: Random) -> Any:
"""Normalize an annotation.
:param annotation: A type annotation.
:returns: A normalized type annotation.
"""
if is_new_type(annotation):
annotation = unwrap_new_type(annotation)
if is_annotated(annotation):
annotation = unwrap_annotated(annotation, random=random)[0]
# we have to maintain compatibility with the older non-subscriptable typings.
if sys.version_info < (3, 9): # pragma: no cover
return annotation
origin = get_origin(annotation) or annotation
if origin in TYPE_MAPPING:
origin = TYPE_MAPPING[origin]
if args := get_args(annotation):
args = tuple(normalize_annotation(arg, random=random) for arg in args)
return origin[args] if origin is not type else annotation
return origin
def get_annotation_metadata(annotation: Any) -> Sequence[Any]:
"""Get the metadata in the annotation.
:param annotation: A type annotation.
:returns: The metadata.
"""
return get_args(annotation)[1:]
def get_collection_type(annotation: Any) -> type[list | tuple | set | frozenset | dict | deque]: # noqa: PLR0911
"""Get the collection type from the annotation.
:param annotation: A type annotation.
:returns: The collection type.
"""
if is_safe_subclass(annotation, list):
return list
if is_safe_subclass(annotation, Mapping):
return dict
if is_safe_subclass(annotation, tuple):
return tuple
if is_safe_subclass(annotation, set):
return set
if is_safe_subclass(annotation, frozenset):
return frozenset
if is_safe_subclass(annotation, deque):
return deque
if is_safe_subclass(annotation, Sequence):
return list
msg = f"Unknown collection type - {annotation}"
raise ValueError(msg)
def is_dataclass_instance(obj: Any) -> bool:
return is_dataclass(obj) and not isinstance(obj, type)
python-polyfactory-2.21.0/polyfactory/utils/model_coverage.py 0000664 0000000 0000000 00000011465 15000423051 0024523 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from abc import ABC, abstractmethod
from collections.abc import Callable, Iterable, Iterator, Mapping, MutableSequence
from typing import AbstractSet, Any, Generic, Set, TypeVar, cast
from typing_extensions import ParamSpec
from polyfactory.exceptions import ParameterException
class CoverageContainerBase(ABC):
"""Base class for coverage container implementations.
A coverage container is a wrapper providing values for a particular field. Coverage containers return field values and
track a "done" state to indicate that all coverage examples have been generated.
"""
@abstractmethod
def next_value(self) -> Any:
"""Provide the next value"""
...
@abstractmethod
def is_done(self) -> bool:
"""Indicate if this container has provided every coverage example it has"""
...
T = TypeVar("T")
class CoverageContainer(CoverageContainerBase, Generic[T]):
"""A coverage container that wraps a collection of values.
When calling ``next_value()`` a greater number of times than the length of the given collection will cause duplicate
examples to be returned (wraps around).
If there are any coverage containers within the given collection, the values from those containers are essentially merged
into the parent container.
"""
def __init__(self, instances: Iterable[T]) -> None:
self._pos = 0
self._instances = list(instances)
if not self._instances:
msg = "CoverageContainer must have at least one instance"
raise ValueError(msg)
def next_value(self) -> T:
value = self._instances[self._pos % len(self._instances)]
if isinstance(value, CoverageContainerBase):
result = value.next_value()
if value.is_done():
# Only move onto the next instance if the sub-container is done
self._pos += 1
return cast("T", result)
self._pos += 1
return value
def is_done(self) -> bool:
return self._pos >= len(self._instances)
def __repr__(self) -> str:
return f"CoverageContainer(instances={self._instances}, is_done={self.is_done()})"
P = ParamSpec("P")
class CoverageContainerCallable(CoverageContainerBase, Generic[T]):
"""A coverage container that wraps a callable.
When calling ``next_value()`` the wrapped callable is called to provide a value.
"""
def __init__(self, func: Callable[P, T], *args: P.args, **kwargs: P.kwargs) -> None:
self._func = func
self._args = args
self._kwargs = kwargs
def next_value(self) -> T:
try:
return self._func(*self._args, **self._kwargs)
except Exception as e:
msg = f"Unsupported type: {self._func!r}\n\nEither extend the providers map or add a factory function for this type."
raise ParameterException(msg) from e
def is_done(self) -> bool:
return True
def _resolve_next(unresolved: Any) -> tuple[Any, bool]: # noqa: C901
if isinstance(unresolved, CoverageContainerBase):
result, done = _resolve_next(unresolved.next_value())
return result, unresolved.is_done() and done
if isinstance(unresolved, Mapping):
result = {}
done_status = True
for key, value in unresolved.items():
val_resolved, val_done = _resolve_next(value)
key_resolved, key_done = _resolve_next(key)
result[key_resolved] = val_resolved
done_status = done_status and val_done and key_done
return result, done_status
if isinstance(unresolved, (tuple, MutableSequence)):
result = []
done_status = True
for value in unresolved:
resolved, done = _resolve_next(value)
result.append(resolved)
done_status = done_status and done
if isinstance(unresolved, tuple):
result = tuple(result)
return result, done_status
if isinstance(unresolved, Set):
result = type(unresolved)()
done_status = True
for value in unresolved:
resolved, done = _resolve_next(value)
result.add(resolved)
done_status = done_status and done
return result, done_status
if issubclass(type(unresolved), AbstractSet):
result = type(unresolved)()
done_status = True
resolved_values = []
for value in unresolved:
resolved, done = _resolve_next(value)
resolved_values.append(resolved)
done_status = done_status and done
return result.union(resolved_values), done_status
return unresolved, True
def resolve_kwargs_coverage(kwargs: dict[str, Any]) -> Iterator[dict[str, Any]]:
done = False
while not done:
resolved, done = _resolve_next(kwargs)
yield resolved
python-polyfactory-2.21.0/polyfactory/utils/predicates.py 0000664 0000000 0000000 00000010576 15000423051 0023675 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from inspect import isclass
from typing import Any, Literal, NewType, Optional, TypeVar, get_args
from typing_extensions import (
Annotated,
NotRequired,
ParamSpec,
Required,
TypeAliasType,
TypeGuard,
_AnnotatedAlias,
get_origin,
)
try:
from typing import TypeAliasType as typing_TypeAliasType
AllTypeAliasTypes: tuple[type, ...] = (TypeAliasType, typing_TypeAliasType)
except ImportError:
AllTypeAliasTypes = (TypeAliasType,)
from polyfactory.constants import TYPE_MAPPING
from polyfactory.utils.types import UNION_TYPES, NoneType
P = ParamSpec("P")
T = TypeVar("T")
def is_safe_subclass(annotation: Any, class_or_tuple: type[T] | tuple[type[T], ...]) -> "TypeGuard[type[T]]":
"""Determine whether a given annotation is a subclass of a give type
:param annotation: A type annotation.
:param class_or_tuple: A potential super class or classes.
:returns: A typeguard
"""
origin = get_type_origin(annotation)
if not origin and not isclass(annotation):
return False
try:
return issubclass(origin or annotation, class_or_tuple)
except TypeError: # pragma: no cover
return False
def is_any(annotation: Any) -> "TypeGuard[Any]":
"""Determine whether a given annotation is 'typing.Any'.
:param annotation: A type annotation.
:returns: A typeguard.
"""
return (
annotation is Any
or getattr(annotation, "_name", "") == "typing.Any"
or (get_origin(annotation) in UNION_TYPES and Any in get_args(annotation))
)
def is_dict_key_or_value_type(annotation: Any) -> "TypeGuard[Any]":
"""Determine whether a given annotation is a valid dict key or value type:
``typing.KT`` or ``typing.VT``.
:returns: A typeguard.
"""
return str(annotation) in {"~KT", "~VT"}
def is_union(annotation: Any) -> "TypeGuard[Any]":
"""Determine whether a given annotation is 'typing.Union'.
:param annotation: A type annotation.
:returns: A typeguard.
"""
return get_type_origin(annotation) in UNION_TYPES
def is_optional(annotation: Any) -> "TypeGuard[Any | None]":
"""Determine whether a given annotation is 'typing.Optional'.
:param annotation: A type annotation.
:returns: A typeguard.
"""
origin = get_type_origin(annotation)
return origin is Optional or (get_origin(annotation) in UNION_TYPES and NoneType in get_args(annotation))
def is_literal(annotation: Any) -> bool:
"""Determine whether a given annotation is 'typing.Literal'.
:param annotation: A type annotation.
:returns: A boolean.
"""
return (
get_type_origin(annotation) is Literal
or repr(annotation).startswith("typing.Literal")
or repr(annotation).startswith("typing_extensions.Literal")
)
def is_new_type(annotation: Any) -> "TypeGuard[type[NewType]]":
"""Determine whether a given annotation is 'typing.NewType'.
:param annotation: A type annotation.
:returns: A typeguard.
"""
return hasattr(annotation, "__supertype__")
def is_annotated(annotation: Any) -> bool:
"""Determine whether a given annotation is 'typing.Annotated'.
:param annotation: A type annotation.
:returns: A boolean.
"""
return get_origin(annotation) is Annotated or (
isinstance(annotation, _AnnotatedAlias) and getattr(annotation, "__args__", None) is not None
)
def is_any_annotated(annotation: Any) -> bool:
"""Determine whether any of the types in the given annotation is
`typing.Annotated`.
:param annotation: A type annotation.
:returns: A boolean
"""
return any(
is_annotated(arg) or (hasattr(arg, "__args__") and is_any_annotated(arg)) for arg in get_args(annotation)
)
def is_type_alias(annotation: Any) -> TypeGuard[TypeAliasType]:
"""Determine if the given type annotation is a PEP 695 type alias.
:param annotation: A type annotation.
:returns: A boolean
"""
return isinstance(annotation, AllTypeAliasTypes)
def get_type_origin(annotation: Any) -> Any:
"""Get the type origin of an annotation - safely.
:param annotation: A type annotation.
:returns: A type annotation.
"""
origin = get_origin(annotation)
if origin in (Annotated, Required, NotRequired):
origin = get_args(annotation)[0]
return mapped_type if (mapped_type := TYPE_MAPPING.get(origin)) else origin
python-polyfactory-2.21.0/polyfactory/utils/types.py 0000664 0000000 0000000 00000001531 15000423051 0022705 0 ustar 00root root 0000000 0000000 from typing import TYPE_CHECKING, Any, NoReturn, Union
try:
from types import NoneType, UnionType
UNION_TYPES = {UnionType, Union}
except ImportError:
UNION_TYPES = {Union}
NoneType = type(None) # type: ignore[misc]
class Frozendict(dict):
def _immutable_error(self, *_: Any, **__: Any) -> NoReturn:
msg = f"Unable to mutate {type(self).__name__}"
raise TypeError(msg)
# Override all mutation methods to prevent changes
if not TYPE_CHECKING:
__setitem__ = _immutable_error
__delitem__ = _immutable_error
clear = _immutable_error
pop = _immutable_error
popitem = _immutable_error
update = _immutable_error
def __hash__(self) -> int: # type: ignore[override]
return hash(tuple(self.items()))
__all__ = ("UNION_TYPES", "Frozendict", "NoneType")
python-polyfactory-2.21.0/polyfactory/value_generators/ 0000775 0000000 0000000 00000000000 15000423051 0023374 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/polyfactory/value_generators/__init__.py 0000664 0000000 0000000 00000000000 15000423051 0025473 0 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/polyfactory/value_generators/complex_types.py 0000664 0000000 0000000 00000013654 15000423051 0026652 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from typing import TYPE_CHECKING, AbstractSet, Any, Iterable, MutableMapping, MutableSequence, Set, Tuple, cast
from typing_extensions import is_typeddict
from polyfactory.constants import INSTANTIABLE_TYPE_MAPPING, PY_38
from polyfactory.utils.model_coverage import CoverageContainer
if TYPE_CHECKING:
from polyfactory.factories.base import BaseFactory, BuildContext
from polyfactory.field_meta import FieldMeta
def handle_collection_type(
field_meta: FieldMeta,
container_type: type,
factory: type[BaseFactory[Any]],
field_build_parameters: Any | None = None,
build_context: BuildContext | None = None,
) -> Any:
"""Handle generation of container types recursively.
:param container_type: A type that can accept type arguments.
:param factory: A factory.
:param field_meta: A field meta instance.
:param field_build_parameters: Any build parameters passed to the factory as kwarg values.
:param build_context: BuildContext data for current build.
:returns: A built result.
"""
if PY_38 and container_type in INSTANTIABLE_TYPE_MAPPING:
container_type = INSTANTIABLE_TYPE_MAPPING[container_type] # type: ignore[assignment]
container = container_type()
if field_meta.children is None or any(
child_meta.annotation in factory._get_build_context(build_context)["seen_models"]
for child_meta in field_meta.children
):
return container
if issubclass(container_type, MutableMapping) or is_typeddict(container_type):
for key_field_meta, value_field_meta in cast(
"Iterable[Tuple[FieldMeta, FieldMeta]]",
zip(field_meta.children[::2], field_meta.children[1::2]),
):
key = factory.get_field_value(
key_field_meta, field_build_parameters=field_build_parameters, build_context=build_context
)
value = factory.get_field_value(
value_field_meta, field_build_parameters=field_build_parameters, build_context=build_context
)
container[key] = value
return container
if issubclass(container_type, MutableSequence):
container.extend(
[
factory.get_field_value(
subfield_meta, field_build_parameters=field_build_parameters, build_context=build_context
)
for subfield_meta in field_meta.children
]
)
return container
if issubclass(container_type, Set):
for subfield_meta in field_meta.children:
container.add(
factory.get_field_value(
subfield_meta, field_build_parameters=field_build_parameters, build_context=build_context
)
)
return container
if issubclass(container_type, AbstractSet):
return container.union(
handle_collection_type(
field_meta, set, factory, field_build_parameters=field_build_parameters, build_context=build_context
)
)
if issubclass(container_type, tuple):
return container_type(
factory.get_field_value(child, field_build_parameters=field_build_parameters, build_context=build_context)
for child in field_meta.children
if child.annotation != Ellipsis
)
msg = f"Unsupported container type: {container_type}"
raise NotImplementedError(msg)
def handle_collection_type_coverage( # noqa: C901, PLR0911
field_meta: FieldMeta,
container_type: type,
factory: type[BaseFactory[Any]],
build_context: BuildContext | None = None,
) -> Any:
"""Handle coverage generation of container types recursively.
:param container_type: A type that can accept type arguments.
:param factory: A factory.
:param field_meta: A field meta instance.
:returns: An unresolved built result.
"""
container = container_type()
if not field_meta.children:
return container
if issubclass(container_type, MutableMapping) or is_typeddict(container_type):
for key_field_meta, value_field_meta in cast(
"Iterable[Tuple[FieldMeta, FieldMeta]]",
zip(field_meta.children[::2], field_meta.children[1::2]),
):
key = CoverageContainer(factory.get_field_value_coverage(key_field_meta, build_context=build_context))
value = CoverageContainer(factory.get_field_value_coverage(value_field_meta, build_context=build_context))
container[key] = value
return container
if issubclass(container_type, MutableSequence):
container_instance = container_type()
for subfield_meta in field_meta.children:
container_instance.extend(factory.get_field_value_coverage(subfield_meta, build_context=build_context))
return container_instance
if issubclass(container_type, Set):
set_instance = container_type()
for subfield_meta in field_meta.children:
set_instance = set_instance.union(
factory.get_field_value_coverage(subfield_meta, build_context=build_context)
)
return set_instance
if issubclass(container_type, AbstractSet):
return container.union(handle_collection_type_coverage(field_meta, set, factory, build_context=build_context))
if issubclass(container_type, tuple):
if field_meta.children[-1].annotation == Ellipsis:
return (
CoverageContainer(
factory.get_field_value_coverage(
field_meta.children[0],
build_context=build_context,
)
),
)
return container_type(
CoverageContainer(factory.get_field_value_coverage(subfield_meta, build_context=build_context))
for subfield_meta in field_meta.children
)
msg = f"Unsupported container type: {container_type}"
raise NotImplementedError(msg)
python-polyfactory-2.21.0/polyfactory/value_generators/constrained_collections.py 0000664 0000000 0000000 00000011723 15000423051 0030661 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from enum import EnumMeta
from typing import TYPE_CHECKING, Any, Callable, Literal, Mapping, TypeVar
from polyfactory.exceptions import ParameterException
if TYPE_CHECKING:
from polyfactory.factories.base import BaseFactory, BuildContext
from polyfactory.field_meta import FieldMeta
T = TypeVar("T", list, set, frozenset)
def handle_constrained_collection( # noqa: C901
collection_type: Callable[..., T],
factory: type[BaseFactory[Any]],
field_meta: FieldMeta,
item_type: Any,
max_items: int | None = None,
min_items: int | None = None,
unique_items: bool = False,
field_build_parameters: Any | None = None,
build_context: BuildContext | None = None,
) -> T:
"""Generate a constrained list or set.
:param collection_type: A type that can accept type arguments.
:param factory: A factory.
:param field_meta: A field meta instance.
:param item_type: Type of the collection items.
:param max_items: Maximal number of items.
:param min_items: Minimal number of items.
:param unique_items: Whether the items should be unique.
:param field_build_parameters: Any build parameters passed to the factory as kwarg values.
:param build_context: BuildContext data for current build.
:returns: A collection value.
"""
build_context = factory._get_build_context(build_context)
if field_meta.annotation in build_context["seen_models"]:
return collection_type()
min_items = abs(min_items if min_items is not None else (max_items or 0))
max_items = abs(max_items if max_items is not None else min_items + 1)
if max_items < min_items:
msg = "max_items must be larger or equal to min_items"
raise ParameterException(msg)
if collection_type in (frozenset, set) or unique_items:
max_field_values = max_items
if hasattr(field_meta.annotation, "__origin__") and field_meta.annotation.__origin__ is Literal:
if field_meta.children is not None:
max_field_values = len(field_meta.children)
elif isinstance(field_meta.annotation, EnumMeta):
max_field_values = len(field_meta.annotation)
min_items = min(min_items, max_field_values)
max_items = min(max_items, max_field_values)
collection: set[T] | list[T] = set() if (collection_type in (frozenset, set) or unique_items) else []
try:
length = factory.__random__.randint(min_items, max_items)
while (i := len(collection)) < length:
if field_build_parameters and len(field_build_parameters) > i:
build_params = field_build_parameters[i]
else:
build_params = None
value = factory.get_field_value(
field_meta,
field_build_parameters=build_params,
build_context=build_context,
)
if isinstance(collection, set):
collection.add(value)
else:
collection.append(value)
return collection_type(collection)
except TypeError as e:
msg = f"cannot generate a constrained collection of type: {item_type}"
raise ParameterException(msg) from e
def handle_constrained_mapping(
factory: type[BaseFactory[Any]],
field_meta: FieldMeta,
max_items: int | None = None,
min_items: int | None = None,
field_build_parameters: Any | None = None,
build_context: BuildContext | None = None,
) -> Mapping[Any, Any]:
"""Generate a constrained mapping.
:param factory: A factory.
:param field_meta: A field meta instance.
:param max_items: Maximal number of items.
:param min_items: Minimal number of items.
:param field_build_parameters: Any build parameters passed to the factory as kwarg values.
:param build_context: BuildContext data for current build.
:returns: A mapping instance.
"""
build_context = factory._get_build_context(build_context)
if field_meta.children is None or any(
child_meta.annotation in build_context["seen_models"] for child_meta in field_meta.children
):
return {}
min_items = abs(min_items if min_items is not None else (max_items or 0))
max_items = abs(max_items if max_items is not None else min_items + 1)
if max_items < min_items:
msg = "max_items must be larger or equal to min_items"
raise ParameterException(msg)
length = factory.__random__.randint(min_items, max_items) or 1
collection: dict[Any, Any] = {}
children = field_meta.children
key_field_meta = children[0]
value_field_meta = children[1]
while len(collection) < length:
key = factory.get_field_value(
key_field_meta, field_build_parameters=field_build_parameters, build_context=build_context
)
value = factory.get_field_value(
value_field_meta, field_build_parameters=field_build_parameters, build_context=build_context
)
collection[key] = value
return collection
python-polyfactory-2.21.0/polyfactory/value_generators/constrained_dates.py 0000664 0000000 0000000 00000002121 15000423051 0027433 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from datetime import date, datetime, timedelta, timezone, tzinfo
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from faker import Faker
def handle_constrained_date(
faker: Faker,
ge: date | None = None,
gt: date | None = None,
le: date | None = None,
lt: date | None = None,
tz: tzinfo = timezone.utc,
) -> date:
"""Generates a date value fulfilling the expected constraints.
:param faker: An instance of faker.
:param lt: Less than value.
:param le: Less than or equal value.
:param gt: Greater than value.
:param ge: Greater than or equal value.
:param tz: A timezone.
:returns: A date instance.
"""
start_date = datetime.now(tz=tz).date() - timedelta(days=100)
if ge:
start_date = ge
elif gt:
start_date = gt + timedelta(days=1)
end_date = datetime.now(tz=timezone.utc).date() + timedelta(days=100)
if le:
end_date = le
elif lt:
end_date = lt - timedelta(days=1)
return faker.date_between(start_date=start_date, end_date=end_date)
python-polyfactory-2.21.0/polyfactory/value_generators/constrained_numbers.py 0000664 0000000 0000000 00000034326 15000423051 0030022 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from decimal import ROUND_DOWN, Decimal, localcontext
from sys import float_info
from typing import TYPE_CHECKING, Any, Protocol, TypeVar, cast
from polyfactory.exceptions import ParameterException
from polyfactory.utils.deprecation import check_for_deprecated_parameters
from polyfactory.value_generators.primitives import create_random_decimal, create_random_float, create_random_integer
if TYPE_CHECKING:
from random import Random
T = TypeVar("T", Decimal, int, float)
class NumberGeneratorProtocol(Protocol[T]):
"""Protocol for custom callables used to generate numerical values"""
def __call__(self, random: "Random", minimum: T | None = None, maximum: T | None = None) -> T:
"""Signature of the callable.
:param random: An instance of random.
:param minimum: A minimum value.
:param maximum: A maximum value.
:return: The generated numeric value.
"""
...
def almost_equal_floats(value_1: float, value_2: float, *, delta: float = 1e-8) -> bool:
"""Return True if two floats are almost equal
:param value_1: A float value.
:param value_2: A float value.
:param delta: A minimal delta.
:returns: Boolean dictating whether the floats can be considered equal - given python's problematic comparison of floats.
"""
return abs(value_1 - value_2) <= delta
def is_multiply_of_multiple_of_in_range(
minimum: T,
maximum: T,
multiple_of: T,
) -> bool:
"""Determine if at least one multiply of `multiple_of` lies in the given range.
:param minimum: T: A minimum value.
:param maximum: T: A maximum value.
:param multiple_of: T: A value to use as a base for multiplication.
:returns: Boolean dictating whether at least one multiply of `multiple_of` lies in the given range between minimum and maximum.
"""
# if the range has infinity on one of its ends then infinite number of multipliers
# can be found within the range
# if we were given floats and multiple_of is really close to zero then it doesn't make sense
# to continue trying to check the range
if (
isinstance(minimum, float)
and isinstance(multiple_of, float)
and minimum / multiple_of in [float("+inf"), float("-inf")]
):
return False
multiplier = round(minimum / multiple_of)
step = 1 if multiple_of > 0 else -1
# since rounding can go either up or down we may end up in a situation when
# minimum is less or equal to `multiplier * multiple_of`
# or when it is greater than `multiplier * multiple_of`
# (in this case minimum is less than `(multiplier + 1)* multiple_of`). So we need to check
# that any of two values is inside the given range. ASCII graphic below explain this
#
# minimum
# -----------------+-------+-----------------------------------+----------------------------
#
#
# minimum
# -------------------------+--------+--------------------------+----------------------------
#
# since `multiple_of` can be a negative number adding +1 to `multiplier` drives `(multiplier + 1) * multiple_of``
# away from `minimum` to the -infinity. It looks like this:
# minimum
# -----------------------+--------------------------------+------------------------+--------
#
# so for negative `multiple_of` we want to subtract 1 from multiplier
for multiply in [multiplier * multiple_of, (multiplier + step) * multiple_of]:
multiply_float = float(multiply)
if (
almost_equal_floats(multiply_float, float(minimum))
or almost_equal_floats(multiply_float, float(maximum))
or minimum < multiply < maximum
):
return True
return False
def passes_pydantic_multiple_validator(value: T, multiple_of: T) -> bool:
"""Determine whether a given value passes the pydantic multiple_of validation.
:param value: A numeric value.
:param multiple_of: Another numeric value.
:returns: Boolean dictating whether value is a multiple of value.
"""
if multiple_of == 0:
return True
mod = float(value) / float(multiple_of) % 1
return almost_equal_floats(mod, 0.0) or almost_equal_floats(mod, 1.0)
def get_increment(t_type: type[T]) -> T:
"""Get a small increment base to add to constrained values, i.e. lt/gt entries.
:param t_type: A value of type T.
:returns: An increment T.
"""
values: dict[Any, Any] = {
int: 1,
float: float_info.epsilon,
Decimal: Decimal("0.001"),
}
return cast("T", values[t_type])
def get_value_or_none(
t_type: type[T],
lt: T | None = None,
le: T | None = None,
gt: T | None = None,
ge: T | None = None,
max_digits: int | None = None,
decimal_places: int | None = None,
) -> tuple[T | None, T | None]:
"""Return an optional value.
:param equal_value: An GE/LE value.
:param constrained: An GT/LT value.
:param increment: increment
:returns: Optional T.
"""
if ge is not None:
minimum_value = ge
elif gt is not None:
minimum_value = gt + get_increment(t_type)
else:
minimum_value = None
if le is not None:
maximum_value = le
elif lt is not None:
maximum_value = lt - get_increment(t_type)
else:
maximum_value = None
if max_digits is not None:
max_whole_digits = 10
whole_digits = max_digits - decimal_places if decimal_places is not None else max_digits
maximum = (
Decimal(10**whole_digits - 1) if whole_digits < max_whole_digits else Decimal(10**max_whole_digits - 1)
)
minimum = maximum * (-1)
if minimum_value is None or minimum_value < minimum:
minimum_value = t_type(minimum)
elif minimum_value > maximum:
msg = f"minimum value must be less than {maximum}"
raise ParameterException(msg)
if maximum_value is None or maximum_value > maximum:
maximum_value = t_type(maximum if maximum > 0 else Decimal(1))
elif maximum_value < minimum:
msg = f"maximum value must be greater than {minimum}"
raise ParameterException(msg)
return minimum_value, maximum_value
def get_constrained_number_range(
t_type: type[T],
random: Random,
lt: T | None = None,
le: T | None = None,
gt: T | None = None,
ge: T | None = None,
multiple_of: T | None = None,
max_digits: int | None = None,
decimal_places: int | None = None,
) -> tuple[T | None, T | None]:
"""Return the minimum and maximum values given a field_meta's constraints.
:param t_type: A primitive constructor - int, float or Decimal.
:param random: An instance of Random.
:param lt: Less than value.
:param le: Less than or equal value.
:param gt: Greater than value.
:param ge: Greater than or equal value.
:param multiple_of: Multiple of value.
:param decimal_places: Number of decimal places.
:param max_digits: Maximal number of digits.
:returns: a tuple of optional minimum and maximum values.
"""
seed = t_type(random.random() * 10)
minimum, maximum = get_value_or_none(
lt=lt, le=le, gt=gt, ge=ge, t_type=t_type, max_digits=max_digits, decimal_places=decimal_places
)
if minimum is not None and maximum is not None and maximum < minimum:
msg = "maximum value must be greater than minimum value"
raise ParameterException(msg)
if multiple_of is None:
if minimum is not None and maximum is None:
return (minimum, seed) if minimum == 0 else (minimum, minimum + seed) # pyright: ignore[reportGeneralTypeIssues]
if maximum is not None and minimum is None:
return maximum - seed, maximum
else:
if multiple_of == 0.0: # TODO: investigate @guacs # noqa: FIX002
msg = "multiple_of can not be zero"
raise ParameterException(msg)
if (
minimum is not None
and maximum is not None
and not is_multiply_of_multiple_of_in_range(minimum=minimum, maximum=maximum, multiple_of=multiple_of)
):
msg = "given range should include at least one multiply of multiple_of"
raise ParameterException(msg)
return minimum, maximum
def generate_constrained_number(
random: Random,
minimum: T | None,
maximum: T | None,
multiple_of: T | None,
method: "NumberGeneratorProtocol[T]",
) -> T:
"""Generate a constrained number, output depends on the passed in callbacks.
:param random: An instance of random.
:param minimum: A minimum value.
:param maximum: A maximum value.
:param multiple_of: A multiple of value.
:param method: A function that generates numbers of type T.
:returns: A value of type T.
"""
if minimum is None or maximum is None:
return multiple_of if multiple_of is not None else method(random=random)
if multiple_of is None:
return method(random=random, minimum=minimum, maximum=maximum)
if multiple_of >= minimum:
return multiple_of
result = minimum
while not passes_pydantic_multiple_validator(result, multiple_of):
result = round(method(random=random, minimum=minimum, maximum=maximum) / multiple_of) * multiple_of
return result
def handle_constrained_int(
random: Random,
multiple_of: int | None = None,
gt: int | None = None,
ge: int | None = None,
lt: int | None = None,
le: int | None = None,
) -> int:
"""Handle constrained integers.
:param random: An instance of Random.
:param lt: Less than value.
:param le: Less than or equal value.
:param gt: Greater than value.
:param ge: Greater than or equal value.
:param multiple_of: Multiple of value.
:returns: An integer.
"""
minimum, maximum = get_constrained_number_range(
gt=gt,
ge=ge,
lt=lt,
le=le,
t_type=int,
multiple_of=multiple_of,
random=random,
)
return generate_constrained_number(
random=random,
minimum=minimum,
maximum=maximum,
multiple_of=multiple_of,
method=create_random_integer,
)
def handle_constrained_float(
random: Random,
multiple_of: float | None = None,
gt: float | None = None,
ge: float | None = None,
lt: float | None = None,
le: float | None = None,
) -> float:
"""Handle constrained floats.
:param random: An instance of Random.
:param lt: Less than value.
:param le: Less than or equal value.
:param gt: Greater than value.
:param ge: Greater than or equal value.
:param multiple_of: Multiple of value.
:returns: A float.
"""
minimum, maximum = get_constrained_number_range(
gt=gt,
ge=ge,
lt=lt,
le=le,
t_type=float,
multiple_of=multiple_of,
random=random,
)
return generate_constrained_number(
random=random,
minimum=minimum,
maximum=maximum,
multiple_of=multiple_of,
method=create_random_float,
)
def validate_max_digits(
max_digits: int,
minimum: Decimal | None,
decimal_places: int | None,
) -> None:
"""Validate that max digits is greater than minimum and decimal places.
:param max_digits: The maximal number of digits for the decimal.
:param minimum: Minimal value.
:param decimal_places: Number of decimal places
:returns: 'None'
"""
check_for_deprecated_parameters("2.19.1", parameters=(("minimum", minimum),))
if max_digits <= 0:
msg = "max_digits must be greater than 0"
raise ParameterException(msg)
if decimal_places is not None and max_digits < decimal_places:
msg = "max_digits must be greater or equal than decimal places"
raise ParameterException(msg)
def handle_decimal_length(
generated_decimal: Decimal,
decimal_places: int | None,
max_digits: int | None,
) -> Decimal:
"""Handle the length of the decimal.
:param generated_decimal: A decimal value.
:param decimal_places: Number of decimal places.
:param max_digits: Maximal number of digits.
"""
with localcontext() as ctx:
ctx.rounding = ROUND_DOWN
list_decimal = str(generated_decimal).strip("-0").split(".")
decimal_parts = 2
if len(list_decimal) == decimal_parts:
whole, decimals = list_decimal
if decimal_places is not None and len(decimals) > decimal_places:
return round(generated_decimal, decimal_places)
if max_digits is not None and len(whole) + len(decimals) > max_digits:
max_decimals = max_digits - len(whole)
return round(generated_decimal, max_decimals)
return generated_decimal
def handle_constrained_decimal(
random: Random,
multiple_of: Decimal | None = None,
decimal_places: int | None = None,
max_digits: int | None = None,
gt: Decimal | None = None,
ge: Decimal | None = None,
lt: Decimal | None = None,
le: Decimal | None = None,
) -> Decimal:
"""Handle a constrained decimal.
:param random: An instance of Random.
:param multiple_of: Multiple of value.
:param decimal_places: Number of decimal places.
:param max_digits: Maximal number of digits.
:param lt: Less than value.
:param le: Less than or equal value.
:param gt: Greater than value.
:param ge: Greater than or equal value.
:returns: A decimal.
"""
minimum, maximum = get_constrained_number_range(
gt=gt,
ge=ge,
lt=lt,
le=le,
multiple_of=multiple_of,
max_digits=max_digits,
decimal_places=decimal_places,
t_type=Decimal,
random=random,
)
if max_digits is not None:
validate_max_digits(max_digits=max_digits, minimum=None, decimal_places=decimal_places)
generated_decimal = generate_constrained_number(
random=random,
minimum=minimum,
maximum=maximum,
multiple_of=multiple_of,
method=create_random_decimal,
)
return handle_decimal_length(
generated_decimal=generated_decimal,
max_digits=max_digits,
decimal_places=decimal_places,
)
python-polyfactory-2.21.0/polyfactory/value_generators/constrained_path.py 0000664 0000000 0000000 00000000661 15000423051 0027276 0 ustar 00root root 0000000 0000000 from os.path import realpath
from pathlib import Path
from typing import Literal, cast
from faker import Faker
def handle_constrained_path(constraint: Literal["file", "dir", "new"], faker: Faker) -> Path:
if constraint == "new":
return cast("Path", faker.file_path(depth=1, category=None, extension=None))
if constraint == "file":
return Path(realpath(__file__))
return Path(realpath(__file__)).parent
python-polyfactory-2.21.0/polyfactory/value_generators/constrained_strings.py 0000664 0000000 0000000 00000007474 15000423051 0030044 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from typing import TYPE_CHECKING, Callable, Pattern, TypeVar, Union, cast
from polyfactory.exceptions import ParameterException
from polyfactory.value_generators.primitives import create_random_bytes, create_random_string
from polyfactory.value_generators.regex import RegexFactory
T = TypeVar("T", bound=Union[bytes, str])
if TYPE_CHECKING:
from random import Random
def _validate_length(
min_length: int | None = None,
max_length: int | None = None,
) -> None:
"""Validate the length parameters make sense.
:param min_length: Minimum length.
:param max_length: Maximum length.
:raises: ParameterException.
:returns: None.
"""
if min_length is not None and min_length < 0:
msg = "min_length must be greater or equal to 0"
raise ParameterException(msg)
if max_length is not None and max_length < 0:
msg = "max_length must be greater or equal to 0"
raise ParameterException(msg)
if max_length is not None and min_length is not None and max_length < min_length:
msg = "max_length must be greater than min_length"
raise ParameterException(msg)
def _generate_pattern(
random: Random,
pattern: str | Pattern,
lower_case: bool = False,
upper_case: bool = False,
min_length: int | None = None,
max_length: int | None = None,
) -> str:
"""Generate a regex.
:param random: An instance of random.
:param pattern: A regex or string pattern.
:param lower_case: Whether to lowercase the result.
:param upper_case: Whether to uppercase the result.
:param min_length: A minimum length.
:param max_length: A maximum length.
:returns: A string matching the given pattern.
"""
regex_factory = RegexFactory(random=random)
result = regex_factory(pattern)
if min_length:
while len(result) < min_length:
result += regex_factory(pattern)
if max_length is not None and len(result) > max_length:
result = result[:max_length]
if lower_case:
result = result.lower()
if upper_case:
result = result.upper()
return result
def handle_constrained_string_or_bytes(
random: Random,
t_type: Callable[[], T],
lower_case: bool = False,
upper_case: bool = False,
min_length: int | None = None,
max_length: int | None = None,
pattern: str | Pattern | None = None,
) -> T:
"""Handle constrained string or bytes, for example - pydantic `constr` or `conbytes`.
:param random: An instance of random.
:param t_type: A type (str or bytes)
:param lower_case: Whether to lowercase the result.
:param upper_case: Whether to uppercase the result.
:param min_length: A minimum length.
:param max_length: A maximum length.
:param pattern: A regex or string pattern.
:returns: A value of type T.
"""
_validate_length(min_length=min_length, max_length=max_length)
if max_length == 0:
return t_type()
if pattern:
return cast(
"T",
_generate_pattern(
random=random,
pattern=pattern,
lower_case=lower_case,
upper_case=upper_case,
min_length=min_length,
max_length=max_length,
),
)
if t_type is str:
return cast(
"T",
create_random_string(
min_length=min_length,
max_length=max_length,
lower_case=lower_case,
upper_case=upper_case,
random=random,
),
)
return cast(
"T",
create_random_bytes(
min_length=min_length,
max_length=max_length,
lower_case=lower_case,
upper_case=upper_case,
random=random,
),
)
python-polyfactory-2.21.0/polyfactory/value_generators/constrained_url.py 0000664 0000000 0000000 00000000670 15000423051 0027144 0 ustar 00root root 0000000 0000000 from polyfactory.field_meta import UrlConstraints
def handle_constrained_url(constraints: UrlConstraints) -> str:
schema = (constraints.get("allowed_schemes") or ["http", "https"])[0]
default_host = constraints.get("default_host") or "localhost"
default_port = constraints.get("default_port") or 80
default_path = constraints.get("default_path") or ""
return f"{schema}://{default_host}:{default_port}{default_path}"
python-polyfactory-2.21.0/polyfactory/value_generators/constrained_uuid.py 0000664 0000000 0000000 00000001602 15000423051 0027304 0 ustar 00root root 0000000 0000000 from typing import Literal, cast
from uuid import NAMESPACE_DNS, UUID, uuid1, uuid3, uuid5
from faker import Faker
UUID_VERSION_1 = 1
UUID_VERSION_3 = 3
UUID_VERSION_4 = 4
UUID_VERSION_5 = 5
def handle_constrained_uuid(uuid_version: Literal[1, 3, 4, 5], faker: Faker) -> UUID:
"""Generate a UUID based on the version specified.
Args:
uuid_version: The version of the UUID to generate.
faker: The Faker instance to use.
Returns:
The generated UUID.
"""
if uuid_version == UUID_VERSION_1:
return uuid1()
if uuid_version == UUID_VERSION_3:
return uuid3(NAMESPACE_DNS, faker.pystr())
if uuid_version == UUID_VERSION_4:
return cast("UUID", faker.uuid4())
if uuid_version == UUID_VERSION_5:
return uuid5(NAMESPACE_DNS, faker.pystr())
msg = f"Unknown UUID version: {uuid_version}"
raise ValueError(msg)
python-polyfactory-2.21.0/polyfactory/value_generators/primitives.py 0000664 0000000 0000000 00000007250 15000423051 0026145 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from binascii import hexlify
from decimal import Decimal
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from random import Random
def create_random_float(
random: Random,
minimum: Decimal | float | None = None,
maximum: Decimal | float | None = None,
) -> float:
"""Generate a random float given the constraints.
:param random: An instance of random.
:param minimum: A minimum value
:param maximum: A maximum value.
:returns: A random float.
"""
if minimum is None:
if maximum is None:
minimum = float(random.randint(0, 100))
else:
minimum = float(maximum) / 2 if maximum >= 0 else float(maximum) * 2.0
if maximum is None:
maximum = (float(minimum) + 1.0) * 2.0 if minimum >= 0 else (float(minimum) + 1.0) / 2.0
return random.uniform(float(minimum), float(maximum))
def create_random_integer(random: Random, minimum: int | None = None, maximum: int | None = None) -> int:
"""Generate a random int given the constraints.
:param random: An instance of random.
:param minimum: A minimum value
:param maximum: A maximum value.
:returns: A random integer.
"""
return round(create_random_float(random=random, minimum=minimum, maximum=maximum))
def create_random_decimal(
random: Random,
minimum: Decimal | None = None,
maximum: Decimal | None = None,
) -> Decimal:
"""Generate a random Decimal given the constraints.
:param random: An instance of random.
:param minimum: A minimum value
:param maximum: A maximum value.
:returns: A random decimal.
"""
return Decimal(str(create_random_float(random=random, minimum=minimum, maximum=maximum)))
def create_random_bytes(
random: Random,
min_length: int | None = None,
max_length: int | None = None,
lower_case: bool = False,
upper_case: bool = False,
) -> bytes:
"""Generate a random bytes given the constraints.
:param random: An instance of random.
:param min_length: A minimum length.
:param max_length: A maximum length.
:param lower_case: Whether to lowercase the result.
:param upper_case: Whether to uppercase the result.
:returns: A random byte-string.
"""
if min_length is None:
min_length = 0
if max_length is None:
max_length = min_length + 1 * 2
length = random.randint(min_length, max_length)
result = b"" if length == 0 else hexlify(random.getrandbits(length * 8).to_bytes(length, "little"))
if lower_case:
result = result.lower()
elif upper_case:
result = result.upper()
if max_length and len(result) > max_length:
end = random.randint(min_length or 0, max_length)
return result[:end]
return result
def create_random_string(
random: Random,
min_length: int | None = None,
max_length: int | None = None,
lower_case: bool = False,
upper_case: bool = False,
) -> str:
"""Generate a random string given the constraints.
:param random: An instance of random.
:param min_length: A minimum length.
:param max_length: A maximum length.
:param lower_case: Whether to lowercase the result.
:param upper_case: Whether to uppercase the result.
:returns: A random string.
"""
return create_random_bytes(
random=random,
min_length=min_length,
max_length=max_length,
lower_case=lower_case,
upper_case=upper_case,
).decode("utf-8")
def create_random_boolean(random: Random) -> bool:
"""Generate a random boolean value.
:param random: An instance of random.
:returns: A random boolean.
"""
return bool(random.getrandbits(1))
python-polyfactory-2.21.0/polyfactory/value_generators/regex.py 0000664 0000000 0000000 00000014154 15000423051 0025065 0 ustar 00root root 0000000 0000000 """The code in this files is adapted from https://github.com/crdoconnor/xeger/blob/master/xeger/xeger.py.Which in turn
adapted it from https://bitbucket.org/leapfrogdevelopment/rstr/.
Copyright (C) 2015, Colm O'Connor
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of the Leapfrog Direct Response, LLC, including
its subsidiaries and affiliates nor the names of its
contributors, may be used to endorse or promote products derived
from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL LEAPFROG DIRECT
RESPONSE, LLC, INCLUDING ITS SUBSIDIARIES AND AFFILIATES, BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""
from __future__ import annotations
from itertools import chain
from string import ascii_letters, ascii_lowercase, ascii_uppercase, digits, printable, punctuation, whitespace
from typing import TYPE_CHECKING, Any, Pattern
try: # >=3.11
from re._parser import SubPattern, parse
except ImportError: # < 3.11
from sre_parse import (
SubPattern, # pylint: disable=deprecated-module
parse,
)
if TYPE_CHECKING:
from random import Random
_alphabets = {
"printable": printable,
"letters": ascii_letters,
"uppercase": ascii_uppercase,
"lowercase": ascii_lowercase,
"digits": digits,
"punctuation": punctuation,
"nondigits": ascii_letters + punctuation,
"nonletters": digits + punctuation,
"whitespace": whitespace,
"nonwhitespace": printable.strip(),
"normal": ascii_letters + digits + " ",
"word": ascii_letters + digits + "_",
"nonword": "".join(set(printable).difference(ascii_letters + digits + "_")),
"postalsafe": ascii_letters + digits + " .-#/",
"urlsafe": ascii_letters + digits + "-._~",
"domainsafe": ascii_letters + digits + "-",
}
_categories = {
"category_digit": _alphabets["digits"],
"category_not_digit": _alphabets["nondigits"],
"category_space": _alphabets["whitespace"],
"category_not_space": _alphabets["nonwhitespace"],
"category_word": _alphabets["word"],
"category_not_word": _alphabets["nonword"],
}
class RegexFactory:
"""Factory for regexes."""
def __init__(self, random: Random, limit: int = 10) -> None:
"""Create a RegexFactory"""
self._limit = limit
self._cache: dict[str, Any] = {}
self._random = random
self._cases = {
"literal": chr,
"not_literal": lambda x: self._random.choice(printable.replace(chr(x), "")),
"at": lambda x: "",
"in": self._handle_in,
"any": lambda x: self._random.choice(printable.replace("\n", "")),
"range": lambda x: [chr(i) for i in range(x[0], x[1] + 1)],
"category": lambda x: _categories[str(x).lower()],
"branch": lambda x: "".join(self._handle_state(i) for i in self._random.choice(x[1])),
"subpattern": self._handle_group,
"assert": lambda x: "".join(self._handle_state(i) for i in x[1]),
"assert_not": lambda x: "",
"groupref": lambda x: self._cache[x],
"min_repeat": lambda x: self._handle_repeat(*x),
"max_repeat": lambda x: self._handle_repeat(*x),
"negate": lambda x: [False],
}
def __call__(self, string_or_regex: str | Pattern) -> str:
"""Generate a string matching a regex.
:param string_or_regex: A string or pattern.
:return: The generated string.
"""
pattern = string_or_regex.pattern if isinstance(string_or_regex, Pattern) else string_or_regex
parsed = parse(pattern)
result = self._build_string(parsed) # pyright: ignore[reportArgumentType]
self._cache.clear()
return result
def _build_string(self, parsed: SubPattern) -> str:
return "".join([self._handle_state(state) for state in parsed]) # pyright:ignore[reportArgumentType,reportCallIssue]
def _handle_state(self, state: tuple[SubPattern, tuple[Any, ...]]) -> Any:
opcode, value = state
return self._cases[str(opcode).lower()](value) # type: ignore[no-untyped-call]
def _handle_group(self, value: tuple[Any, ...]) -> str:
result = "".join(self._handle_state(i) for i in value[3])
if value[0]:
self._cache[value[0]] = result
return result
def _handle_in(self, value: tuple[Any, ...]) -> Any:
candidates = list(chain(*(self._handle_state(i) for i in value)))
if candidates and candidates[0] is False:
candidates = list(set(printable).difference(candidates[1:]))
return self._random.choice(candidates)
return self._random.choice(candidates)
def _handle_repeat(self, start_range: int, end_range: Any, value: SubPattern) -> str:
end_range = min(end_range, self._limit)
result = [
"".join(self._handle_state(v) for v in value) # pyright: ignore[reportCallIssue,reportArgumentType]
for _ in range(self._random.randint(start_range, max(start_range, end_range)))
]
return "".join(result)
python-polyfactory-2.21.0/pyproject.toml 0000664 0000000 0000000 00000032213 15000423051 0020371 0 ustar 00root root 0000000 0000000 [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.21.0"
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",
]
[tool.bumpversion]
allow_dirty = true
commit = true
commit_args = "--no-verify"
current_version = "2.21.0"
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"
python-polyfactory-2.21.0/tests/ 0000775 0000000 0000000 00000000000 15000423051 0016616 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/tests/__init__.py 0000664 0000000 0000000 00000000000 15000423051 0020715 0 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/tests/conftest.py 0000664 0000000 0000000 00000002650 15000423051 0021020 0 ustar 00root root 0000000 0000000 from __future__ import annotations
import importlib.util
import random
import string
import sys
from typing import TYPE_CHECKING, TypeVar
import pytest
if TYPE_CHECKING:
from pathlib import Path
from types import ModuleType
from typing import Callable
from pytest import MonkeyPatch
T = TypeVar("T")
@pytest.fixture()
def create_module(tmp_path: Path, monkeypatch: MonkeyPatch) -> Callable[[str], ModuleType]:
"""Utility fixture for dynamic module creation."""
def wrapped(source: str) -> ModuleType:
"""
Args:
source: Source code as a string.
Returns:
An imported module.
"""
def not_none(val: T | None) -> T:
assert val is not None
return val
def module_name_generator() -> str:
letters = string.ascii_lowercase
return "".join(random.choice(letters) for _ in range(10))
module_name = module_name_generator()
path = tmp_path / f"{module_name}.py"
path.write_text(source)
# https://docs.python.org/3/library/importlib.html#importing-a-source-file-directly
spec = not_none(importlib.util.spec_from_file_location(module_name, path))
module = not_none(importlib.util.module_from_spec(spec))
monkeypatch.setitem(sys.modules, module_name, module)
not_none(spec.loader).exec_module(module)
return module
return wrapped
python-polyfactory-2.21.0/tests/constraints/ 0000775 0000000 0000000 00000000000 15000423051 0021165 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/tests/constraints/test_byte_constraints.py 0000664 0000000 0000000 00000005060 15000423051 0026171 0 ustar 00root root 0000000 0000000 from random import Random
import pytest
from hypothesis import given
from hypothesis.strategies import booleans, integers
from polyfactory.exceptions import ParameterException
from polyfactory.value_generators.constrained_strings import handle_constrained_string_or_bytes
@given(booleans(), integers(max_value=10000), integers(max_value=10000))
def test_handle_constrained_bytes_with_min_length_and_max_length(
to_lower: bool,
min_length: int,
max_length: int,
) -> None:
if min_length < 0 or max_length < 0 or min_length > max_length:
with pytest.raises(ParameterException):
handle_constrained_string_or_bytes(
random=Random(),
t_type=bytes,
min_length=min_length,
max_length=max_length,
pattern=None,
)
else:
result = handle_constrained_string_or_bytes(
random=Random(),
t_type=bytes,
min_length=min_length,
max_length=max_length,
pattern=None,
)
if to_lower:
assert result == result.lower()
assert len(result) >= min_length
assert len(result) <= max_length
@given(booleans(), integers(max_value=10000))
def test_handle_constrained_bytes_with_min_length(to_lower: bool, min_length: int) -> None:
if min_length < 0:
with pytest.raises(ParameterException):
handle_constrained_string_or_bytes(
random=Random(),
t_type=bytes,
min_length=min_length,
pattern=None,
)
else:
result = handle_constrained_string_or_bytes(
random=Random(),
t_type=bytes,
min_length=min_length,
pattern=None,
)
if to_lower:
assert result == result.lower()
assert len(result) >= min_length
@given(booleans(), integers(max_value=10000))
def test_handle_constrained_bytes_with_max_length(to_lower: bool, max_length: int) -> None:
if max_length < 0:
with pytest.raises(ParameterException):
handle_constrained_string_or_bytes(
random=Random(),
t_type=bytes,
max_length=max_length,
pattern=None,
)
else:
result = handle_constrained_string_or_bytes(
random=Random(),
t_type=bytes,
max_length=max_length,
pattern=None,
)
if to_lower:
assert result == result.lower()
assert len(result) <= max_length
python-polyfactory-2.21.0/tests/constraints/test_date_constraints.py 0000664 0000000 0000000 00000001752 15000423051 0026147 0 ustar 00root root 0000000 0000000 from datetime import date, timedelta
from typing import Dict, Optional
import pytest
from hypothesis import given
from hypothesis.strategies import dates
from pydantic import BaseModel, condate
from polyfactory.factories.pydantic_factory import ModelFactory
@given(
dates(max_value=date.today() - timedelta(days=3)),
dates(min_value=date.today()),
)
@pytest.mark.parametrize(("start", "end"), (("ge", "le"), ("gt", "lt"), ("ge", "lt"), ("gt", "le")))
def test_handle_constrained_date(
start: Optional[str],
end: Optional[str],
start_date: date,
end_date: date,
) -> None:
if start_date != end_date:
kwargs: Dict[str, date] = {}
if start:
kwargs[start] = start_date
if end:
kwargs[end] = end_date
class MyModel(BaseModel):
value: condate(**kwargs) # type: ignore
class MyFactory(ModelFactory):
__model__ = MyModel
result = MyFactory.build()
assert result.value
python-polyfactory-2.21.0/tests/constraints/test_decimal_constraints.py 0000664 0000000 0000000 00000030001 15000423051 0026615 0 ustar 00root root 0000000 0000000 from decimal import Decimal
from random import Random
from typing import cast
import pytest
from hypothesis import given
from hypothesis.strategies import decimals, integers
from pydantic import BaseModel, condecimal
from polyfactory.exceptions import ParameterException
from polyfactory.factories.pydantic_factory import ModelFactory
from polyfactory.value_generators.constrained_numbers import (
handle_constrained_decimal,
handle_decimal_length,
is_multiply_of_multiple_of_in_range,
passes_pydantic_multiple_validator,
)
def test_handle_constrained_decimal_without_constraints() -> None:
result = handle_constrained_decimal(
random=Random(),
multiple_of=None,
decimal_places=None,
max_digits=None,
gt=None,
ge=None,
lt=None,
le=None,
)
assert isinstance(result, Decimal)
@pytest.mark.parametrize(
("msg", "ge", "le"),
(
("minimum value must be less than", Decimal("100.000"), Decimal()),
("maximum value must be greater than", Decimal(), Decimal("-100.000")),
),
)
def test_handle_constrained_decimal_length_validation(msg: str, ge: Decimal, le: Decimal) -> None:
with pytest.raises(
ParameterException,
match=msg,
):
handle_constrained_decimal(
random=Random(),
max_digits=2,
ge=ge,
le=le,
)
@given(integers(min_value=0, max_value=100))
def test_handle_constrained_decimal_handles_max_digits(max_digits: int) -> None:
if max_digits > 0:
result = handle_constrained_decimal(
random=Random(),
max_digits=max_digits,
)
assert len(result.as_tuple().digits) <= max_digits
else:
with pytest.raises(
ParameterException,
match="max_digits must be greater than 0",
):
handle_constrained_decimal(
random=Random(),
max_digits=max_digits,
)
@given(integers(min_value=0, max_value=100))
def test_handle_constrained_decimal_handles_decimal_places(decimal_places: int) -> None:
result = handle_constrained_decimal(
random=Random(),
decimal_places=decimal_places,
)
assert abs(cast("int", result.as_tuple().exponent)) <= decimal_places
@given(integers(min_value=0, max_value=100), integers(min_value=0, max_value=100))
def test_handle_constrained_decimal_handles_max_digits_and_decimal_places(max_digits: int, decimal_places: int) -> None:
if max_digits > 0 and max_digits >= decimal_places:
result = handle_constrained_decimal(
random=Random(),
decimal_places=decimal_places,
max_digits=max_digits,
)
non_fractionals = max_digits - decimal_places
list_value = str(result).strip("-").split(".")
if decimal_places:
left_digits, right_digits = list_value
assert len(right_digits) <= decimal_places
else:
left_digits = list_value[0]
assert len(left_digits) <= non_fractionals or int(left_digits) == non_fractionals
else:
with pytest.raises(ParameterException):
handle_constrained_decimal(
random=Random(),
decimal_places=decimal_places,
max_digits=max_digits,
)
@given(
decimals(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_decimal_handles_ge(minimum: Decimal) -> None:
result = handle_constrained_decimal(
random=Random(),
ge=minimum,
)
assert result >= minimum
@given(
decimals(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_decimal_handles_gt(minimum: Decimal) -> None:
result = handle_constrained_decimal(
random=Random(),
gt=minimum,
)
assert result > minimum
@given(
decimals(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_decimal_handles_le(maximum: Decimal) -> None:
result = handle_constrained_decimal(
random=Random(),
le=maximum,
)
assert result <= maximum
@given(
decimals(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_decimal_handles_lt(maximum: Decimal) -> None:
result = handle_constrained_decimal(
random=Random(),
lt=maximum,
)
assert result < maximum
@given(
decimals(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_decimal_handles_multiple_of(multiple_of: Decimal) -> None:
if multiple_of != Decimal("0"):
result = handle_constrained_decimal(
random=Random(),
multiple_of=multiple_of,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_decimal(
random=Random(),
multiple_of=multiple_of,
)
@given(
decimals(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
decimals(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_decimal_handles_multiple_of_with_lt(val1: Decimal, val2: Decimal) -> None:
multiple_of, max_value = sorted([val1, val2])
if multiple_of != Decimal("0"):
result = handle_constrained_decimal(
random=Random(),
multiple_of=multiple_of,
lt=max_value,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_decimal(
random=Random(),
multiple_of=multiple_of,
lt=max_value,
)
@given(
decimals(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
decimals(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_decimal_handles_multiple_of_with_le(val1: Decimal, val2: Decimal) -> None:
multiple_of, max_value = sorted([val1, val2])
if multiple_of != Decimal("0"):
result = handle_constrained_decimal(
random=Random(),
multiple_of=multiple_of,
le=max_value,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_decimal(
random=Random(),
multiple_of=multiple_of,
le=max_value,
)
@given(
decimals(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
decimals(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_decimal_handles_multiple_of_with_ge(val1: Decimal, val2: Decimal) -> None:
min_value, multiple_of = sorted([val1, val2])
if multiple_of != Decimal("0"):
result = handle_constrained_decimal(
random=Random(),
multiple_of=multiple_of,
ge=min_value,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_decimal(
random=Random(),
multiple_of=multiple_of,
ge=min_value,
)
@given(
decimals(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
decimals(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_decimal_handles_multiple_of_with_gt(val1: Decimal, val2: Decimal) -> None:
min_value, multiple_of = sorted([val1, val2])
if multiple_of != Decimal("0"):
result = handle_constrained_decimal(
random=Random(),
multiple_of=multiple_of,
gt=min_value,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_decimal(
random=Random(),
multiple_of=multiple_of,
gt=min_value,
)
@given(
decimals(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
decimals(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
decimals(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_decimal_handles_multiple_of_with_ge_and_le(
val1: Decimal,
val2: Decimal,
val3: Decimal,
) -> None:
min_value, multiple_of, max_value = sorted([val1, val2, val3])
if multiple_of != Decimal("0") and is_multiply_of_multiple_of_in_range(
minimum=min_value,
maximum=max_value,
multiple_of=multiple_of,
):
result = handle_constrained_decimal(
random=Random(),
multiple_of=multiple_of,
ge=min_value,
le=max_value,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_decimal(
random=Random(),
multiple_of=multiple_of,
ge=min_value,
le=max_value,
)
def test_max_digits_and_decimal_places() -> None:
class Person(BaseModel):
social_score: condecimal(
decimal_places=4,
max_digits=5,
gt=Decimal("0.0"),
le=Decimal("9.9999"),
) # type: ignore
class PersonFactory(ModelFactory):
__model__ = Person
result = PersonFactory.build()
assert isinstance(result.social_score, Decimal)
assert len(str(result.social_score).split(".")[1]) == 4
assert result.social_score > 0
def test_handle_decimal_length() -> None:
decimal = Decimal("999.9999999")
# here decimal places should determine max length
max_digits = 10
decimal_places: int | None = 5
result = handle_decimal_length(decimal, decimal_places, max_digits)
assert isinstance(result, Decimal)
assert len(result.as_tuple().digits) == 8
assert abs(cast("int", result.as_tuple().exponent)) == 5
# here digits determine decimal length
max_digits = 10
decimal_places = None
result = handle_decimal_length(decimal, decimal_places, max_digits)
assert isinstance(result, Decimal)
assert len(result.as_tuple().digits) == 10
assert abs(cast("int", result.as_tuple().exponent)) == 7
# here decimal places determine decimal length
max_digits = None # type: ignore
decimal_places = 5
result = handle_decimal_length(decimal, decimal_places, max_digits)
assert isinstance(result, Decimal)
assert len(result.as_tuple().digits) == 8
assert abs(cast("int", result.as_tuple().exponent)) == 5
def test_zero_to_one_range() -> None:
class FractionExample(BaseModel):
fraction: condecimal(ge=Decimal("0.0"), le=Decimal("1.0"), decimal_places=2, max_digits=3) # type: ignore
class FractionExampleFactory(ModelFactory):
__model__ = FractionExample
result = FractionExampleFactory.build()
assert result.fraction >= Decimal("0")
assert result.fraction <= Decimal("1")
python-polyfactory-2.21.0/tests/constraints/test_float_constraints.py 0000664 0000000 0000000 00000016241 15000423051 0026336 0 ustar 00root root 0000000 0000000 from random import Random
import pytest
from hypothesis import given
from hypothesis.strategies import floats
from polyfactory.exceptions import ParameterException
from polyfactory.value_generators.constrained_numbers import (
handle_constrained_float,
is_multiply_of_multiple_of_in_range,
passes_pydantic_multiple_validator,
)
def test_handle_constrained_float_without_constraints() -> None:
result = handle_constrained_float(
random=Random(),
)
assert isinstance(result, float)
@given(
floats(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_float_handles_ge(minimum: float) -> None:
result = handle_constrained_float(
random=Random(),
ge=minimum,
)
assert result >= minimum
@given(
floats(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_float_handles_gt(minimum: float) -> None:
result = handle_constrained_float(
random=Random(),
gt=minimum,
)
assert result > minimum
@given(
floats(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_float_handles_le(maximum: float) -> None:
result = handle_constrained_float(
random=Random(),
le=maximum,
)
assert result <= maximum
@given(
floats(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_float_handles_lt(maximum: float) -> None:
result = handle_constrained_float(
random=Random(),
lt=maximum,
)
assert result < maximum
@given(
floats(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_float_handles_multiple_of(multiple_of: float) -> None:
if multiple_of != 0.0:
result = handle_constrained_float(
random=Random(),
multiple_of=multiple_of,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_float(
random=Random(),
multiple_of=multiple_of,
)
@given(
floats(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
floats(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_float_handles_multiple_of_with_lt(val1: float, val2: float) -> None:
multiple_of, max_value = sorted([val1, val2])
if multiple_of != 0.0:
result = handle_constrained_float(
random=Random(),
multiple_of=multiple_of,
lt=max_value,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_float(
random=Random(),
multiple_of=multiple_of,
lt=max_value,
)
@given(
floats(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
floats(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_float_handles_multiple_of_with_le(val1: float, val2: float) -> None:
multiple_of, max_value = sorted([val1, val2])
if multiple_of != 0.0:
result = handle_constrained_float(
random=Random(),
multiple_of=multiple_of,
le=max_value,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_float(
random=Random(),
multiple_of=multiple_of,
le=max_value,
)
@given(
floats(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
floats(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_float_handles_multiple_of_with_ge(val1: float, val2: float) -> None:
min_value, multiple_of = sorted([val1, val2])
if multiple_of != 0.0:
result = handle_constrained_float(
random=Random(),
multiple_of=multiple_of,
ge=min_value,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_float(
random=Random(),
multiple_of=multiple_of,
ge=min_value,
)
@given(
floats(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
floats(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_float_handles_multiple_of_with_gt(val1: float, val2: float) -> None:
min_value, multiple_of = sorted([val1, val2])
if multiple_of != 0.0:
result = handle_constrained_float(
random=Random(),
multiple_of=multiple_of,
gt=min_value,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_float(
random=Random(),
multiple_of=multiple_of,
gt=min_value,
)
@pytest.mark.skip(reason="fails on edge cases")
@given(
floats(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
floats(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
floats(
allow_nan=False,
allow_infinity=False,
min_value=-1000000000,
max_value=1000000000,
),
)
def test_handle_constrained_float_handles_multiple_of_with_ge_and_le(val1: float, val2: float, val3: float) -> None:
min_value, multiple_of, max_value = sorted([val1, val2, val3])
if multiple_of != 0.0 and is_multiply_of_multiple_of_in_range(
minimum=min_value,
maximum=max_value,
multiple_of=multiple_of,
):
result = handle_constrained_float(
random=Random(),
multiple_of=multiple_of,
ge=min_value,
lt=max_value,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_float(
random=Random(),
multiple_of=multiple_of,
ge=min_value,
lt=max_value,
)
python-polyfactory-2.21.0/tests/constraints/test_frozen_set_constraints.py 0000664 0000000 0000000 00000005145 15000423051 0027410 0 ustar 00root root 0000000 0000000 from contextlib import suppress
from typing import Any
import pytest
from hypothesis import given
from hypothesis.strategies import integers
from polyfactory.exceptions import ParameterException
from polyfactory.factories.pydantic_factory import ModelFactory, PydanticFieldMeta
from polyfactory.value_generators.constrained_collections import (
handle_constrained_collection,
)
@given(
integers(min_value=0, max_value=10),
integers(min_value=0, max_value=10),
)
def test_handle_constrained_set_with_min_items_and_max_items(min_items: int, max_items: int) -> None:
if max_items >= min_items:
result = handle_constrained_collection(
collection_type=frozenset,
factory=ModelFactory,
field_meta=PydanticFieldMeta(name="test", annotation=frozenset),
item_type=str,
max_items=max_items,
min_items=min_items,
)
assert len(result) >= min_items
assert len(result) <= max_items or 1
else:
with pytest.raises(ParameterException):
handle_constrained_collection(
collection_type=frozenset,
factory=ModelFactory,
field_meta=PydanticFieldMeta(name="test", annotation=frozenset),
item_type=str,
max_items=max_items,
min_items=min_items,
)
@given(
integers(min_value=0, max_value=10),
)
def test_handle_constrained_set_with_max_items(
max_items: int,
) -> None:
result = handle_constrained_collection(
collection_type=frozenset,
factory=ModelFactory,
field_meta=PydanticFieldMeta(name="test", annotation=frozenset),
item_type=str,
max_items=max_items,
)
assert len(result) <= max_items or 1
@given(
integers(min_value=0, max_value=10),
)
def test_handle_constrained_set_with_min_items(
min_items: int,
) -> None:
result = handle_constrained_collection(
collection_type=frozenset,
factory=ModelFactory,
field_meta=PydanticFieldMeta(name="test", annotation=frozenset),
item_type=str,
min_items=min_items,
)
assert len(result) >= min_items
@pytest.mark.parametrize("t_type", tuple(ModelFactory.get_provider_map()))
def test_handle_constrained_set_with_different_types(t_type: Any) -> None:
with suppress(ParameterException):
result = handle_constrained_collection(
collection_type=frozenset,
factory=ModelFactory,
field_meta=PydanticFieldMeta(name="test", annotation=frozenset),
item_type=t_type,
)
assert len(result) >= 0
python-polyfactory-2.21.0/tests/constraints/test_get_field_value_constraints.py 0000664 0000000 0000000 00000004275 15000423051 0030353 0 ustar 00root root 0000000 0000000 from datetime import date, datetime, timedelta
from decimal import Decimal
from typing import FrozenSet, List, Set, Tuple, Type, Union, cast
import pytest
from typing_extensions import Annotated
from polyfactory.factories.base import BaseFactory
from polyfactory.field_meta import Constraints, FieldMeta
@pytest.mark.parametrize("t", (int, float, Decimal))
def test_numbers(t: Type[Union[int, float, Decimal]]) -> None:
constraints: Constraints = {"ge": 1, "le": 20}
field_meta = FieldMeta.from_type(annotation=t, name="foo", constraints=constraints)
value = BaseFactory.get_field_value(field_meta)
assert value >= constraints["ge"]
assert value <= constraints["le"]
@pytest.mark.parametrize("t", (str, bytes))
def test_str_and_bytes(t: Type[Union[str, bytes]]) -> None:
constraints: Constraints = {"min_length": 20, "max_length": 45}
field_meta = FieldMeta.from_type(annotation=t, name="foo", constraints=constraints)
value = BaseFactory.get_field_value(field_meta)
assert len(value) >= constraints["min_length"]
assert len(value) <= constraints["max_length"]
@pytest.mark.parametrize("t", (List[int], Set[int], Tuple[int], FrozenSet[int]))
def test_collections(t: Type[Union[Tuple, List, Set, FrozenSet]]) -> None:
constraints: Constraints = {
"min_length": 2,
"max_length": 10,
}
field_meta = FieldMeta.from_type(annotation=t, name="foo", constraints=constraints)
value = BaseFactory.get_field_value(field_meta)
assert len(value) >= constraints["min_length"]
assert len(value) <= constraints["max_length"]
def test_date() -> None:
ge_date = datetime.now().date()
le_date = ge_date + timedelta(days=10)
constraints = {"ge": ge_date, "le": le_date}
field_meta = FieldMeta.from_type(
annotation=date,
name="foo",
constraints=cast(Constraints, constraints),
)
value = BaseFactory.get_field_value(field_meta)
assert value >= ge_date
assert value <= le_date
def test_constraints_parsing() -> None:
constraints = Constraints(min_length=10)
annotation = Annotated[str, constraints]
field_meta = FieldMeta.from_type(annotation)
assert field_meta.constraints == constraints
python-polyfactory-2.21.0/tests/constraints/test_int_constraints.py 0000664 0000000 0000000 00000014703 15000423051 0026024 0 ustar 00root root 0000000 0000000 from random import Random
import pytest
from hypothesis import HealthCheck, given, settings
from hypothesis.strategies import integers
from polyfactory.exceptions import ParameterException
from polyfactory.value_generators.constrained_numbers import (
handle_constrained_int,
is_multiply_of_multiple_of_in_range,
passes_pydantic_multiple_validator,
)
def test_handle_constrained_int_without_constraints() -> None:
result = handle_constrained_int(
random=Random(),
)
assert isinstance(result, int)
@given(integers(min_value=-1000000000, max_value=1000000000))
def test_handle_constrained_int_handles_ge(minimum: int) -> None:
result = handle_constrained_int(
random=Random(),
ge=minimum,
)
assert result >= minimum
@given(integers(min_value=-1000000000, max_value=1000000000))
def test_handle_constrained_int_handles_gt(minimum: int) -> None:
result = handle_constrained_int(
random=Random(),
gt=minimum,
)
assert result > minimum
@given(integers(min_value=-1000000000, max_value=1000000000))
def test_handle_constrained_int_handles_le(maximum: int) -> None:
result = handle_constrained_int(
random=Random(),
le=maximum,
)
assert result <= maximum
@given(integers(min_value=-1000000000, max_value=1000000000))
def test_handle_constrained_int_handles_lt(maximum: int) -> None:
result = handle_constrained_int(
random=Random(),
lt=maximum,
)
assert result < maximum
@settings(suppress_health_check=(HealthCheck.filter_too_much,))
@given(
integers(min_value=1, max_value=10),
integers(min_value=1, max_value=10),
)
def test_handle_constrained_int_handles_ge_with_le(val1: int, val2: int) -> None:
min_value, max_value = sorted([val1, val2])
result = handle_constrained_int(
random=Random(),
ge=min_value,
le=max_value,
)
assert min_value <= result <= max_value
@given(integers(min_value=-1000000000, max_value=1000000000))
def test_handle_constrained_int_handles_multiple_of(multiple_of: int) -> None:
if multiple_of != 0:
result = handle_constrained_int(
random=Random(),
multiple_of=multiple_of,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_int(
random=Random(),
multiple_of=multiple_of,
)
@given(
integers(min_value=-1000000000, max_value=1000000000),
integers(min_value=-1000000000, max_value=1000000000),
)
def test_handle_constrained_int_handles_multiple_of_with_lt(val1: int, val2: int) -> None:
multiple_of, max_value = sorted([val1, val2])
if multiple_of != 0:
result = handle_constrained_int(
random=Random(),
multiple_of=multiple_of,
lt=max_value,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_int(
random=Random(),
multiple_of=multiple_of,
lt=max_value,
)
@given(
integers(min_value=-1000000000, max_value=1000000000),
integers(min_value=-1000000000, max_value=1000000000),
)
def test_handle_constrained_int_handles_multiple_of_with_le(val1: int, val2: int) -> None:
multiple_of, max_value = sorted([val1, val2])
if multiple_of != 0:
result = handle_constrained_int(
random=Random(),
multiple_of=multiple_of,
le=max_value,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_int(
random=Random(),
multiple_of=multiple_of,
le=max_value,
)
@given(
integers(min_value=-1000000000, max_value=1000000000),
integers(min_value=-1000000000, max_value=1000000000),
)
def test_handle_constrained_int_handles_multiple_of_with_ge(val1: int, val2: int) -> None:
min_value, multiple_of = sorted([val1, val2])
if multiple_of != 0:
result = handle_constrained_int(
random=Random(),
multiple_of=multiple_of,
ge=min_value,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_int(
random=Random(),
multiple_of=multiple_of,
ge=min_value,
)
@given(
integers(min_value=-1000000000, max_value=1000000000),
integers(min_value=-1000000000, max_value=1000000000),
)
def test_handle_constrained_int_handles_multiple_of_with_gt(val1: int, val2: int) -> None:
min_value, multiple_of = sorted([val1, val2])
if multiple_of != 0:
result = handle_constrained_int(
random=Random(),
multiple_of=multiple_of,
gt=min_value,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_int(
random=Random(),
multiple_of=multiple_of,
gt=min_value,
)
@given(
integers(min_value=-1000000000, max_value=1000000000),
integers(min_value=-1000000000, max_value=1000000000),
integers(min_value=-1000000000, max_value=1000000000),
)
def test_handle_constrained_int_handles_multiple_of_with_ge_and_le(val1: int, val2: int, val3: int) -> None:
min_value, multiple_of, max_value = sorted([val1, val2, val3])
if multiple_of != 0 and is_multiply_of_multiple_of_in_range(
minimum=min_value,
maximum=max_value,
multiple_of=multiple_of,
):
result = handle_constrained_int(
random=Random(),
multiple_of=multiple_of,
ge=min_value,
le=max_value,
)
assert passes_pydantic_multiple_validator(result, multiple_of)
else:
with pytest.raises(ParameterException):
handle_constrained_int(
random=Random(),
multiple_of=multiple_of,
ge=min_value,
le=max_value,
)
def test_constraint_randomness() -> None:
random = Random(10)
assert [
handle_constrained_int(
random=random,
)
for _ in range(3)
] == [81, 109, 152]
python-polyfactory-2.21.0/tests/constraints/test_list_constraints.py 0000664 0000000 0000000 00000006256 15000423051 0026211 0 ustar 00root root 0000000 0000000 import sys
from typing import Any, List
import pytest
from hypothesis import given
from hypothesis.strategies import integers
from pydantic import VERSION
from polyfactory.exceptions import ParameterException
from polyfactory.factories.pydantic_factory import ModelFactory, PydanticFieldMeta
from polyfactory.value_generators.constrained_collections import (
handle_constrained_collection,
)
@given(
integers(min_value=0, max_value=10),
integers(min_value=0, max_value=10),
)
def test_handle_constrained_list_with_min_items_and_max_items(min_items: int, max_items: int) -> None:
if max_items >= min_items:
result = handle_constrained_collection(
collection_type=list,
factory=ModelFactory,
field_meta=PydanticFieldMeta(name="test", annotation=list),
item_type=str,
max_items=max_items,
min_items=min_items,
)
assert len(result) >= min_items
assert len(result) <= max_items or 1
else:
with pytest.raises(ParameterException):
handle_constrained_collection(
collection_type=list,
factory=ModelFactory,
field_meta=PydanticFieldMeta(name="test", annotation=list),
item_type=str,
max_items=max_items,
min_items=min_items,
)
@given(
integers(min_value=0, max_value=10),
)
def test_handle_constrained_list_with_max_items(
max_items: int,
) -> None:
result = handle_constrained_collection(
collection_type=list,
factory=ModelFactory,
field_meta=PydanticFieldMeta(name="test", annotation=list),
item_type=str,
max_items=max_items,
)
assert len(result) <= max_items or 1
@given(
integers(min_value=0, max_value=10),
)
def test_handle_constrained_list_with_min_items(
min_items: int,
) -> None:
result = handle_constrained_collection(
collection_type=list,
factory=ModelFactory,
field_meta=PydanticFieldMeta.from_type(List[str], name="test"),
item_type=str,
min_items=min_items,
)
assert len(result) >= min_items
@pytest.mark.skipif(
sys.version_info < (3, 9) and VERSION.startswith("2"),
reason="fails on python 3.8 with pydantic v2",
)
@pytest.mark.parametrize("t_type", tuple(ModelFactory.get_provider_map()))
def test_handle_constrained_list_with_different_types(t_type: Any) -> None:
field_meta = PydanticFieldMeta.from_type(List[t_type], name="test")
result = handle_constrained_collection(
collection_type=list,
factory=ModelFactory,
field_meta=field_meta.children[0], # type: ignore[index]
item_type=t_type,
)
assert len(result) >= 0
def test_handle_unique_items() -> None:
field_meta = PydanticFieldMeta.from_type(List[str], name="test", constraints={"unique_items": True})
result = handle_constrained_collection(
collection_type=list,
factory=ModelFactory,
field_meta=field_meta.children[0], # type: ignore[index]
item_type=str,
unique_items=True,
min_items=2,
max_items=2,
)
assert len(result) == 2
assert len(set(result)) == 2
python-polyfactory-2.21.0/tests/constraints/test_mapping_constraints.py 0000664 0000000 0000000 00000004450 15000423051 0026663 0 ustar 00root root 0000000 0000000 import pytest
from hypothesis import given
from hypothesis.strategies import integers
from polyfactory.exceptions import ParameterException
from polyfactory.factories.pydantic_factory import ModelFactory, PydanticFieldMeta
from polyfactory.value_generators.constrained_collections import (
handle_constrained_mapping,
)
@given(
integers(min_value=0, max_value=10),
integers(min_value=0, max_value=10),
)
def test_handle_constrained_mapping_with_min_items_and_max_items(min_items: int, max_items: int) -> None:
key_field = PydanticFieldMeta(name="key", annotation=str)
value_field = PydanticFieldMeta(name="value", annotation=int)
field_meta = PydanticFieldMeta(name="test", annotation=dict, children=[key_field, value_field])
if max_items >= min_items:
result = handle_constrained_mapping(
factory=ModelFactory,
field_meta=field_meta,
max_items=max_items,
min_items=min_items,
)
assert len(result) >= min_items
assert len(result) <= max_items or 1
for key, value in result.items():
assert isinstance(key, str)
assert isinstance(value, int)
else:
with pytest.raises(ParameterException):
handle_constrained_mapping(
factory=ModelFactory,
field_meta=field_meta,
max_items=max_items,
min_items=min_items,
)
def test_handle_constrained_mapping_with_constrained_key_and_value() -> None:
key_min_length = 5
value_gt = 100
min_length = 5
max_length = 10
key_field = PydanticFieldMeta(name="key", annotation=str, constraints={"min_length": key_min_length})
value_field = PydanticFieldMeta(name="value", annotation=int, constraints={"gt": value_gt})
field_meta = PydanticFieldMeta(name="test", annotation=dict, children=[key_field, value_field])
result = handle_constrained_mapping(
factory=ModelFactory,
field_meta=field_meta,
min_items=min_length,
max_items=max_length,
)
assert len(result) >= min_length
assert len(result) <= max_length
for key, value in result.items():
assert isinstance(key, str)
assert isinstance(value, int)
assert len(key) >= key_min_length
assert value >= value_gt
python-polyfactory-2.21.0/tests/constraints/test_set_constraints.py 0000664 0000000 0000000 00000005056 15000423051 0026026 0 ustar 00root root 0000000 0000000 from contextlib import suppress
from typing import Any
import pytest
from hypothesis import given
from hypothesis.strategies import integers
from polyfactory.exceptions import ParameterException
from polyfactory.factories.pydantic_factory import ModelFactory, PydanticFieldMeta
from polyfactory.value_generators.constrained_collections import (
handle_constrained_collection,
)
@given(
integers(min_value=0, max_value=10),
integers(min_value=0, max_value=10),
)
def test_handle_constrained_set_with_min_items_and_max_items(min_items: int, max_items: int) -> None:
if max_items >= min_items:
result = handle_constrained_collection(
collection_type=list,
factory=ModelFactory,
field_meta=PydanticFieldMeta(name="test", annotation=set),
item_type=str,
max_items=max_items,
min_items=min_items,
)
assert len(result) >= min_items
assert len(result) <= max_items or 1
else:
with pytest.raises(ParameterException):
handle_constrained_collection(
collection_type=list,
factory=ModelFactory,
field_meta=PydanticFieldMeta(name="test", annotation=set),
item_type=str,
max_items=max_items,
min_items=min_items,
)
@given(
integers(min_value=0, max_value=10),
)
def test_handle_constrained_set_with_max_items(
max_items: int,
) -> None:
result = handle_constrained_collection(
collection_type=list,
factory=ModelFactory,
field_meta=PydanticFieldMeta(name="test", annotation=set),
item_type=str,
max_items=max_items,
)
assert len(result) <= max_items or 1
@given(
integers(min_value=0, max_value=10),
)
def test_handle_constrained_set_with_min_items(
min_items: int,
) -> None:
result = handle_constrained_collection(
collection_type=list,
factory=ModelFactory,
field_meta=PydanticFieldMeta(name="test", annotation=set),
item_type=str,
min_items=min_items,
)
assert len(result) >= min_items
@pytest.mark.parametrize("t_type", tuple(ModelFactory.get_provider_map()))
def test_handle_constrained_set_with_different_types(t_type: Any) -> None:
with suppress(ParameterException):
result = handle_constrained_collection(
collection_type=list,
factory=ModelFactory,
field_meta=PydanticFieldMeta(name="test", annotation=set),
item_type=t_type,
)
assert len(result) >= 0
python-polyfactory-2.21.0/tests/constraints/test_string_constraints.py 0000664 0000000 0000000 00000012103 15000423051 0026530 0 ustar 00root root 0000000 0000000 import re
from random import Random
import pytest
from hypothesis import given, settings
from hypothesis.strategies import booleans, integers
from polyfactory.exceptions import ParameterException
from polyfactory.value_generators.constrained_strings import handle_constrained_string_or_bytes
REGEXES = [
r"(a|b|c)xz",
r"a|b",
r"[0-9]{2,4}",
r"a{2,3}",
r"ma?n",
r"ma+n",
r"ma*n",
r"a$",
r"\Athe",
r"\bfoo",
r"foo\b",
r"\Bfoo",
r"foo\B",
]
@settings(deadline=600)
@given(
booleans(),
integers(min_value=5, max_value=100),
integers(min_value=5, max_value=100),
)
def test_handle_constrained_string_with_min_length_and_max_length_and_regex(
to_lower: bool,
min_length: int,
max_length: int,
) -> None:
if min_length < 0 or max_length < 0 or min_length > max_length:
with pytest.raises(ParameterException):
handle_constrained_string_or_bytes(
random=Random(),
t_type=str,
lower_case=to_lower,
upper_case=to_lower,
min_length=min_length,
max_length=max_length,
pattern=None,
)
else:
for regex in REGEXES:
result = handle_constrained_string_or_bytes(
random=Random(),
t_type=str,
lower_case=to_lower,
upper_case=to_lower,
min_length=min_length,
max_length=max_length,
pattern=None,
)
if to_lower:
assert result == result.lower()
if match := re.search(regex, result):
assert match[0]
assert len(result) >= min_length
assert len(result) <= max_length
@given(booleans(), integers(max_value=10000), integers(max_value=10000))
def test_handle_constrained_string_with_min_length_and_max_length(
to_lower: bool,
min_length: int,
max_length: int,
) -> None:
if min_length < 0 or max_length < 0 or min_length > max_length:
with pytest.raises(ParameterException):
handle_constrained_string_or_bytes(
random=Random(),
t_type=str,
lower_case=to_lower,
upper_case=to_lower,
min_length=min_length,
max_length=max_length,
pattern=None,
)
else:
result = handle_constrained_string_or_bytes(
random=Random(),
t_type=str,
lower_case=to_lower,
upper_case=to_lower,
min_length=min_length,
max_length=max_length,
pattern=None,
)
if to_lower:
assert result == result.lower()
assert len(result) >= min_length
assert len(result) <= max_length
@given(booleans(), integers(max_value=10000))
def test_handle_constrained_string_with_min_length(to_lower: bool, min_length: int) -> None:
if min_length < 0:
with pytest.raises(ParameterException):
handle_constrained_string_or_bytes(
random=Random(),
t_type=str,
lower_case=to_lower,
upper_case=to_lower,
min_length=min_length,
pattern=None,
)
else:
result = handle_constrained_string_or_bytes(
random=Random(),
t_type=str,
lower_case=to_lower,
upper_case=to_lower,
min_length=min_length,
pattern=None,
)
if to_lower:
assert result == result.lower()
assert len(result) >= min_length
@given(booleans(), integers(max_value=10000))
def test_handle_constrained_string_with_max_length(to_lower: bool, max_length: int) -> None:
if max_length < 0:
with pytest.raises(ParameterException):
handle_constrained_string_or_bytes(
random=Random(),
t_type=str,
lower_case=to_lower,
upper_case=to_lower,
max_length=max_length,
pattern=None,
)
else:
result = handle_constrained_string_or_bytes(
random=Random(),
t_type=str,
lower_case=to_lower,
upper_case=to_lower,
max_length=max_length,
pattern=None,
)
if to_lower:
assert result == result.lower()
assert len(result) <= max_length
def test_pattern() -> None:
result = handle_constrained_string_or_bytes(
random=Random(),
t_type=str,
lower_case=False,
upper_case=True,
min_length=6,
max_length=10,
pattern="abc",
)
assert len(result) >= 6
assert len(result) <= 10
assert result.isupper()
result = handle_constrained_string_or_bytes(
random=Random(),
t_type=str,
lower_case=True,
upper_case=False,
min_length=6,
max_length=10,
pattern="abc",
)
assert len(result) >= 6
assert len(result) <= 10
assert not result.isupper()
python-polyfactory-2.21.0/tests/models.py 0000664 0000000 0000000 00000001547 15000423051 0020462 0 ustar 00root root 0000000 0000000 from datetime import date, datetime
from typing import List, Optional, Union
from uuid import uuid4
from pydantic import UUID4, BaseModel
from polyfactory.factories.pydantic_factory import ModelFactory
class Pet(BaseModel):
name: str
species: str
color: str
sound: str
age: float
class Person(BaseModel):
id: UUID4
name: str
hobbies: Optional[List[str]]
nicks: List[str]
age: Union[float, int]
pets: List[Pet]
birthday: Union[datetime, date]
class PersonFactoryWithoutDefaults(ModelFactory[Person]):
__model__ = Person
class PersonFactoryWithDefaults(PersonFactoryWithoutDefaults):
id = uuid4()
name = "moishe"
hobbies = ["fishing"]
nicks: List[str] = []
age = 33
pets: List[Pet] = []
birthday = datetime(2021 - 33, 1, 1)
class PetFactory(ModelFactory[Pet]):
__model__ = Pet
python-polyfactory-2.21.0/tests/sqlalchemy_factory/ 0000775 0000000 0000000 00000000000 15000423051 0022507 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/tests/sqlalchemy_factory/__init__.py 0000664 0000000 0000000 00000000000 15000423051 0024606 0 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/tests/sqlalchemy_factory/conftest.py 0000664 0000000 0000000 00000001323 15000423051 0024705 0 ustar 00root root 0000000 0000000 from typing import AsyncIterator
import pytest
from sqlalchemy import create_engine
from sqlalchemy.engine import Engine
from sqlalchemy.ext.asyncio import AsyncEngine, create_async_engine
from tests.sqlalchemy_factory.models import Base
@pytest.fixture()
def engine() -> Engine:
return create_engine("sqlite:///:memory:")
@pytest.fixture()
def async_engine() -> AsyncEngine:
return create_async_engine("sqlite+aiosqlite:///:memory:")
@pytest.fixture(autouse=True)
async def fx_drop_create_meta(async_engine: AsyncEngine) -> AsyncIterator[None]:
async with async_engine.begin() as conn:
await conn.run_sync(Base.metadata.drop_all)
await conn.run_sync(Base.metadata.create_all)
yield
python-polyfactory-2.21.0/tests/sqlalchemy_factory/models.py 0000664 0000000 0000000 00000005706 15000423051 0024354 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from typing import Any, Optional
from sqlalchemy import (
Boolean,
Column,
DateTime,
ForeignKey,
Integer,
String,
func,
orm,
text,
)
from sqlalchemy.ext.associationproxy import association_proxy
from sqlalchemy.orm import relationship
from sqlalchemy.orm.decl_api import DeclarativeMeta, registry
_registry = registry()
@dataclass
class NonSQLAchemyClass:
id: int
class Base(metaclass=DeclarativeMeta):
__abstract__ = True
__allow_unmapped__ = True
registry = _registry
metadata = _registry.metadata
class Author(Base):
__tablename__ = "authors"
id: Any = Column(Integer(), primary_key=True)
books: Any = orm.relationship(
"Book",
collection_class=list,
uselist=True,
back_populates="author",
)
class Book(Base):
__tablename__ = "books"
id: Any = Column(Integer(), primary_key=True)
author_id: Any = Column(
Integer(),
ForeignKey(Author.id),
nullable=False,
)
author: Any = orm.relationship(
Author,
uselist=False,
back_populates="books",
)
class AsyncModel(Base):
__tablename__ = "async_model"
id: Any = Column(Integer(), primary_key=True)
class AsyncRefreshModel(Base):
__tablename__ = "server_default_test"
id: Any = Column(Integer(), primary_key=True)
test_datetime: Any = Column(DateTime(timezone=True), server_default=func.now(), nullable=False)
test_str: Any = Column(String, nullable=False, server_default=text("test_str"))
test_int: Any = Column(Integer, nullable=False, server_default=text("123"))
test_bool: Any = Column(Boolean, nullable=False, server_default=text("False"))
class User(Base):
__tablename__ = "users"
id = Column(Integer, primary_key=True)
name = Column(String)
user_keyword_associations = relationship(
"UserKeywordAssociation",
back_populates="user",
lazy="selectin",
)
keywords = association_proxy(
"user_keyword_associations", "keyword", creator=lambda keyword_obj: UserKeywordAssociation(keyword=keyword_obj)
)
class UserKeywordAssociation(Base):
__tablename__ = "user_keyword"
user_id = Column(Integer, ForeignKey("users.id"), primary_key=True)
keyword_id = Column(Integer, ForeignKey("keywords.id"), primary_key=True)
user = relationship(User, back_populates="user_keyword_associations")
keyword = relationship("Keyword", lazy="selectin")
# for prevent mypy error: Unexpected keyword argument "keyword" for "UserKeywordAssociation" [call-arg]
def __init__(self, keyword: Optional["Keyword"] = None):
self.keyword = keyword
class Keyword(Base):
__tablename__ = "keywords"
id = Column(Integer, primary_key=True)
keyword = Column(String)
class Department(Base):
__tablename__ = "departments"
id = Column(Integer, primary_key=True)
director_id = Column(Integer, ForeignKey("users.id"))
python-polyfactory-2.21.0/tests/sqlalchemy_factory/test_association_proxy.py 0000664 0000000 0000000 00000003102 15000423051 0027671 0 ustar 00root root 0000000 0000000 from sqlalchemy import select
from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession
from polyfactory.factories.sqlalchemy_factory import SQLAlchemyFactory
from tests.sqlalchemy_factory.models import Keyword, User, UserKeywordAssociation
class KeywordFactory(SQLAlchemyFactory[Keyword]): ...
def test_association_proxy() -> None:
class UserFactory(SQLAlchemyFactory[User]):
__set_association_proxy__ = True
user = UserFactory.build()
assert isinstance(user.keywords[0], Keyword)
assert isinstance(user.user_keyword_associations[0], UserKeywordAssociation)
async def test_async_persistence(async_engine: AsyncEngine) -> None:
async with AsyncSession(async_engine) as session:
class AsyncUserFactory(SQLAlchemyFactory[User]):
__set_association_proxy__ = True
__async_session__ = session
instance = await AsyncUserFactory.create_async()
instances = await AsyncUserFactory.create_batch_async(3)
async with AsyncSession(async_engine) as session:
result = await session.scalars(select(User))
assert len(result.all()) == 4
user = await session.get(User, instance.id)
assert user
assert isinstance(user.keywords[0], Keyword)
assert isinstance(user.user_keyword_associations[0], UserKeywordAssociation)
for instance in instances:
user = await session.get(User, instance.id)
assert user
assert isinstance(user.keywords[0], Keyword)
assert isinstance(user.user_keyword_associations[0], UserKeywordAssociation)
python-polyfactory-2.21.0/tests/sqlalchemy_factory/test_sqlalchemy_factory_common.py 0000664 0000000 0000000 00000032631 15000423051 0031366 0 ustar 00root root 0000000 0000000 from datetime import datetime
from decimal import Decimal
from enum import Enum
from typing import Any, Callable, get_args
from uuid import UUID
import pytest
from sqlalchemy import (
Column,
Integer,
Numeric,
String,
inspect,
orm,
select,
types,
)
from sqlalchemy.engine import Engine
from sqlalchemy.ext.asyncio import AsyncEngine, AsyncSession
from sqlalchemy.ext.hybrid import hybrid_property
from sqlalchemy.orm import Session
from sqlalchemy.orm.decl_api import DeclarativeMeta, registry
from polyfactory.exceptions import ConfigurationException, ParameterException
from polyfactory.factories.base import BaseFactory
from polyfactory.factories.sqlalchemy_factory import SQLAlchemyFactory
from polyfactory.fields import Ignore
from tests.sqlalchemy_factory.models import (
AsyncModel,
AsyncRefreshModel,
Author,
Base,
Book,
NonSQLAchemyClass,
_registry,
)
@pytest.mark.parametrize(
"invalid_model",
(
Base,
NonSQLAchemyClass,
),
)
def test_invalid_model(invalid_model: type) -> None:
with pytest.raises(ConfigurationException):
SQLAlchemyFactory.create_factory(invalid_model)
def test_python_type_handling() -> None:
_registry = registry()
class Base(metaclass=DeclarativeMeta):
__abstract__ = True
registry = _registry
metadata = _registry.metadata
class Animal(str, Enum):
DOG = "Dog"
CAT = "Cat"
class Model(Base):
__tablename__ = "model"
id: Any = Column(Integer(), primary_key=True)
str_type: Any = Column(String(), nullable=False)
enum_type: Any = Column(types.Enum(Animal), nullable=False)
str_array_type: Any = Column(
types.ARRAY(types.String),
nullable=False,
)
class ModelFactory(SQLAlchemyFactory[Model]):
__model__ = Model
instance = ModelFactory.build()
assert isinstance(instance.id, int)
assert isinstance(instance.str_type, str)
assert isinstance(instance.enum_type, Animal)
assert isinstance(instance.str_array_type, list)
assert isinstance(instance.str_array_type[0], str)
def test_properties() -> None:
_registry = registry()
class Base(metaclass=DeclarativeMeta):
__abstract__ = True
registry = _registry
metadata = _registry.metadata
class Model(Base):
__tablename__ = "model"
id: Any = Column(Integer(), primary_key=True)
age: Any = Column(Integer(), nullable=False)
double_age = orm.column_property(age * 2)
@hybrid_property
def triple_age(self) -> int:
return self.age * 3 # type: ignore[no-any-return]
class ModelFactory(SQLAlchemyFactory[Model]): ...
instance = ModelFactory.build()
assert isinstance(instance, Model)
# Expect empty as requires session to be set
assert instance.double_age is None
assert instance.age * 3 == instance.triple_age
@pytest.mark.parametrize(
"type_",
tuple(SQLAlchemyFactory.get_sqlalchemy_types().keys()),
)
def test_sqlalchemy_type_handlers(type_: types.TypeEngine) -> None:
_registry = registry()
class Base(metaclass=DeclarativeMeta):
__abstract__ = True
registry = _registry
metadata = _registry.metadata
class Model(Base):
__tablename__ = "model_with_overridden_type"
id: Any = Column(Integer(), primary_key=True)
overridden: Any = Column(type_, nullable=False)
class ModelFactory(SQLAlchemyFactory[Model]):
__model__ = Model
instance = ModelFactory.build()
assert instance.overridden is not None
def test_optional_field() -> None:
class Model(Base):
__tablename__ = "model_with_optional_field"
id: Any = Column(Integer(), primary_key=True)
optional_field: Any = Column(String(), nullable=True)
class ModelFactory(SQLAlchemyFactory[Model]):
__model__ = Model
__random_seed__ = 0
result = ModelFactory.build()
assert result.optional_field is None
@pytest.mark.parametrize("set_primary_key", (True, False))
def test_set_primary_key(set_primary_key: bool) -> None:
class AuthorFactory(SQLAlchemyFactory[Author]):
__model__ = Author
__set_primary_key__ = set_primary_key
result = AuthorFactory.build()
assert bool(result.id) is set_primary_key
@pytest.mark.parametrize("set_foreign_keys", (True, False))
def test_set_foreign_keys(set_foreign_keys: bool) -> None:
class BookFactory(SQLAlchemyFactory[Book]):
__model__ = Book
__set_foreign_keys__ = set_foreign_keys
result = BookFactory.build()
assert bool(result.author_id) is set_foreign_keys
def test_relationship_resolution() -> None:
class BookFactory(SQLAlchemyFactory[Book]):
__model__ = Book
__set_relationships__ = True
result = BookFactory.build()
assert isinstance(result.author, Author)
def test_relationship_list_resolution() -> None:
class AuthorFactory(SQLAlchemyFactory[Author]):
__model__ = Author
__set_relationships__ = True
result = AuthorFactory.build()
assert result.books is not None
assert isinstance(result.books, list)
assert isinstance(result.books[0], Book)
def test_sqla_factory_create(engine: Engine) -> None:
Base.metadata.create_all(engine)
class OverriddenSQLAlchemyFactory(SQLAlchemyFactory):
__is_base_factory__ = True
__session__ = Session(engine)
__set_relationships__ = True
author: Author = OverriddenSQLAlchemyFactory.create_factory(Author).create_sync()
assert isinstance(author.books[0], Book)
assert author.books[0].author is author
book = OverriddenSQLAlchemyFactory.create_factory(Book).create_sync()
assert book.author is not None
assert book.author.books == [book]
BaseFactory._base_factories.remove(OverriddenSQLAlchemyFactory)
async def test_invalid_persistence_config_raises() -> None:
class AuthorFactory(SQLAlchemyFactory[Author]):
__model__ = Author
with pytest.raises(
ConfigurationException,
match="A '__sync_persistence__' handler must be defined in the factory to use this method",
):
AuthorFactory.create_sync()
with pytest.raises(
ConfigurationException,
match="An '__async_persistence__' handler must be defined in the factory to use this method",
):
await AuthorFactory.create_async()
@pytest.mark.parametrize(
"session_config",
(
lambda session: session,
lambda session: (lambda: session),
),
)
def test_sync_persistence(engine: Engine, session_config: Callable[[Session], Any]) -> None:
Base.metadata.create_all(bind=engine)
with Session(bind=engine) as session:
class AuthorFactory(SQLAlchemyFactory[Author]):
__session__ = session_config(session)
__model__ = Author
author = AuthorFactory.create_sync()
assert author.id is not None
assert inspect(author).persistent # type: ignore[union-attr]
batch_result = AuthorFactory.create_batch_sync(size=2)
assert len(batch_result) == 2
for batch_item in batch_result:
assert inspect(batch_item).persistent # type: ignore[union-attr]
@pytest.mark.parametrize(
"session_config",
(
lambda session: session,
lambda session: (lambda: session),
),
)
async def test_async_persistence(
async_engine: AsyncEngine,
session_config: Callable[[AsyncSession], Any],
) -> None:
async with AsyncSession(async_engine) as session:
class Factory(SQLAlchemyFactory[AsyncModel]):
__async_session__ = session_config(session)
__model__ = AsyncModel
instance = await Factory.create_async()
batch_result = await Factory.create_batch_async(size=2)
assert len(batch_result) == 2
async with AsyncSession(async_engine) as session:
result = await session.scalar(select(AsyncModel).where(AsyncModel.id == instance.id))
assert result
for batch_item in batch_result:
result = await session.scalar(select(AsyncModel).where(AsyncModel.id == batch_item.id))
assert result
@pytest.mark.parametrize(
"session_config",
(
lambda session: session,
lambda session: (lambda: session),
),
)
async def test_async_server_default_refresh(
async_engine: AsyncEngine,
session_config: Callable[[AsyncSession], Any],
) -> None:
async with AsyncSession(async_engine) as session:
class Factory(SQLAlchemyFactory[AsyncRefreshModel]):
__async_session__ = session_config(session)
__model__ = AsyncRefreshModel
test_datetime = Ignore()
test_str = Ignore()
test_int = Ignore()
test_bool = Ignore()
instance = await Factory.create_async()
async with AsyncSession(async_engine) as session:
result = await session.scalar(select(AsyncRefreshModel).where(AsyncRefreshModel.id == instance.id))
assert result
assert result.test_datetime is not None
assert isinstance(result.test_datetime, datetime)
assert result.test_str == "test_str"
assert result.test_int == 123
assert result.test_bool is False
def test_alias() -> None:
class ModelWithAlias(Base):
__tablename__ = "table"
id: Any = Column(Integer(), primary_key=True)
name: Any = Column("alias", String(), nullable=False)
class ModelFactory(SQLAlchemyFactory[ModelWithAlias]):
__model__ = ModelWithAlias
result = ModelFactory.build()
assert isinstance(result.name, str)
@pytest.mark.parametrize("python_type_", (UUID, None))
def test_sqlalchemy_custom_type_from_type_decorator(python_type_: type) -> None:
class CustomType(types.TypeDecorator):
impl = types.CHAR(32)
cache_ok = True
if python_type_ is not None:
@property
def python_type(self) -> type:
return python_type_
class Base(metaclass=DeclarativeMeta):
__abstract__ = True
__allow_unmapped__ = True
registry = _registry
metadata = _registry.metadata
class Model(Base):
__tablename__ = f"model_with_custom_types_{python_type_}"
id: Any = Column(Integer(), primary_key=True)
custom_type: Any = Column(type_=CustomType(), nullable=False)
class ModelFactory(SQLAlchemyFactory[Model]):
__model__ = Model
instance = ModelFactory.build()
expected_type = python_type_ if python_type_ is not None else CustomType.impl.python_type
assert isinstance(instance.custom_type, expected_type)
def test_constrained_types() -> None:
_registry = registry()
class Base(metaclass=DeclarativeMeta):
__abstract__ = True
__allow_unmapped__ = True
registry = _registry
metadata = _registry.metadata
class Model(Base):
__tablename__ = "constrained_model"
id: Any = Column(Integer(), primary_key=True)
constrained_string: Any = Column(String(length=1), nullable=False)
constrained_nullable_string: Any = Column(String(length=1), nullable=True)
constrained_number: Any = Column(
Numeric(precision=2, scale=1),
nullable=False,
)
constrained_nullable_number: Any = Column(
Numeric(precision=2, scale=1),
nullable=True,
)
class ModelFactory(SQLAlchemyFactory[Model]):
__model__ = Model
instance = ModelFactory.build()
assert len(instance.constrained_string) <= 1
assert instance.constrained_nullable_string is None or len(instance.constrained_nullable_string) <= 1
constrained_number: Decimal = instance.constrained_number
assert isinstance(constrained_number, Decimal)
assert abs(len(constrained_number.as_tuple().digits) - abs(int(constrained_number.as_tuple().exponent))) <= 2
@pytest.mark.parametrize(
"numeric",
(
Numeric(),
Numeric(precision=4),
Numeric(precision=4, scale=0),
Numeric(precision=4, scale=2),
),
)
def test_numeric_field(numeric: Numeric) -> None:
_registry = registry()
class Base(metaclass=DeclarativeMeta):
__abstract__ = True
__allow_unmapped__ = True
registry = _registry
metadata = _registry.metadata
class NumericModel(Base):
__tablename__ = "numerics"
id: Any = Column(Integer(), primary_key=True)
numeric_field: Any = Column(numeric, nullable=False)
class NumericModelFactory(SQLAlchemyFactory[NumericModel]): ...
result = NumericModelFactory.get_model_fields()[1]
assert result.annotation is Decimal or get_args(result.annotation)[0] is Decimal
if constraints := result.constraints:
assert constraints.get("max_digits") == numeric.precision
assert constraints.get("decimal_places") == numeric.scale
def test_unsupported_type_engine() -> None:
class Location(types.TypeEngine): ...
_registry = registry()
class Base(metaclass=DeclarativeMeta):
__abstract__ = True
__allow_unmapped__ = True
registry = _registry
metadata = _registry.metadata
class Place(Base):
__tablename__ = "numerics"
id: Any = Column(Integer(), primary_key=True)
numeric_field: Any = Column(Location, nullable=False)
factory = SQLAlchemyFactory.create_factory(Place)
with pytest.raises(
ParameterException,
match="Unsupported type engine: Location()",
):
factory.build()
python-polyfactory-2.21.0/tests/sqlalchemy_factory/test_sqlalchemy_factory_v2.py 0000664 0000000 0000000 00000014463 15000423051 0030430 0 ustar 00root root 0000000 0000000 from enum import Enum
from ipaddress import ip_network
from typing import Any, Dict, List
from uuid import UUID
import pytest
from sqlalchemy import ForeignKey, Text, __version__, orm, types
from sqlalchemy.dialects.mssql import JSON as MSSQL_JSON
from sqlalchemy.dialects.mysql import JSON as MYSQL_JSON
from sqlalchemy.dialects.postgresql import ARRAY, CIDR, HSTORE, INET, JSON, JSONB
from sqlalchemy.dialects.sqlite import JSON as SQLITE_JSON
from sqlalchemy.ext.mutable import MutableDict, MutableList
from polyfactory.factories.sqlalchemy_factory import SQLAlchemyFactory
if __version__.startswith("1"):
pytest.importorskip("SQLAlchemy", "2")
class Base(orm.DeclarativeBase): ...
class Author(Base):
__tablename__ = "authors"
id: orm.Mapped[int] = orm.mapped_column(primary_key=True)
books: orm.Mapped[List["Book"]] = orm.relationship(
"Book",
uselist=True,
back_populates="author",
)
class Book(Base):
__tablename__ = "books"
id: orm.Mapped[int] = orm.mapped_column(primary_key=True)
author_id: orm.Mapped[int] = orm.mapped_column(ForeignKey(Author.id))
author: orm.Mapped[Author] = orm.relationship(
Author,
uselist=False,
back_populates="books",
)
def test_python_type_handling_v2() -> None:
class Base(orm.DeclarativeBase): ...
class Animal(str, Enum):
DOG = "Dog"
CAT = "Cat"
class Model(Base):
__tablename__ = "model"
id: orm.Mapped[int] = orm.mapped_column(primary_key=True)
str_type: orm.Mapped[str]
enum_type: orm.Mapped[Animal]
str_array_type: orm.Mapped[List[str]] = orm.mapped_column(
type_=types.ARRAY(types.String),
)
class ModelFactory(SQLAlchemyFactory[Model]):
__model__ = Model
instance = ModelFactory.build()
assert isinstance(instance.id, int)
assert isinstance(instance.str_type, str)
assert isinstance(instance.enum_type, Animal)
assert isinstance(instance.str_array_type, list)
assert isinstance(instance.str_array_type[0], str)
def test_sqla_dialect_types() -> None:
class Base(orm.DeclarativeBase): ...
class SqlaModel(Base):
__tablename__ = "sql_models"
id: orm.Mapped[int] = orm.mapped_column(primary_key=True)
uuid_type: orm.Mapped[UUID] = orm.mapped_column(type_=types.UUID)
nested_array_inet: orm.Mapped[List[str]] = orm.mapped_column(type_=ARRAY(INET, dimensions=1))
nested_array_cidr: orm.Mapped[List[str]] = orm.mapped_column(type_=ARRAY(CIDR, dimensions=1))
hstore_type: orm.Mapped[Dict] = orm.mapped_column(type_=HSTORE)
mut_nested_array_inet: orm.Mapped[List[str]] = orm.mapped_column(
type_=MutableList.as_mutable(ARRAY(INET, dimensions=1))
)
pg_json_type: orm.Mapped[Dict] = orm.mapped_column(type_=JSON)
pg_jsonb_type: orm.Mapped[Dict] = orm.mapped_column(type_=JSONB)
common_json_type: orm.Mapped[Dict] = orm.mapped_column(type_=types.JSON)
mysql_json: orm.Mapped[Dict] = orm.mapped_column(type_=MYSQL_JSON)
sqlite_json: orm.Mapped[Dict] = orm.mapped_column(type_=SQLITE_JSON)
mssql_json: orm.Mapped[Dict] = orm.mapped_column(type_=MSSQL_JSON)
multable_pg_json_type: orm.Mapped[Dict] = orm.mapped_column(
type_=MutableDict.as_mutable(JSON(astext_type=Text()))
)
multable_pg_jsonb_type: orm.Mapped[Dict] = orm.mapped_column(
type_=MutableDict.as_mutable(JSONB(astext_type=Text()))
)
multable_common_json_type: orm.Mapped[Dict] = orm.mapped_column(type_=MutableDict.as_mutable(types.JSON()))
multable_mysql_json: orm.Mapped[Dict] = orm.mapped_column(type_=MutableDict.as_mutable(MYSQL_JSON()))
multable_sqlite_json: orm.Mapped[Dict] = orm.mapped_column(type_=MutableDict.as_mutable(SQLITE_JSON()))
multable_mssql_json: orm.Mapped[Dict] = orm.mapped_column(type_=MutableDict.as_mutable(MSSQL_JSON()))
class ModelFactory(SQLAlchemyFactory[SqlaModel]):
__model__ = SqlaModel
instance = ModelFactory.build()
assert isinstance(instance.nested_array_inet[0], str)
assert ip_network(instance.nested_array_inet[0])
assert isinstance(instance.nested_array_cidr[0], str)
assert ip_network(instance.nested_array_cidr[0])
assert isinstance(instance.hstore_type, dict)
assert isinstance(instance.uuid_type, UUID)
assert isinstance(instance.mut_nested_array_inet[0], str)
assert ip_network(instance.mut_nested_array_inet[0])
assert isinstance(instance.pg_json_type, dict)
for value in instance.pg_json_type.values():
assert isinstance(value, (str, int, bool, float))
assert isinstance(instance.pg_jsonb_type, dict)
for value in instance.pg_jsonb_type.values():
assert isinstance(value, (str, int, bool, float))
assert isinstance(instance.common_json_type, dict)
for value in instance.common_json_type.values():
assert isinstance(value, (str, int, bool, float))
assert isinstance(instance.mysql_json, dict)
for value in instance.mysql_json.values():
assert isinstance(value, (str, int, bool, float))
assert isinstance(instance.sqlite_json, dict)
for value in instance.sqlite_json.values():
assert isinstance(value, (str, int, bool, float))
assert isinstance(instance.mssql_json, dict)
for value in instance.mssql_json.values():
assert isinstance(value, (str, int, bool, float))
assert isinstance(instance.multable_pg_json_type, dict)
assert isinstance(instance.multable_pg_jsonb_type, dict)
assert isinstance(instance.multable_common_json_type, dict)
assert isinstance(instance.multable_mysql_json, dict)
assert isinstance(instance.multable_sqlite_json, dict)
assert isinstance(instance.multable_mssql_json, dict)
@pytest.mark.parametrize(
"type_",
tuple(SQLAlchemyFactory.get_sqlalchemy_types().keys()),
)
def test_sqlalchemy_type_handlers_v2(type_: types.TypeEngine) -> None:
class Base(orm.DeclarativeBase): ...
class Model(Base):
__tablename__ = "model_with_overridden_type"
id: orm.Mapped[int] = orm.mapped_column(primary_key=True)
overridden: orm.Mapped[Any] = orm.mapped_column(type_=type_)
class ModelFactory(SQLAlchemyFactory[Model]):
__model__ = Model
instance = ModelFactory.build()
assert instance.overridden is not None
python-polyfactory-2.21.0/tests/test_attrs_factory.py 0000664 0000000 0000000 00000013717 15000423051 0023124 0 ustar 00root root 0000000 0000000 import datetime as dt
from decimal import Decimal
from enum import Enum
from typing import Any, Dict, Generic, List, Optional, Tuple, TypeVar, Union
from uuid import UUID
import attrs
import pytest
from attrs import asdict, define
from polyfactory.factories.attrs_factory import AttrsFactory
pytestmark = [pytest.mark.attrs]
def test_is_supported_type() -> None:
@define
class Foo: ...
assert AttrsFactory.is_supported_type(Foo) is True
def test_is_supported_type_without_struct() -> None:
class Foo: ...
assert AttrsFactory.is_supported_type(Foo) is False
def test_with_basic_types_annotated() -> None:
class SampleEnum(Enum):
FOO = "foo"
BAR = "bar"
@define
class Foo:
bool_field: bool
int_field: int
float_field: float
str_field: str
bytse_field: bytes
bytearray_field: bytearray
tuple_field: Tuple[int, str]
tuple_with_variadic_args: Tuple[int, ...]
list_field: List[int]
dict_field: Dict[str, int]
datetime_field: dt.datetime
date_field: dt.date
time_field: dt.time
uuid_field: UUID
decimal_field: Decimal
enum_type: SampleEnum
any_type: Any
class FooFactory(AttrsFactory[Foo]):
__model__ = Foo
foo = FooFactory.build()
foo_dict = asdict(foo)
assert foo == Foo(**foo_dict)
def test_with_basic_types_attrs_field() -> None:
@define
class Foo:
bool_field = attrs.field(type=bool) # pyright: ignore
int_field = attrs.field(type=int) # pyright: ignore
float_field = attrs.field(type=float) # pyright: ignore
str_field = attrs.field(type=str) # pyright: ignore
bytes_field = attrs.field(type=bytes) # pyright: ignore
bytearray_field = attrs.field(type=bytearray) # pyright: ignore
tuple_field = attrs.field(type=Tuple[int, str]) # type: ignore
tuple_with_variadic_args = attrs.field(type=Tuple[int, ...]) # type: ignore
list_field = attrs.field(type=List[int]) # pyright: ignore
dict_field = attrs.field(type=Dict[int, str]) # pyright: ignore
datetime_field = attrs.field(type=dt.datetime) # pyright: ignore
date_field = attrs.field(type=dt.date) # pyright: ignore
time_field = attrs.field(type=dt.time) # pyright: ignore
uuid_field = attrs.field(type=UUID) # pyright: ignore
decimal_field = attrs.field(type=Decimal) # pyright: ignore
class FooFactory(AttrsFactory[Foo]):
__model__ = Foo
foo = FooFactory.build()
foo_dict = asdict(foo)
assert foo == Foo(**foo_dict)
def test_with_nested_attr_model() -> None:
@define
class Foo:
int_field: int
@define
class Bar:
int_field: int
foo_field: Foo
class BarFactory(AttrsFactory[Bar]):
__model__ = Bar
bar = BarFactory.build()
bar_dict = asdict(bar, recurse=False)
assert bar == Bar(**bar_dict)
def test_with_private_fields() -> None:
@define
class Foo:
_private: int
class FooFactory(AttrsFactory[Foo]):
__model__ = Foo
foo = FooFactory.build()
assert foo == Foo(foo._private)
def test_with_aliased_fields() -> None:
@define
class Foo:
aliased: int = attrs.field(alias="foo")
class FooFactory(AttrsFactory[Foo]):
__model__ = Foo
foo = FooFactory.build()
assert foo == Foo(foo.aliased)
def test_with_generics() -> None:
T = TypeVar("T")
@define
class Foo(Generic[T]):
x: T
class FooFactory(AttrsFactory[Foo[str]]):
__model__ = Foo
foo = FooFactory.build()
foo_dict = asdict(foo)
assert foo == Foo(**foo_dict)
def test_with_inheritance() -> None:
@define
class Parent:
int_field: int
@define
class Child:
str_field: str
class ChildFactory(AttrsFactory[Child]):
__model__ = Child
child = ChildFactory.build()
child_dict = asdict(child)
assert child == Child(**child_dict)
def test_with_stringified_annotations() -> None:
@define
class Foo:
int_field: "int"
class FooFactory(AttrsFactory[Foo]):
__model__ = Foo
foo = FooFactory.build()
assert isinstance(foo.int_field, int)
def test_with_init_false() -> None:
@define
class Foo:
foo: int = attrs.field(init=False)
class FooFactory(AttrsFactory[Foo]):
__model__ = Foo
assert FooFactory.build()
def test_use_default_with_callable_default() -> None:
@define
class Foo:
default_field: int = attrs.field(default=attrs.Factory(lambda: 10, takes_self=False))
class FooFactory(AttrsFactory[Foo]):
__model__ = Foo
__use_defaults__ = True
foo = FooFactory.build()
assert foo.default_field == 10
def test_use_default_with_non_callable_default() -> None:
@define
class Foo:
default_field: int = attrs.field(default=10)
class FooFactory(AttrsFactory[Foo]):
__model__ = Foo
__use_defaults__ = True
foo = FooFactory.build()
assert foo.default_field == 10
def test_union_types() -> None:
@define
class A:
a: Union[List[str], List[int]]
b: Union[str, List[int]]
c: List[Union[Tuple[int, int], Tuple[str, int]]]
AFactory = AttrsFactory.create_factory(A)
assert AFactory.build()
def test_collection_unions_with_models() -> None:
@define
class A:
a: int
@define
class B:
a: str
@define
class C:
a: Union[List[A], List[B]]
b: List[Union[A, B]]
CFactory = AttrsFactory.create_factory(C)
assert CFactory.build()
@pytest.mark.parametrize("allow_none", (True, False))
def test_optional_type(allow_none: bool) -> None:
@define
class A:
a: Union[str, None]
b: Optional[str]
c: Optional[Union[str, int, List[int]]]
class AFactory(AttrsFactory[A]):
__model__ = A
__allow_none_optionals__ = allow_none
assert AFactory.build()
python-polyfactory-2.21.0/tests/test_auto_registration.py 0000664 0000000 0000000 00000005020 15000423051 0023766 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass as vanilla_dataclass
from typing import List
from typing_extensions import TypedDict
from pydantic import BaseModel
from polyfactory.factories import DataclassFactory, TypedDictFactory
from polyfactory.factories.pydantic_factory import ModelFactory
class A(BaseModel):
a_text: str
class B(BaseModel):
b_text: str
a: A
class C(BaseModel):
b: B
b_list: List[B]
def test_auto_register_model_factory() -> None:
class AFactory(ModelFactory):
a_text = "const value"
__model__ = A
class BFactory(ModelFactory):
b_text = "const value"
__model__ = B
__set_as_default_factory_for_type__ = True
class CFactory(ModelFactory):
__model__ = C
c = CFactory.build()
assert c.b.b_text == BFactory.b_text
assert c.b_list[0].b_text == BFactory.b_text
assert c.b.a.a_text != AFactory.a_text
def test_auto_register_model_factory_using_create_factory() -> None:
const_value = "const value"
ModelFactory.create_factory(model=A, a_text=const_value)
ModelFactory.create_factory(model=B, b_text=const_value, __set_as_default_factory_for_type__=True)
factory = ModelFactory.create_factory(model=C)
c = factory.build()
assert c.b.b_text == const_value
assert c.b_list[0].b_text == const_value
assert c.b.a.a_text != const_value
def test_dataclass_model_factory_auto_registration() -> None:
@vanilla_dataclass
class DataClass:
text: str
class UpperModel(BaseModel):
nested_field: DataClass
nested_list_field: List[DataClass]
class UpperModelFactory(ModelFactory):
__model__ = UpperModel
class DTFactory(DataclassFactory):
text = "const value"
__model__ = DataClass
__set_as_default_factory_for_type__ = True
upper = UpperModelFactory.build()
assert upper.nested_field.text == DTFactory.text
assert upper.nested_list_field[0].text == DTFactory.text
def test_typeddict_model_factory_auto_registration() -> None:
class TD(TypedDict):
text: str
class UpperSchema(BaseModel):
nested_field: TD
nested_list_field: List[TD]
class UpperModelFactory(ModelFactory):
__model__ = UpperSchema
class TDFactory(TypedDictFactory):
text = "const value"
__model__ = TD
__set_as_default_factory_for_type__ = True
upper = UpperModelFactory.build()
assert upper.nested_field["text"] == TDFactory.text
assert upper.nested_list_field[0]["text"] == TDFactory.text
python-polyfactory-2.21.0/tests/test_base_factories.py 0000664 0000000 0000000 00000010672 15000423051 0023206 0 ustar 00root root 0000000 0000000 from abc import ABC, abstractmethod
from dataclasses import dataclass
from typing import Any, Callable, Dict, NewType
import pytest
from typing_extensions import Annotated
from pydantic.main import BaseModel
from polyfactory.exceptions import ParameterException
from polyfactory.factories import DataclassFactory
from polyfactory.factories.base import BaseFactory
from polyfactory.factories.pydantic_factory import ModelFactory
def test_multiple_base_factories() -> None:
class Foo:
def __init__(self, value: str) -> None:
self.value = value
@dataclass
class MyModelWithFoo:
foo: Foo
class FooDataclassFactory(DataclassFactory):
__is_base_factory__ = True
@classmethod
def get_provider_map(cls) -> Dict[Any, Any]:
return {Foo: lambda: Foo("foo"), **super().get_provider_map()}
# noinspection PyUnusedLocal
class DummyDataclassFactory(DataclassFactory):
__is_base_factory__ = True
@dataclass
class MyModel:
nested: MyModelWithFoo
class MyFactory(FooDataclassFactory):
__model__ = MyModel
__base_factory_overrides__ = {MyModelWithFoo: FooDataclassFactory}
MyFactory.build()
@pytest.mark.parametrize("override_BaseModel", [False, True])
def test_multiple_base_pydantic_factories(override_BaseModel: bool) -> None:
class Foo:
def __init__(self, value: str) -> None:
self.value = value
class MyModelWithFoo(BaseModel):
foo: Foo
class Config:
arbitrary_types_allowed = True
class FooModelFactory(ModelFactory):
__is_base_factory__ = True
@classmethod
def get_provider_map(cls) -> Dict[Any, Any]:
return {Foo: lambda: Foo("foo"), **super().get_provider_map()}
# noinspection PyUnusedLocal
class DummyModelFactory(ModelFactory):
__is_base_factory__ = True
class MyModel(BaseModel):
nested: MyModelWithFoo
class MyFactory(FooModelFactory):
__model__ = MyModel
if override_BaseModel:
__base_factory_overrides__ = {BaseModel: FooModelFactory}
else:
__base_factory_overrides__ = {MyModelWithFoo: FooModelFactory}
MyFactory.build()
# XXX: remove the factory classes from _base_factories to prevent side-effects in other tests
# see https://github.com/litestar-org/polyfactory/issues/198
ModelFactory._base_factories.remove(FooModelFactory)
ModelFactory._base_factories.remove(DummyModelFactory)
def test_create_factory_without_model_reuse_current_factory_model() -> None:
@dataclass
class Foo:
pass
factory = DataclassFactory.create_factory(model=Foo)
sub_factory = factory.create_factory()
assert sub_factory.__model__ == Foo
def test_create_factory_from_base_factory_without_providing_a_model_raises_error() -> None:
with pytest.raises(TypeError):
BaseFactory.create_factory()
def test_abstract_classes_are_ignored() -> None:
@dataclass
class Base(ABC):
@abstractmethod
def f(self) -> int: ...
@dataclass
class Concrete(Base):
def f(self) -> int:
return 1
@dataclass
class Model:
single: Base
class ModelFactory(DataclassFactory[Model]):
@classmethod
def get_provider_map(cls) -> Dict[type, Callable[[], Any]]:
return {
**super().get_provider_map(),
Base: Concrete,
}
result = ModelFactory.build()
assert isinstance(result, Model)
assert isinstance(result.single, Concrete)
with pytest.raises(ParameterException, match="Unsupported type: "):
DataclassFactory.create_factory(Model).build()
AnnotatedType = Annotated[str, "foo"]
CustomNewType = NewType("CustomNewType", str)
def test_annotated_types_used_as_provider() -> None:
@dataclass
class Model:
a: AnnotatedType
b: CustomNewType
class Factory(DataclassFactory[Model]):
@classmethod
def get_provider_map(cls) -> Dict[Any, Callable[[], Any]]:
return {
**super().get_provider_map(),
AnnotatedType: lambda: "foo",
CustomNewType: lambda: "bar",
}
result = Factory.build()
assert result.a == "foo"
assert result.b == "bar"
result_coverage = list(Factory.coverage())
assert len(result_coverage) == 1
assert result_coverage[0].a == "foo"
assert result_coverage[0].b == "bar"
python-polyfactory-2.21.0/tests/test_beanie_factory.py 0000664 0000000 0000000 00000003655 15000423051 0023212 0 ustar 00root root 0000000 0000000 from sys import version_info
from typing import List
import pymongo
import pytest
from beanie import Document, Link, init_beanie
from beanie.odm.fields import Indexed, PydanticObjectId
from mongomock_motor import AsyncMongoMockClient
from polyfactory.factories.beanie_odm_factory import BeanieDocumentFactory
@pytest.fixture()
def mongo_connection() -> AsyncMongoMockClient:
return AsyncMongoMockClient()
class MyDocument(Document):
id: PydanticObjectId
name: str
index: Indexed(str, pymongo.DESCENDING) # type: ignore
siblings: List[PydanticObjectId]
class MyOtherDocument(Document):
id: PydanticObjectId
document: Link[MyDocument]
class MyFactory(BeanieDocumentFactory):
__model__ = MyDocument
class MyOtherFactory(BeanieDocumentFactory):
__model__ = MyOtherDocument
@pytest.fixture(autouse=True)
async def beanie_init(mongo_connection: AsyncMongoMockClient) -> None:
await init_beanie(database=mongo_connection.db_name, document_models=[MyDocument, MyOtherDocument])
async def test_handling_of_beanie_types() -> None:
result = MyFactory.build()
assert result.name
assert result.index
assert isinstance(result.index, str)
async def test_beanie_persistence_of_single_instance() -> None:
result = await MyFactory.create_async()
assert result.id
assert result.name
assert result.index
assert isinstance(result.index, str)
async def test_beanie_persistence_of_multiple_instances() -> None:
result = await MyFactory.create_batch_async(size=3)
assert len(result) == 3
for instance in result:
assert instance.id
assert instance.name
assert instance.index
assert isinstance(instance.index, str)
@pytest.mark.skipif(version_info < (3, 11), reason="test isolation issues on lower versions")
async def test_beanie_links() -> None:
result = await MyOtherFactory.create_async()
assert isinstance(result.document, MyDocument)
python-polyfactory-2.21.0/tests/test_build.py 0000664 0000000 0000000 00000004357 15000423051 0021337 0 ustar 00root root 0000000 0000000 from uuid import uuid4
from pydantic import BaseModel
from polyfactory.factories.pydantic_factory import ModelFactory
from tests.models import PersonFactoryWithDefaults, Pet, PetFactory
def test_merges_defaults_with_kwargs() -> None:
first_obj = PersonFactoryWithDefaults.build()
assert first_obj.id == PersonFactoryWithDefaults.id
assert first_obj.name == PersonFactoryWithDefaults.name
assert first_obj.hobbies == PersonFactoryWithDefaults.hobbies
assert first_obj.age == PersonFactoryWithDefaults.age
assert first_obj.pets == PersonFactoryWithDefaults.pets
assert first_obj.birthday == PersonFactoryWithDefaults.birthday
pet = Pet(
name="bluey the blowfish",
species="blowfish",
color="bluish-green",
sound="",
age=1,
)
id_ = uuid4()
hobbies = ["dancing"]
age = 35
pets = [pet]
second_obj = PersonFactoryWithDefaults.build(id=id_, hobbies=hobbies, age=age, pets=pets)
assert second_obj.id == id_
assert second_obj.hobbies == hobbies
assert second_obj.age == age
assert second_obj.pets == [pet]
assert second_obj.name == PersonFactoryWithDefaults.name
assert second_obj.birthday == PersonFactoryWithDefaults.birthday
def test_respects_none_overrides() -> None:
result = PersonFactoryWithDefaults.build(hobbies=None)
assert result.hobbies is None
def test_uses_faker_to_set_values_when_none_available_on_class() -> None:
result = PetFactory.build()
assert isinstance(result.name, str)
assert isinstance(result.species, str)
assert isinstance(result.color, str)
assert isinstance(result.sound, str)
assert isinstance(result.age, float)
def test_builds_batch() -> None:
results = PetFactory.batch(10)
assert isinstance(results, list)
assert len(results) == 10
for result in results:
assert isinstance(result.name, str)
assert isinstance(result.species, str)
assert isinstance(result.color, str)
assert isinstance(result.sound, str)
assert isinstance(result.age, float)
def test_build_model_with_fields_named_like_factory_fields() -> None:
class C(BaseModel):
batch: int
class CFactory(ModelFactory):
__model__ = C
assert CFactory.build()
python-polyfactory-2.21.0/tests/test_collection_extender.py 0000664 0000000 0000000 00000004443 15000423051 0024265 0 ustar 00root root 0000000 0000000 from typing import TYPE_CHECKING, Dict, FrozenSet, List, Set, Tuple
import pytest
from polyfactory.collection_extender import CollectionExtender
if TYPE_CHECKING:
from typing import Any
pytestmark = pytest.mark.parametrize("number_of_args", [0, 1, 3])
def test_tuple_extender(number_of_args: int) -> None:
annotation_alias: Any = Tuple[int, ...]
type_args = (int, ...)
extended_type_args = CollectionExtender.extend_type_args(annotation_alias, type_args, number_of_args)
assert extended_type_args == (int,) * number_of_args
def test_tuple_extender__constant_length(number_of_args: int) -> None:
annotation_alias: Any = Tuple[int, int, int]
type_args = (int, int, int, int)
extended_type_args = CollectionExtender.extend_type_args(annotation_alias, type_args, number_of_args)
assert extended_type_args == (int, int, int, int)
def test_tuple_extender__not_typed(number_of_args: int) -> None:
annotation_alias: Any = Tuple
type_args = ()
extended_type_args = CollectionExtender.extend_type_args(annotation_alias, type_args, number_of_args)
assert extended_type_args == ()
def test_list_extender(number_of_args: int) -> None:
annotation_alias: Any = List[int]
type_args = (int,)
extended_type_args = CollectionExtender.extend_type_args(annotation_alias, type_args, number_of_args)
assert extended_type_args == (int,) * number_of_args
def test_set_extender(number_of_args: int) -> None:
class Dummy: ...
annotation_alias: Any = Set[Dummy]
type_args = (Dummy,)
extended_type_args = CollectionExtender.extend_type_args(annotation_alias, type_args, number_of_args)
assert extended_type_args == (Dummy,) * number_of_args
def test_frozen_set_extender(number_of_args: int) -> None:
class Dummy: ...
annotation_alias: Any = FrozenSet[Dummy]
type_args = (Dummy,)
extended_type_args = CollectionExtender.extend_type_args(annotation_alias, type_args, number_of_args)
assert extended_type_args == (Dummy,) * number_of_args
def test_dict_extender(number_of_args: int) -> None:
annotation_alias: Any = Dict[str, int]
type_args = (str, int)
extended_type_args = CollectionExtender.extend_type_args(annotation_alias, type_args, number_of_args)
assert extended_type_args == (str, int) * number_of_args
python-polyfactory-2.21.0/tests/test_collection_length.py 0000664 0000000 0000000 00000013130 15000423051 0023721 0 ustar 00root root 0000000 0000000 from enum import Enum
from typing import Any, Dict, FrozenSet, List, Literal, Optional, Set, Tuple, get_args
import pytest
from pydantic import BaseModel
from pydantic.dataclasses import dataclass
from polyfactory.factories import DataclassFactory
from polyfactory.factories.pydantic_factory import ModelFactory
MIN_MAX_PARAMETERS = ((10, 15), (20, 25), (30, 40), (40, 50))
@pytest.mark.parametrize("type_", (List, Set))
@pytest.mark.parametrize(("min_val", "max_val"), MIN_MAX_PARAMETERS)
def test_collection_length_with_list(min_val: int, max_val: int, type_: type) -> None:
@dataclass
class Foo:
foo: type_[int] # type: ignore
class FooFactory(DataclassFactory[Foo]):
__model__ = Foo
__randomize_collection_length__ = True
__min_collection_length__ = min_val
__max_collection_length__ = max_val
foo = FooFactory.build()
assert len(foo.foo) >= min_val, len(foo.foo)
assert len(foo.foo) <= max_val, len(foo.foo)
def test_collection_length_with_set_collision() -> None:
@dataclass
class Foo:
foo: Set[int]
provider_int_values_reversed = (list(range(9)) + list(range(7, 15)))[::-1]
class FooFactory(DataclassFactory[Foo]):
__model__ = Foo
__randomize_collection_length__ = True
__min_collection_length__ = 10
__max_collection_length__ = 10
@classmethod
def get_provider_map(cls) -> Dict[Any, Any]:
providers_map = super().get_provider_map()
providers_map[int] = lambda: provider_int_values_reversed.pop()
return providers_map
foo = FooFactory.build()
assert len(foo.foo) >= 10, len(foo.foo)
assert len(foo.foo) <= 15, len(foo.foo)
@pytest.mark.parametrize(("min_val", "max_val"), MIN_MAX_PARAMETERS)
def test_collection_length_with_tuple(min_val: int, max_val: int) -> None:
@dataclass
class Foo:
foo: Tuple[int, ...]
class FooFactory(DataclassFactory[Foo]):
__model__ = Foo
__randomize_collection_length__ = True
__min_collection_length__ = min_val
__max_collection_length__ = max_val
foo = FooFactory.build()
assert len(foo.foo) >= min_val, len(foo.foo)
assert len(foo.foo) <= max_val, len(foo.foo)
@pytest.mark.parametrize(("min_val", "max_val"), MIN_MAX_PARAMETERS)
def test_collection_length_with_dict(min_val: int, max_val: int) -> None:
@dataclass
class Foo:
foo: Dict[int, int]
class FooFactory(DataclassFactory[Foo]):
__model__ = Foo
__randomize_collection_length__ = True
__min_collection_length__ = min_val
__max_collection_length__ = max_val
foo = FooFactory.build()
assert len(foo.foo) >= min_val, len(foo.foo)
assert len(foo.foo) <= max_val, len(foo.foo)
@pytest.mark.parametrize(("min_val", "max_val"), MIN_MAX_PARAMETERS)
def test_collection_length_with_optional_not_allowed(min_val: int, max_val: int) -> None:
@dataclass
class Foo:
foo: Optional[List[int]]
class FooFactory(DataclassFactory[Foo]):
__model__ = Foo
__allow_none_optionals__ = False
__randomize_collection_length__ = True
__min_collection_length__ = min_val
__max_collection_length__ = max_val
foo = FooFactory.build()
assert foo.foo is not None
assert len(foo.foo) >= min_val, len(foo.foo)
assert len(foo.foo) <= max_val, len(foo.foo)
@pytest.mark.parametrize(("min_val", "max_val"), MIN_MAX_PARAMETERS)
def test_collection_length_with_optional_allowed(min_val: int, max_val: int) -> None:
@dataclass
class Foo:
foo: Optional[List[int]]
class FooFactory(DataclassFactory[Foo]):
__model__ = Foo
__randomize_collection_length__ = True
__min_collection_length__ = min_val
__max_collection_length__ = max_val
for _ in range(10):
foo = FooFactory.build()
if foo.foo is None:
continue
assert len(foo.foo) >= min_val, len(foo.foo)
assert len(foo.foo) <= max_val, len(foo.foo)
@pytest.mark.parametrize("type_", (List, FrozenSet, Set))
@pytest.mark.parametrize("min_items", (0, 2, 4))
@pytest.mark.parametrize("max_inc", (0, 1, 4))
def test_collection_length_with_literal(type_: type, min_items: int, max_inc: int) -> None:
max_items = min_items + max_inc
literal_type = Literal["Dog", "Cat", "Monkey"]
@dataclass
class MyModel:
animal_collection: type_[literal_type] # type: ignore
class MyFactory(DataclassFactory):
__model__ = MyModel
__randomize_collection_length__ = True
__min_collection_length__ = min_items
__max_collection_length__ = max_items
result = MyFactory.build()
assert len(result.animal_collection) >= min(min_items, len(get_args(literal_type)))
assert len(result.animal_collection) <= max_items
@pytest.mark.parametrize("type_", (List, FrozenSet, Set))
@pytest.mark.parametrize("min_items", (0, 2, 4))
@pytest.mark.parametrize("max_inc", (0, 1, 4))
def test_collection_length_with_enum(type_: type, min_items: int, max_inc: int) -> None:
max_items = min_items + max_inc
class Animal(str, Enum):
DOG = "Dog"
CAT = "Cat"
MONKEY = "Monkey"
class MyModel(BaseModel):
animal_collection: type_[Animal] # type: ignore
class MyFactory(ModelFactory):
__model__ = MyModel
__randomize_collection_length__ = True
__min_collection_length__ = min_items
__max_collection_length__ = max_items
result = MyFactory.build()
assert len(result.animal_collection) >= min(min_items, len(Animal))
assert len(result.animal_collection) <= max_items
python-polyfactory-2.21.0/tests/test_complex_types.py 0000664 0000000 0000000 00000012510 15000423051 0023121 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from enum import Enum
from typing import (
Any,
Callable,
DefaultDict,
Deque,
Dict,
FrozenSet,
Generic,
Iterable,
List,
Literal,
Optional,
Sequence,
Set,
Tuple,
TypeVar,
Union,
)
import pytest
from pydantic import BaseModel
from polyfactory.exceptions import ParameterException
from polyfactory.factories import DataclassFactory
from polyfactory.factories.pydantic_factory import ModelFactory
from tests.models import Person
def test_handles_complex_typing() -> None:
class MyModel(BaseModel):
nested_dict: Dict[str, Dict[Union[int, str], Dict[Any, List[Dict[str, str]]]]]
dict_str_any: Dict[str, Any]
nested_list: List[List[List[Dict[str, List[Any]]]]]
sequence_literal: Sequence[Literal[1, 2, 3]]
sequence_dict: Sequence[Dict[str, Any]]
iterable_float: Iterable[float]
tuple_ellipsis: Tuple[int, ...]
tuple_str_str: Tuple[str, str]
default_dict: DefaultDict[str, List[Dict[str, int]]]
deque: Deque[List[Dict[str, int]]]
set_union: Set[Union[str, int]]
frozen_set: FrozenSet[str]
plain_list: List[Any]
plain_set: Set[Any]
plain_dict: Dict[str, Any]
class MyFactory(ModelFactory):
__model__ = MyModel
result = MyFactory.build()
assert result.nested_dict
assert result.dict_str_any
assert result.nested_list
assert result.sequence_dict
assert result.iterable_float
assert result.tuple_ellipsis
assert result.tuple_str_str
assert result.default_dict
assert result.deque
assert result.set_union
assert result.frozen_set
assert result.plain_list
assert result.plain_set
assert result.plain_dict
def test_handles_complex_typing_with_embedded_models() -> None:
class MyModel(BaseModel):
person_dict: Dict[str, Person]
person_list: List[Person]
class MyFactory(ModelFactory):
__model__ = MyModel
result = MyFactory.build()
assert result.person_dict
assert result.person_list[0].pets
def test_raises_for_user_defined_types() -> None:
class MyClass:
def __init__(self, value: int) -> None:
self.value = value
class MyModel(BaseModel):
my_class_field: Dict[str, MyClass]
class Config:
arbitrary_types_allowed = True
class MyFactory(ModelFactory):
__model__ = MyModel
with pytest.raises(ParameterException):
MyFactory.build()
def test_randomizes_optional_returns() -> None:
"""this is a flaky test - because it depends on randomness, hence it's been re-ran multiple times."""
class MyModel(BaseModel):
optional_1: Optional[List[str]]
optional_2: Optional[Dict[str, str]]
optional_3: Optional[Set[str]]
optional_4: Optional[Dict[int, str]]
class MyFactory(ModelFactory):
__model__ = MyModel
__random_seed__ = 1
failed = False
for _ in range(5):
try:
result = MyFactory.build()
assert any(
[
not result.optional_1,
not result.optional_2,
not result.optional_3,
not result.optional_4,
],
)
assert any(
[
bool(result.optional_1),
bool(result.optional_2),
bool(result.optional_3),
bool(result.optional_4),
],
)
failed = False
break
except AssertionError:
failed = True
assert not failed
def test_complex_typing_with_enum() -> None:
class Animal(str, Enum):
DOG = "Dog"
CAT = "Cat"
MONKEY = "Monkey"
class MyModel(BaseModel):
animal_list: List[Animal]
class MyFactory(ModelFactory):
__model__ = MyModel
result = MyFactory.build()
assert result.animal_list
def test_union_literal() -> None:
class MyModel(BaseModel):
x: Union[int, Literal["a", "b", "c"]]
class MyFactory(ModelFactory):
__model__ = MyModel
MyFactory.build()
def test_non_collection_generic() -> None:
T = TypeVar("T")
class LoggedVar(Generic[T]):
def __init__(self, name: str = "", log: Callable[[str], None] = print) -> None:
self.__name = name
self.__log = log
def set(self, value: T) -> None:
self.__log(f"Set {self.__name} to {value}")
self.__value = value
def get(self) -> T:
self.__log(f"Get {self.__name} = {self.__value}")
return self.__value
@dataclass
class MyModel:
x: LoggedVar[int]
class MyFactory(DataclassFactory):
__model__ = MyModel
result = MyFactory.build()
assert isinstance(result.x, LoggedVar)
def test_sequence_dict() -> None:
@dataclass
class MyModel:
sequence_dict: Sequence[Dict]
class MyFactory(DataclassFactory):
__model__ = MyModel
result = MyFactory.build()
assert result.sequence_dict
def test_build_with_callable() -> None:
@dataclass
class A:
foo: Callable[[str], int]
factory = DataclassFactory.create_factory(A)
with pytest.raises(ParameterException, match="Unsupported type:"):
factory.build()
python-polyfactory-2.21.0/tests/test_data_parsing.py 0000664 0000000 0000000 00000010072 15000423051 0022663 0 ustar 00root root 0000000 0000000 from datetime import date
from enum import Enum
from typing import Callable, Literal, Optional
import pytest
from pydantic import AmqpDsn, AnyHttpUrl, AnyUrl, BaseConfig, BaseModel, HttpUrl, KafkaDsn, PostgresDsn, RedisDsn
from polyfactory.exceptions import ParameterException
from polyfactory.factories.pydantic_factory import ModelFactory
from tests.models import Person, PersonFactoryWithDefaults, Pet
def test_enum_parsing() -> None:
class MyStrEnum(str, Enum):
FIRST_NAME = "Moishe Zuchmir"
SECOND_NAME = "Hannah Arendt"
class MyIntEnum(Enum):
ONE_HUNDRED = 100
TWO_HUNDRED = 200
class MyModel(BaseModel):
name: MyStrEnum
worth: MyIntEnum
class MyFactory(ModelFactory):
__model__ = MyModel
result = MyFactory.build()
assert isinstance(result.name, MyStrEnum)
assert isinstance(result.worth, MyIntEnum)
def test_callback_parsing() -> None:
today = date.today()
class MyModel(BaseModel):
name: str
birthday: date
secret: Callable
class MyFactory(ModelFactory):
__model__ = MyModel
name = lambda: "moishe zuchmir" # noqa: E731
birthday = lambda: today # noqa: E731
result = MyFactory.build()
assert result.name == "moishe zuchmir"
assert result.birthday == today
assert callable(result.secret)
def test_literal_parsing() -> None:
class MyModel(BaseModel):
literal_field: "Literal['yoyos']"
multi_literal_field: "Literal['nolos', 'zozos', 'kokos']"
class MyFactory(ModelFactory):
__model__ = MyModel
assert MyFactory.build().literal_field == "yoyos"
batch = MyFactory.batch(30)
values = {v.multi_literal_field for v in batch}
assert values == {"nolos", "zozos", "kokos"}
def test_embedded_models_parsing() -> None:
class MyModel(BaseModel):
pet: Pet
class MyFactory(ModelFactory):
__model__ = MyModel
result = MyFactory.build()
assert isinstance(result.pet, Pet)
def test_embedded_factories_parsing() -> None:
class MyModel(BaseModel):
person: Person
class MyFactory(ModelFactory):
__model__ = MyModel
person = PersonFactoryWithDefaults
result = MyFactory.build()
assert isinstance(result.person, Person)
def test_class_parsing() -> None:
class TestClassWithoutKwargs:
def __init__(self) -> None:
self.flag = "123"
class MyModel(BaseModel):
class Config(BaseConfig):
arbitrary_types_allowed = True
class_field: TestClassWithoutKwargs
# just a few select exceptions, to verify this works
exception_field: Exception
type_error_field: TypeError
attribute_error_field: AttributeError
runtime_error_field: RuntimeError
class MyFactory(ModelFactory):
__model__ = MyModel
result = MyFactory.build()
assert isinstance(result.class_field, TestClassWithoutKwargs)
assert result.class_field.flag == "123"
assert isinstance(result.exception_field, Exception)
assert isinstance(result.type_error_field, TypeError)
assert isinstance(result.attribute_error_field, AttributeError)
assert isinstance(result.runtime_error_field, RuntimeError)
class TestClassWithKwargs:
def __init__(self, _: str) -> None:
self.flag = str
class MyNewModel(BaseModel):
class Config(BaseConfig):
arbitrary_types_allowed = True
class_field: TestClassWithKwargs
class MySecondFactory(ModelFactory):
__model__ = MyNewModel
with pytest.raises(ParameterException):
MySecondFactory.build()
@pytest.mark.parametrize(
"type_",
[AnyUrl, HttpUrl, KafkaDsn, PostgresDsn, RedisDsn, AmqpDsn, AnyHttpUrl],
)
def test_optional_url_field_parsed_correctly(type_: type) -> None:
class MyModel(BaseModel):
url: Optional[type_] # type: ignore
class MyFactory(ModelFactory[MyModel]):
__model__ = MyModel
while not (url := MyFactory.build().url):
assert not url
assert MyModel(url=url) # no validation error raised
python-polyfactory-2.21.0/tests/test_dataclass_factory.py 0000664 0000000 0000000 00000017664 15000423051 0023733 0 ustar 00root root 0000000 0000000 import dataclasses
from dataclasses import dataclass as vanilla_dataclass
from dataclasses import field
from types import ModuleType
from typing import Any, Callable, Dict, List, Optional, Tuple, Union
from unittest.mock import ANY
import pytest
from pydantic.dataclasses import dataclass as pydantic_dataclass
from polyfactory.factories import DataclassFactory
from tests.models import Person
def test_factory_vanilla_dc() -> None:
@vanilla_dataclass
class VanillaDC:
id: int
name: str
list_field: List[Dict[str, int]]
field_of_some_value: Optional[int] = field(default_factory=lambda: 0)
class MyFactory(DataclassFactory[VanillaDC]):
__model__ = VanillaDC
result = MyFactory.build()
assert result
assert result.id
assert result.name
assert result.list_field
assert result.list_field[0]
assert [isinstance(value, int) for value in result.list_field[0].values()]
def test_factory_pydantic_dc() -> None:
@pydantic_dataclass
class PydanticDC:
id: int
name: str
list_field: List[Dict[str, int]]
field_of_some_value: Optional[int] = field(default_factory=lambda: 0)
class MyFactory(DataclassFactory[PydanticDC]):
__model__ = PydanticDC
result = MyFactory.build()
assert result
assert result.id
assert result.name
assert result.list_field
assert result.list_field[0]
assert [isinstance(value, int) for value in result.list_field[0].values()]
def test_vanilla_dc_with_embedded_model() -> None:
@vanilla_dataclass
class VanillaDC:
people: List[Person]
class MyFactory(DataclassFactory[VanillaDC]):
__model__ = VanillaDC
result = MyFactory.build()
assert result.people
assert [isinstance(person, Person) for person in result.people]
def test_pydantic_dc_with_embedded_model() -> None:
@vanilla_dataclass
class PydanticDC:
people: List[Person]
class MyFactory(DataclassFactory):
__model__ = PydanticDC
result = MyFactory.build()
assert result.people
assert [isinstance(person, Person) for person in result.people]
def test_model_with_embedded_dataclasses() -> None:
@vanilla_dataclass
class VanillaDC:
people: List[Person]
@vanilla_dataclass
class PydanticDC:
people: List[Person]
@vanilla_dataclass
class Crowd:
west: VanillaDC
east: PydanticDC
class MyFactory(DataclassFactory):
__model__ = Crowd
result = MyFactory.build()
assert result.west
assert result.west.people
assert result.east
assert result.east.people
def test_complex_embedded_dataclass() -> None:
@vanilla_dataclass
class VanillaDC:
people: List[Person]
@vanilla_dataclass
class MyModel:
weirdly_nest_field: List[Dict[str, Dict[str, VanillaDC]]]
class MyFactory(DataclassFactory):
__model__ = MyModel
result = MyFactory.build()
assert result.weirdly_nest_field
assert result.weirdly_nest_field[0]
assert next(iter(result.weirdly_nest_field[0].values())).values()
assert next(iter(next(iter(result.weirdly_nest_field[0].values())).values()))
assert isinstance(next(iter(next(iter(result.weirdly_nest_field[0].values())).values())), VanillaDC)
@pytest.mark.parametrize(
"factory_config, expected_length",
(
({}, 1),
(
{
"__randomize_collection_length__": True,
"__min_collection_length__": 3,
"__max_collection_length__": 3,
},
3,
),
(
{
"__randomize_collection_length__": True,
"__min_collection_length__": 0,
"__max_collection_length__": 0,
},
0,
),
),
)
def test_tuple_in_vanilla_dc(factory_config: Dict[str, Any], expected_length: int) -> None:
@vanilla_dataclass
class VanillaDC:
ids: Tuple[int, ...]
field: Tuple[int, str]
MyFactory = DataclassFactory[VanillaDC].create_factory(VanillaDC, **factory_config)
result = MyFactory.build()
assert result
assert len(result.ids) == expected_length
assert len(result.field) == 2
assert isinstance(result.field[0], int)
assert isinstance(result.field[1], str)
coverage_results = list(MyFactory.coverage())
assert all(len(result.ids) == 1 for result in coverage_results)
assert all(len(result.field) == 2 for result in coverage_results)
assert all(isinstance(result.field[0], int) for result in coverage_results)
assert all(isinstance(result.field[1], str) for result in coverage_results)
def test_dataclass_factory_with_future_annotations(create_module: Callable[[str], ModuleType]) -> None:
module = create_module(
"""
from __future__ import annotations
from dataclasses import dataclass
@dataclass
class example:
foo: str
""",
)
example: type = module.example
assert example.__annotations__ == {"foo": "str"}
class MyFactory(DataclassFactory[example]): # type:ignore[valid-type]
__model__ = example
assert MyFactory.process_kwargs() == {"foo": ANY}
def test_dataclass_with_forward_reference(create_module: Callable[[str], ModuleType]) -> None:
module = create_module(
"""
from __future__ import annotations
from dataclasses import dataclass
from polyfactory.factories import DataclassFactory
@dataclass
class Foo:
bar: Bar
@dataclass
class Bar:
...
""",
)
Foo: type = module.Foo
class FooFactory(DataclassFactory[Foo]): # type:ignore[valid-type]
__model__ = Foo
foo = FooFactory.build()
assert isinstance(foo, Foo)
def test_dataclass_with_init_false() -> None:
@vanilla_dataclass
class VanillaDC:
id_: int = field(init=False)
class MyFactory(DataclassFactory[VanillaDC]):
__model__ = VanillaDC
result = MyFactory.build()
assert result
def test_use_default_with_callable_default() -> None:
@vanilla_dataclass
class Foo:
default_field: int = dataclasses.field(default_factory=lambda: 10)
class FooFactory(DataclassFactory[Foo]):
__model__ = Foo
__use_defaults__ = True
foo = FooFactory.build()
assert foo.default_field == 10
def test_use_default_with_non_callable_default() -> None:
@vanilla_dataclass
class Foo:
default_field: int = 10
class FooFactory(DataclassFactory[Foo]):
__model__ = Foo
__use_defaults__ = True
foo = FooFactory.build()
assert foo.default_field == 10
def test_union_types() -> None:
@vanilla_dataclass
class A:
a: Union[List[str], List[int]]
b: Union[str, List[int]]
c: List[Union[Tuple[int, int], Tuple[str, int]]]
AFactory = DataclassFactory.create_factory(A)
assert AFactory.build()
def test_collection_unions_with_models() -> None:
@vanilla_dataclass
class A:
a: int
@vanilla_dataclass
class B:
a: str
@vanilla_dataclass
class C:
a: Union[List[A], List[B]]
b: List[Union[A, B]]
CFactory = DataclassFactory.create_factory(C)
c = CFactory.build()
assert isinstance(c.a, list)
assert all(isinstance(value, A) for value in c.a) or all(isinstance(value, B) for value in c.a)
assert isinstance(c.b, list)
assert all(isinstance(value, (A, B)) for value in c.b)
@pytest.mark.parametrize("allow_none", (True, False))
def test_optional_type(allow_none: bool) -> None:
@vanilla_dataclass
class A:
a: Union[str, None]
b: Optional[str]
c: Optional[Union[str, int, List[int]]]
class AFactory(DataclassFactory[A]):
__model__ = A
__allow_none_optionals__ = allow_none
a = AFactory.build()
if not allow_none:
assert isinstance(a.a, str)
assert isinstance(a.b, str)
assert isinstance(a.c, (str, int, list))
if isinstance(a.c, list):
assert all(isinstance(value, int) for value in a.c)
python-polyfactory-2.21.0/tests/test_dicts.py 0000664 0000000 0000000 00000002323 15000423051 0021335 0 ustar 00root root 0000000 0000000 from typing import Dict, Union
import pytest
from pydantic import VERSION, BaseModel
from polyfactory.factories.pydantic_factory import ModelFactory
def test_passing_nested_dict() -> None:
class MyMappedClass(BaseModel):
val: str
class MyClass(BaseModel):
my_mapping_obj: Dict[str, MyMappedClass]
my_mapping_str: Dict[str, str]
class MyClassFactory(ModelFactory[MyClass]):
__model__ = MyClass
obj = MyClassFactory.build(
my_mapping_str={"foo": "bar"},
my_mapping_obj={"baz": MyMappedClass(val="bar")},
)
assert obj.dict() == {"my_mapping_obj": {"baz": {"val": "bar"}}, "my_mapping_str": {"foo": "bar"}}
@pytest.mark.skipif(
VERSION.startswith("2"),
reason="indeterminate behaviour in pydantic 2.0",
)
def test_dict_with_union_random_types() -> None:
class MyClass(BaseModel):
val: Dict[str, Union[int, str]]
class MyClassFactory(ModelFactory[MyClass]):
__model__ = MyClass
MyClassFactory.seed_random(10)
test_obj_1 = MyClassFactory.build()
test_obj_2 = MyClassFactory.build()
assert isinstance(next(iter(test_obj_1.val.values())), str)
assert isinstance(next(iter(test_obj_2.val.values())), int)
python-polyfactory-2.21.0/tests/test_factory_configuration.py 0000664 0000000 0000000 00000003273 15000423051 0024632 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from typing import Any, Callable, Dict, List, Type
from typing_extensions import TypeGuard
from polyfactory.factories.base import BaseFactory, T
from polyfactory.factories.dataclass_factory import DataclassFactory
def test_setting_set_as_default_factory_for_type_on_base_factory() -> None:
"""Setting the value to `True` shouldn't raise exception when initializing."""
class CustomBaseFactory(BaseFactory[T]):
__is_base_factory__ = True
__set_as_default_factory_for_type__ = True
@classmethod
def is_supported_type(cls, value: Any) -> TypeGuard[Type[T]]:
# Set this as false since this factory will be injected into the
# list of base factories, but this obviously shouldn't be ran
# for any of the types.
return False
def test_inheriting_config() -> None:
class CustomType:
def __init__(self, a: int) -> None:
self.a = a
@dataclass
class Child:
a: List[int]
custom_type: CustomType
@dataclass
class Parent:
children: List[Child]
class ParentFactory(DataclassFactory[Parent]):
__randomize_collection_length__ = True
__min_collection_length__ = 5
__max_collection_length__ = 5
@classmethod
def get_provider_map(cls) -> Dict[Any, Callable[[], Any]]:
return {
**super().get_provider_map(),
int: lambda: 42,
CustomType: lambda: CustomType(a=5),
}
result = ParentFactory.build()
assert len(result.children) == 5
assert result.children[0].a == [42] * 5
assert result.children[0].custom_type.a == 5
python-polyfactory-2.21.0/tests/test_factory_fields.py 0000664 0000000 0000000 00000014414 15000423051 0023230 0 ustar 00root root 0000000 0000000 import random
from dataclasses import dataclass
from datetime import datetime, timedelta
from typing import Any, ClassVar, List, Optional, Union
import pytest
from pydantic import BaseModel
from polyfactory.decorators import post_generated
from polyfactory.exceptions import ConfigurationException, MissingBuildKwargException
from polyfactory.factories.dataclass_factory import DataclassFactory
from polyfactory.factories.pydantic_factory import ModelFactory
from polyfactory.fields import Ignore, PostGenerated, Require, Use
def test_use() -> None:
class MyClass:
name: str
@classmethod
def builder(cls, name: str) -> "MyClass":
instance = MyClass()
instance.name = name
return instance
default_name = "Moishe Zuchmir"
class MyModel(BaseModel):
my_class: MyClass
class Config:
arbitrary_types_allowed = True
class MyFactory(ModelFactory):
__model__ = MyModel
my_class = Use(fn=MyClass.builder, name=default_name)
result = MyFactory.build()
assert result.my_class.name == default_name
def test_sub_factory() -> None:
default_name = "Moishe Zuchmir"
class FirstModel(BaseModel):
name: str
class SecondModel(BaseModel):
first_model: FirstModel
class MyFactory(ModelFactory):
__model__ = SecondModel
first_model = Use(fn=ModelFactory.create_factory(FirstModel).build, name=default_name)
result = MyFactory.build()
assert result.first_model.name == default_name
def test_build_kwarg() -> None:
class MyModel(BaseModel):
name: str
class MyFactory(ModelFactory):
__model__ = MyModel
name = Require()
with pytest.raises(MissingBuildKwargException):
MyFactory.build()
assert MyFactory.build(name="moishe").name == "moishe"
def test_ignored() -> None:
class MyModel(BaseModel):
name: Optional[str] = None
class MyFactory(ModelFactory):
__model__ = MyModel
name = Ignore()
assert MyFactory.build().name is None
def test_post_generation() -> None:
random_delta = timedelta(days=random.randint(0, 12), seconds=random.randint(13, 13000))
def add_timedelta(name: str, values: Any, **kwargs: Any) -> datetime:
assert name == "to_dt"
assert "from_dt" in values
assert isinstance(values["from_dt"], datetime)
return values["from_dt"] + random_delta
def decide_long(name: str, values: Any, **kwargs: Any) -> bool:
assert name == "is_long"
assert "from_dt" in values
assert "to_dt" in values
assert "threshold" in kwargs
assert isinstance(values["from_dt"], datetime)
assert isinstance(values["to_dt"], datetime)
difference = values["to_dt"] - values["from_dt"]
return difference.days > kwargs["threshold"] # type: ignore
def make_caption(name: str, values: Any, **kwargs: Any) -> str:
assert name == "caption"
assert "is_long" in values
return "this was really long for me" if values["is_long"] else "just this"
class MyModel(BaseModel):
from_dt: datetime
to_dt: datetime
is_long: bool
caption: str
class MyFactory(ModelFactory):
__model__ = MyModel
to_dt = PostGenerated(add_timedelta)
is_long = PostGenerated(decide_long, threshold=1)
caption = PostGenerated(make_caption)
result = MyFactory.build()
assert result.to_dt - result.from_dt == random_delta
assert result.is_long == (random_delta.days > 1)
if result.is_long:
assert result.caption == "this was really long for me"
else:
assert result.caption == "just this"
def test_post_generation_classmethod() -> None:
class MyModel(BaseModel):
from_dt: datetime
to_dt: datetime
is_long: bool
caption: str
class MyFactory(ModelFactory):
__model__ = MyModel
random_delta: timedelta
@post_generated
@classmethod
def to_dt(cls, from_dt: datetime) -> datetime:
# save it to cls for test purposes only
cls.random_delta = timedelta(days=cls.__random__.randint(0, 12), seconds=cls.__random__.randint(13, 13000))
return from_dt + cls.random_delta
@post_generated
@classmethod
def is_long(cls, from_dt: datetime, to_dt: datetime) -> bool:
return (to_dt - from_dt).days > 1
@post_generated
@classmethod
def caption(cls, is_long: bool) -> str:
return "this was really long for me" if is_long else "just this"
result = MyFactory.build()
assert result.to_dt - result.from_dt == MyFactory.random_delta
assert result.is_long == (MyFactory.random_delta.days > 1)
if result.is_long:
assert result.caption == "this was really long for me"
else:
assert result.caption == "just this"
@pytest.mark.parametrize(
"factory_field",
[
Use(lambda: "foo"),
PostGenerated(lambda: "foo"),
Require(),
Ignore(),
],
)
def test_non_existing_model_fields_does_not_raise_by_default(
factory_field: Union[Use, PostGenerated, Require, Ignore],
) -> None:
class NoFieldModel(BaseModel):
pass
ModelFactory.create_factory(NoFieldModel, bases=None, unknown_field=factory_field)
@pytest.mark.parametrize(
"factory_field",
[
Use(lambda: "foo"),
PostGenerated(lambda: "foo"),
Require(),
Ignore(),
],
)
def test_non_existing_model_fields_raises_with__check__model__(
factory_field: Union[Use, PostGenerated, Require, Ignore],
) -> None:
class NoFieldModel(BaseModel):
pass
with pytest.raises(
ConfigurationException,
match="unknown_field is declared on the factory NoFieldModelFactory but it is not part of the model NoFieldModel",
):
ModelFactory.create_factory(NoFieldModel, bases=None, __check_model__=True, unknown_field=factory_field)
def test_mutable_defaults() -> None:
@dataclass
class A:
a: List[str]
class AFactory(DataclassFactory[A]):
a: ClassVar[List[str]] = []
AFactory.build().a.append("a")
assert AFactory.build().a == []
next(iter(AFactory.coverage())).a.append("value")
assert next(iter(AFactory.coverage())).a == []
python-polyfactory-2.21.0/tests/test_factory_subclassing.py 0000664 0000000 0000000 00000004127 15000423051 0024277 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
import pytest
from pydantic import BaseModel
from polyfactory import ConfigurationException
from polyfactory.factories import DataclassFactory
from polyfactory.factories.pydantic_factory import ModelFactory
from polyfactory.field_meta import Null
def test_factory_raises_config_error_for_unsupported_model_with_supported_factory() -> None:
@dataclass
class DataclassModel:
id: int
with pytest.raises(ConfigurationException):
class MyFactory1(ModelFactory):
__model__ = DataclassModel
class MyFactory2(DataclassFactory):
__model__ = DataclassModel
def test_factory_raises_config_error_for_unsupported_model() -> None:
with pytest.raises(ConfigurationException, match="Model type Null is not supported"):
class MyFactory(ModelFactory):
__model__ = Null
def test_inherit_concrete_factory() -> None:
class Parent(BaseModel):
name: str
class Child(Parent):
n: int
class ParentFactory(ModelFactory):
__model__ = Parent
@classmethod
def name(cls) -> str:
return cls.__model__.__name__
class ChildFactory(ParentFactory):
__model__ = Child # type: ignore[assignment]
assert ParentFactory.build().name == "Parent"
assert ChildFactory.build().name == "Child"
def test_inherit_base_factory() -> None:
class Parent(BaseModel):
name: str
class Child(Parent):
n: int
class ParentFactory(ModelFactory):
__is_base_factory__ = True
@classmethod
def name(cls) -> str:
return cls.__model__.__name__
class ChildFactory(ParentFactory):
__model__ = Child
exc_info = pytest.raises(AttributeError, ParentFactory.build)
assert "'ParentFactory' has no attribute '__model__'" in str(exc_info.value)
assert ChildFactory.build().name == "Child"
# remove the ParentFactory from _base_factories to prevent side effects in other tests
# see https://github.com/litestar-org/polyfactory/issues/198
ModelFactory._base_factories.remove(ParentFactory)
python-polyfactory-2.21.0/tests/test_faker_customization.py 0000664 0000000 0000000 00000000612 15000423051 0024306 0 ustar 00root root 0000000 0000000 from faker import Faker
from polyfactory.factories.pydantic_factory import ModelFactory
from tests.models import Pet
def test_allows_user_to_define_faker_instance() -> None:
my_faker = Faker()
setattr(my_faker, "__test__attr__", None)
class MyFactory(ModelFactory):
__model__ = Pet
__faker__ = my_faker
assert hasattr(MyFactory.__faker__, "__test__attr__")
python-polyfactory-2.21.0/tests/test_generics.py 0000664 0000000 0000000 00000004060 15000423051 0022026 0 ustar 00root root 0000000 0000000 from typing import Generic, List, Optional, TypeVar, Union
from pydantic import BaseModel
from polyfactory.factories.pydantic_factory import ModelFactory
try:
from pydantic.generics import GenericModel
except ImportError:
GenericModel = BaseModel
Inner = TypeVar("Inner")
APIResponseData = TypeVar("APIResponseData")
class Attributes(GenericModel, Generic[Inner]): # type: ignore
attributes: Inner
class OneInner(BaseModel):
one: str
id: Optional[int]
description: Optional[str]
class OneResponse(BaseModel):
one: Attributes[OneInner]
class TwoInner(BaseModel):
two: str
id: Optional[int]
description: Optional[str]
class TwoResponse(BaseModel):
two: Attributes[TwoInner]
class ThreeInner(BaseModel):
three: str
relation: int
class ThreeResponse(BaseModel):
three: Attributes[ThreeInner]
class APIResponse(GenericModel, Generic[APIResponseData]): # type: ignore
data: List[APIResponseData]
def test_generic_factory_one_response() -> None:
class APIResponseFactory(ModelFactory[APIResponse[OneResponse]]):
__model__ = APIResponse[OneResponse]
result = APIResponseFactory.build()
assert result.data
assert isinstance(result.data[0], OneResponse)
def test_generic_factory_two_response() -> None:
class APIResponseFactory(ModelFactory):
__model__ = APIResponse[TwoResponse]
result = APIResponseFactory.build()
assert result.data
assert isinstance(result.data[0], TwoResponse)
def test_generic_factory_three_response() -> None:
class APIResponseFactory(ModelFactory):
__model__ = APIResponse[ThreeResponse]
result = APIResponseFactory.build()
assert result.data
assert isinstance(result.data[0], ThreeResponse)
def test_generic_factory_union_response() -> None:
class APIResponseFactory(ModelFactory):
__model__ = APIResponse[Union[OneResponse, TwoResponse, ThreeResponse]]
result = APIResponseFactory.build()
assert result.data
assert isinstance(result.data[0], (OneResponse, TwoResponse, ThreeResponse))
python-polyfactory-2.21.0/tests/test_msgspec_factory.py 0000664 0000000 0000000 00000022736 15000423051 0023431 0 ustar 00root root 0000000 0000000 import datetime as dt
import sys
from decimal import Decimal
from enum import Enum
from typing import Any, Dict, FrozenSet, Generic, List, NewType, Optional, Set, Tuple, Type, TypeVar, Union
from uuid import UUID
import msgspec
import pytest
from msgspec import Meta, Struct, structs
from typing_extensions import Annotated
from polyfactory.exceptions import ParameterException
from polyfactory.factories.msgspec_factory import MsgspecFactory
def test_is_supported_type() -> None:
class Foo(Struct): ...
assert MsgspecFactory.is_supported_type(Foo) is True
def test_is_supported_type_without_struct() -> None:
class Foo: ...
assert MsgspecFactory.is_supported_type(Foo) is False
def test_with_basic_types_without_constraints() -> None:
class Foo(Struct):
bool_field: bool
int_field: int
float_field: float
str_field: str
bytse_field: bytes
bytearray_field: bytearray
tuple_field: Tuple[int, str]
tuple_with_variadic_args: Tuple[int, ...]
list_field: List[int]
dict_field: Dict[str, int]
datetime_field: dt.datetime
date_field: dt.date
time_field: dt.time
uuid_field: UUID
decimal_field: Decimal
any_type: Any
class FooFactory(MsgspecFactory[Foo]):
__model__ = Foo
foo = FooFactory.build()
foo_dict = structs.asdict(foo)
validated_foo = msgspec.convert(foo_dict, type=Foo)
assert foo == validated_foo
def test_other_basic_types() -> None:
# These types are tested separately since they can't be validated
# using `convert`.
# REFERENCE: https://github.com/jcrist/msgspec/issues/417
class SampleEnum(Enum):
FOO = "foo"
BAR = "bar"
class Foo(Struct):
set_field: Set[int]
frozenset_field: FrozenSet[int]
enum_type: SampleEnum
class FooFactory(MsgspecFactory[Foo]):
__model__ = Foo
foo = FooFactory.build()
assert isinstance(foo.set_field, set)
assert isinstance(foo.frozenset_field, frozenset)
assert isinstance(foo.enum_type, SampleEnum)
def test_with_nested_struct() -> None:
class Foo(Struct):
int_field: int
class Bar(Struct):
int_field: int
foo_field: Foo
class BarFactory(MsgspecFactory[Bar]):
__model__ = Bar
bar = BarFactory.build()
bar_dict = structs.asdict(bar)
bar_dict["foo_field"] = structs.asdict(bar_dict["foo_field"])
validated_bar = msgspec.convert(bar_dict, type=Bar)
assert validated_bar == bar
def test_with_new_type() -> None:
UnixName = NewType("UnixName", str)
class User(Struct):
name: UnixName
groups: List[UnixName]
constrained_name: Annotated[UnixName, Meta(min_length=20)]
class UserFactory(MsgspecFactory[User]):
__model__ = User
user = UserFactory.build()
user_dict = structs.asdict(user)
validated_user = msgspec.convert(user_dict, type=User)
assert user == validated_user
def test_msgspec_types() -> None:
class Foo(Struct):
unset: msgspec.UnsetType
ext: msgspec.msgpack.Ext
raw: msgspec.Raw
class FooFactory(MsgspecFactory[Foo]):
__model__ = Foo
foo = FooFactory.build()
assert foo.unset == msgspec.UNSET
assert isinstance(foo.ext, msgspec.msgpack.Ext)
@pytest.mark.skipif(sys.version_info < (3, 9), reason="flaky in 3.8")
def test_with_constraints() -> None:
class Foo(Struct):
int_field: Annotated[int, msgspec.Meta(ge=10, le=500, multiple_of=2)]
float_field: Annotated[float, msgspec.Meta(ge=10, le=500, multiple_of=2)]
str_field: Annotated[str, msgspec.Meta(min_length=100, max_length=500, pattern=r"\w")]
bytes_field: Annotated[bytes, msgspec.Meta(min_length=100, max_length=500)]
tuple_field: Annotated[Tuple[int, ...], msgspec.Meta(min_length=10, max_length=100)]
list_field: Annotated[List[int], msgspec.Meta(min_length=10, max_length=100)]
class FooFactory(MsgspecFactory[Foo]):
__model__ = Foo
foo = FooFactory.build()
foo_dict = structs.asdict(foo)
validated_foo = msgspec.convert(foo_dict, type=Foo)
assert foo == validated_foo
@pytest.mark.skipif(sys.version_info < (3, 9), reason="flaky in 3.8")
def test_dict_constraints() -> None:
class Foo(Struct):
dict_field: Annotated[Dict[str, int], msgspec.Meta(min_length=1)]
class FooFactory(MsgspecFactory[Foo]):
__model__ = Foo
foo = FooFactory.build()
foo_dict = structs.asdict(foo)
validated_foo = msgspec.convert(foo_dict, type=Foo)
assert foo == validated_foo
@pytest.mark.skipif(sys.version_info < (3, 9), reason="flaky in 3.8")
@pytest.mark.parametrize("t", (dt.datetime, dt.time))
def test_datetime_constraints(t: Union[Type[dt.datetime], Type[dt.time]]) -> None:
class Foo(Struct):
date_field: Annotated[t, msgspec.Meta(tz=True)] # type: ignore[valid-type]
class FooFactory(MsgspecFactory[Foo]):
__model__ = Foo
with pytest.raises(ParameterException):
_ = FooFactory.build()
def test_inheritance() -> None:
class Foo(Struct):
int_field: int
class Bar(Foo):
pass
class BarFactory(MsgspecFactory[Bar]):
__model__ = Bar
bar = BarFactory.build()
bar_dict = structs.asdict(bar)
validated_bar = msgspec.convert(bar_dict, type=Bar)
assert validated_bar == bar
def test_inheritance_with_generics() -> None:
T = TypeVar("T")
class Foo(Struct, Generic[T]):
int_field: int
generic_field: T
class Bar(Foo[str]):
pass
class BarFactory(MsgspecFactory[Bar]):
__model__ = Bar
bar = BarFactory.build()
bar_dict = structs.asdict(bar)
validated_bar = msgspec.convert(bar_dict, type=Bar)
assert validated_bar == bar
def test_sequence_with_constrained_item_types() -> None:
ConstrainedInt = Annotated[int, Meta(ge=100, le=200)]
class Foo(Struct):
list_field: List[ConstrainedInt]
tuple_field: Tuple[ConstrainedInt]
variable_tuple_field: Tuple[ConstrainedInt, ...]
set_field: Set[ConstrainedInt]
class FooFactory(MsgspecFactory[Foo]):
__model__ = Foo
foo = FooFactory.build()
validated_foo = msgspec.convert(structs.asdict(foo), Foo)
assert validated_foo == foo
def test_mapping_with_constrained_item_types() -> None:
ConstrainedInt = Annotated[int, Meta(ge=100, le=200)]
ConstrainedStr = Annotated[str, Meta(min_length=1, max_length=3)]
class Foo(Struct):
dict_field = Dict[ConstrainedStr, ConstrainedInt]
class FooFactory(MsgspecFactory[Foo]):
__model__ = Foo
foo = FooFactory.build()
validated_foo = msgspec.convert(structs.asdict(foo), Foo)
assert validated_foo == foo
def test_use_default_with_callable_default() -> None:
class Foo(Struct):
default_field: int = msgspec.field(default_factory=lambda: 10)
class FooFactory(MsgspecFactory[Foo]):
__model__ = Foo
__use_defaults__ = True
foo = FooFactory.build()
assert foo.default_field == 10
def test_use_default_with_non_callable_default() -> None:
class Foo(Struct):
default_field: int = 10
class FooFactory(MsgspecFactory[Foo]):
__model__ = Foo
__use_defaults__ = True
foo = FooFactory.build()
assert foo.default_field == 10
def test_union_types() -> None:
class A(Struct):
a: Union[List[str], int]
b: Union[str, List[int]]
c: List[Union[Tuple[int, int], float]]
AFactory = MsgspecFactory.create_factory(A)
a = AFactory.build()
assert msgspec.convert(structs.asdict(a), A) == a
def test_collection_unions_with_models() -> None:
class A(Struct):
a: int
class B(Struct):
a: str
class C(Struct):
a: Union[List[A], str]
b: List[Union[A, int]]
CFactory = MsgspecFactory.create_factory(C)
c = CFactory.build()
assert msgspec.convert(structs.asdict(c), C) == c
def test_constrained_union_types() -> None:
class A(Struct):
a: Union[Annotated[List[str], Meta(min_length=10)], Annotated[int, Meta(ge=1000)]]
b: Union[List[Annotated[str, Meta(min_length=20)]], int]
c: Optional[Annotated[int, Meta(ge=1000)]]
d: Union[Annotated[List[int], Meta(min_length=100)], Annotated[str, Meta(min_length=100)]]
e: Optional[Union[Annotated[List[int], Meta(min_length=100)], Annotated[str, Meta(min_length=100)]]]
f: Optional[Union[Annotated[List[int], Meta(min_length=100)], str]]
AFactory = MsgspecFactory.create_factory(A, __allow_none_optionals__=False)
a = AFactory.build()
assert msgspec.convert(structs.asdict(a), A) == a
@pytest.mark.parametrize("allow_none", (True, False))
def test_optional_type(allow_none: bool) -> None:
class A(Struct):
a: Union[str, None]
b: Optional[str]
c: Optional[Union[str, int, List[int]]]
class AFactory(MsgspecFactory[A]):
__model__ = A
__allow_none_optionals__ = allow_none
a = AFactory.build()
assert msgspec.convert(structs.asdict(a), A) == a
def test_annotated_children() -> None:
class A(Struct):
a: Dict[int, Annotated[str, Meta(min_length=20)]]
b: List[Annotated[int, Meta(gt=1000)]]
c: Annotated[List[Annotated[int, Meta(gt=1000)]], Meta(min_length=50)]
d: Dict[int, Annotated[List[Annotated[str, Meta(min_length=1)]], Meta(min_length=1)]]
class AFactory(MsgspecFactory[A]):
__model__ = A
a = AFactory.build()
assert msgspec.convert(structs.asdict(a), A) == a
python-polyfactory-2.21.0/tests/test_new_types.py 0000664 0000000 0000000 00000012661 15000423051 0022252 0 ustar 00root root 0000000 0000000 import sys
from datetime import date
from decimal import Decimal
from types import ModuleType
from typing import Any, Callable, Dict, List, NewType, Optional, Tuple, Union
import pytest
from pydantic import (
VERSION,
BaseModel,
PositiveFloat,
conbytes,
condate,
condecimal,
confloat,
confrozenset,
conint,
conlist,
conset,
constr,
)
from polyfactory.factories.dataclass_factory import DataclassFactory
from polyfactory.factories.pydantic_factory import ModelFactory
def test_new_types() -> None:
MyInt = NewType("MyInt", int)
WrappedInt = NewType("WrappedInt", MyInt)
class MyModel(BaseModel):
int_field: MyInt
wrapped_int_field: WrappedInt
class MyModelFactory(ModelFactory):
__model__ = MyModel
result = MyModelFactory.build()
assert isinstance(result.int_field, int)
assert isinstance(result.wrapped_int_field, int)
def test_complex_new_types() -> None:
MyStr = NewType("MyStr", str)
MyInt = NewType("MyInt", int)
class NestedModel(BaseModel):
nested_int_field: MyInt
MyNestedModel = NewType("MyNestedModel", NestedModel)
class MyModel(BaseModel):
list_int_field: List[MyInt]
union_field: Union[MyInt, MyStr]
optional_str_field: Optional[MyStr]
tuple_str_str: Tuple[MyStr, MyStr]
dict_field: Dict[MyStr, Any]
complex_dict_field: Dict[MyStr, Dict[Union[MyInt, MyStr], MyInt]]
nested_model_field: MyNestedModel
class MyModelFactory(ModelFactory):
__model__ = MyModel
result = MyModelFactory.build()
assert isinstance(result.list_int_field[0], int)
assert isinstance(result.union_field, (int, str))
assert result.optional_str_field is None or isinstance(result.optional_str_field, str)
assert isinstance(result.tuple_str_str, tuple)
assert isinstance(result.dict_field, dict)
assert isinstance(result.nested_model_field, NestedModel)
assert isinstance(result.nested_model_field.nested_int_field, int)
@pytest.mark.skipif(VERSION.startswith("2"), reason="https://github.com/pydantic/pydantic/issues/5907")
def test_constrained_new_types() -> None:
ConBytes = NewType("ConBytes", conbytes(min_length=2, max_length=4)) # type: ignore[misc]
ConStr = NewType("ConStr", constr(min_length=10, max_length=15)) # type: ignore[misc]
ConInt = NewType("ConInt", conint(gt=100, lt=110)) # type: ignore[misc]
ConFloat = NewType("ConFloat", confloat(lt=-100)) # type: ignore[misc]
ConDecimal = NewType("ConDecimal", condecimal(ge=Decimal(6), le=Decimal(8))) # type: ignore[misc]
ConDate = NewType("ConDate", condate(gt=date.today())) # type: ignore[misc]
ConMyPositiveFloat = NewType("ConMyPositiveFloat", PositiveFloat)
if VERSION.startswith("1"):
ConList = NewType("ConList", conlist(item_type=int, min_items=3)) # type: ignore
ConSet = NewType("ConSet", conset(item_type=int, min_items=4)) # type: ignore
ConFrozenSet = NewType("ConFrozenSet", confrozenset(item_type=str, min_items=5)) # type: ignore
else:
ConList = NewType("ConList", conlist(item_type=int, min_length=3)) # type: ignore
ConSet = NewType("ConSet", conset(item_type=int, min_length=4)) # type: ignore
ConFrozenSet = NewType("ConFrozenSet", confrozenset(item_type=str, min_length=5)) # type: ignore
class ConstrainedModel(BaseModel):
conbytes_field: ConBytes
constr_field: ConStr
conint_field: ConInt
confloat_field: ConFloat
condecimal_field: ConDecimal
condate_field: ConDate
conlist_field: ConList
conset_field: ConSet
confrozenset_field: ConFrozenSet
conpositive_float_field: ConMyPositiveFloat
class MyFactory(ModelFactory):
__model__ = ConstrainedModel
result = MyFactory.build()
# we want to make sure that NewType is correctly unwrapped retaining
# original type and its attributes. More elaborate testing of constrained
# fields is done in tests/constraints/
assert isinstance(result.conbytes_field, bytes)
assert 2 <= len(result.conbytes_field) <= 4
assert isinstance(result.constr_field, str)
assert 10 <= len(result.constr_field) <= 15
assert isinstance(result.conint_field, int)
assert 100 < result.conint_field < 110
assert isinstance(result.confloat_field, float)
assert result.confloat_field < -100
assert isinstance(result.condecimal_field, Decimal)
assert Decimal(6) <= result.condecimal_field <= Decimal(8)
assert isinstance(result.condate_field, date)
assert result.condate_field > date.today()
assert isinstance(result.conlist_field, list)
assert len(result.conlist_field) >= 3
assert isinstance(result.conset_field, set)
assert len(result.conset_field) >= 4
assert isinstance(result.confrozenset_field, frozenset)
assert len(result.confrozenset_field) >= 5
assert isinstance(result.conpositive_float_field, float)
assert result.conpositive_float_field > 0
@pytest.mark.skipif(sys.version_info < (3, 12), reason="3.12 only syntax")
def test_type_alias(create_module: Callable[[str], ModuleType]) -> None:
module = create_module(
"""
from typing import Literal
from dataclasses import dataclass
type LiteralAlias = Literal["a", "b"]
@dataclass
class A:
field: LiteralAlias
""",
)
factory = DataclassFactory.create_factory(module.A)
result = factory.build()
assert result.field in {"a", "b"}
python-polyfactory-2.21.0/tests/test_number_generation.py 0000664 0000000 0000000 00000002637 15000423051 0023742 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from random import Random
import pytest
from polyfactory.value_generators.constrained_numbers import (
generate_constrained_number,
passes_pydantic_multiple_validator,
)
from polyfactory.value_generators.primitives import create_random_float
@pytest.mark.parametrize(
("maximum", "minimum", "multiple_of"),
((100, 2, 8), (-100, -187, -10), (7.55, 0.13, 0.0123)),
)
def test_generate_constrained_number(maximum: float, minimum: float, multiple_of: float) -> None:
assert passes_pydantic_multiple_validator(
multiple_of=multiple_of,
value=generate_constrained_number(
random=Random(),
minimum=minimum,
maximum=maximum,
multiple_of=multiple_of,
method=create_random_float,
),
)
@pytest.mark.parametrize(
"minimum, maximum",
(
(None, None),
(-200, None),
(200, None),
(None, -200),
(None, 200),
(-200, 200),
),
)
def test_create_random_float_bounds(
minimum: float | None,
maximum: float | None,
) -> None:
result = create_random_float(Random(), minimum, maximum)
if minimum is not None:
assert result >= minimum
if maximum is not None:
assert result <= maximum
def test_passes_pydantic_multiple_validator_handles_zero_multiplier() -> None:
assert passes_pydantic_multiple_validator(1.0, 0)
python-polyfactory-2.21.0/tests/test_odmantic_factory.py 0000664 0000000 0000000 00000006320 15000423051 0023555 0 ustar 00root root 0000000 0000000 from datetime import datetime
from typing import Any, List
from uuid import UUID
import bson
import pytest
from bson import ObjectId
import pydantic
if not pydantic.VERSION.startswith("1"):
pytest.skip("only for pydantic v1", allow_module_level=True)
from odmantic import AIOEngine, EmbeddedModel, Model
from polyfactory.decorators import post_generated
from polyfactory.factories.odmantic_odm_factory import OdmanticModelFactory
class OtherEmbeddedDocument(EmbeddedModel): # type: ignore
name: str
serial: UUID
created_on: datetime
bson_id: bson.ObjectId
bson_int64: bson.Int64
bson_dec128: bson.Decimal128
bson_binary: bson.Binary
class MyEmbeddedDocument(EmbeddedModel): # type: ignore
name: str
serial: UUID
other_embedded_document: OtherEmbeddedDocument
created_on: datetime
bson_id: bson.ObjectId
bson_int64: bson.Int64
bson_dec128: bson.Decimal128
bson_binary: bson.Binary
class MyModel(Model): # type: ignore
created_on: datetime
bson_id: bson.ObjectId
bson_int64: bson.Int64
bson_dec128: bson.Decimal128
bson_binary: bson.Binary
name: str
embedded: MyEmbeddedDocument
embedded_list: List[MyEmbeddedDocument]
@pytest.fixture()
async def odmantic_engine(mongo_connection: Any) -> AIOEngine:
return AIOEngine(client=mongo_connection, database=mongo_connection.db_name)
def test_handles_odmantic_models() -> None:
class MyFactory(OdmanticModelFactory):
__model__ = MyModel
result = MyFactory.build()
assert isinstance(result, MyModel)
assert isinstance(result.id, bson.ObjectId)
assert isinstance(result.created_on, datetime)
assert isinstance(result.bson_id, bson.ObjectId)
assert isinstance(result.bson_int64, bson.Int64)
assert isinstance(result.bson_dec128, bson.Decimal128)
assert isinstance(result.bson_binary, bson.Binary)
assert isinstance(result.name, str)
assert isinstance(result.embedded, MyEmbeddedDocument)
assert isinstance(result.embedded_list, list)
for item in result.embedded_list:
assert isinstance(item, MyEmbeddedDocument)
assert isinstance(item.name, str)
assert isinstance(item.serial, UUID)
assert isinstance(item.created_on, datetime)
assert isinstance(item.bson_id, bson.ObjectId)
assert isinstance(item.bson_int64, bson.Int64)
assert isinstance(item.bson_dec128, bson.Decimal128)
assert isinstance(item.bson_binary, bson.Binary)
other = item.other_embedded_document
assert isinstance(other, OtherEmbeddedDocument)
assert isinstance(other.name, str)
assert isinstance(other.serial, UUID)
assert isinstance(other.created_on, datetime)
assert isinstance(other.bson_id, bson.ObjectId)
assert isinstance(other.bson_int64, bson.Int64)
assert isinstance(other.bson_dec128, bson.Decimal128)
assert isinstance(other.bson_binary, bson.Binary)
def test_post_generated_from_id() -> None:
class MyFactory(OdmanticModelFactory):
__model__ = MyModel
@post_generated
@classmethod
def name(cls, id: ObjectId) -> str:
return f"{cls.__faker__.name()} [{id.generation_time}]"
MyFactory.build()
python-polyfactory-2.21.0/tests/test_optional_model_field_inference.py 0000664 0000000 0000000 00000007632 15000423051 0026425 0 ustar 00root root 0000000 0000000 from typing import Any, Dict, Generic, Type, TypedDict, TypeVar
import pytest
from attrs import define
from msgspec import Struct
from sqlalchemy import Column, Integer
from sqlalchemy.orm.decl_api import DeclarativeMeta, registry
from pydantic import BaseModel
from pydantic.generics import GenericModel
from polyfactory import ConfigurationException
from polyfactory.factories import TypedDictFactory
from polyfactory.factories.attrs_factory import AttrsFactory
from polyfactory.factories.base import BaseFactory
from polyfactory.factories.msgspec_factory import MsgspecFactory
from polyfactory.factories.pydantic_factory import ModelFactory
from polyfactory.factories.sqlalchemy_factory import SQLAlchemyFactory
try:
from odmantic import Model
from polyfactory.factories.odmantic_odm_factory import OdmanticModelFactory
except ImportError:
Model, OdmanticModelFactory = None, None # type: ignore
try:
from beanie import Document
from polyfactory.factories.beanie_odm_factory import BeanieDocumentFactory
except ImportError:
BeanieDocumentFactory = None # type: ignore
Document = None # type: ignore
@define
class AttrsBase:
bool_field: bool
class ModelBase(BaseModel):
dict_field: Dict[str, int]
class MsgspecBase(Struct):
int_field: int
class Base(metaclass=DeclarativeMeta):
__abstract__ = True
registry = registry()
class SQLAlchemyBase(Base):
__tablename__ = "model"
id: Any = Column(Integer(), primary_key=True)
class TypedDictBase(TypedDict):
name: str
@pytest.mark.parametrize(
"base_factory, generic_arg",
[
(AttrsFactory, AttrsBase),
(ModelFactory, ModelBase),
(MsgspecFactory, MsgspecBase),
(SQLAlchemyFactory, SQLAlchemyBase),
(TypedDictFactory, TypedDictBase),
],
)
def test_modeL_inference_ok(base_factory: Type[BaseFactory], generic_arg: Type[Any]) -> None:
class Foo(base_factory[generic_arg]): # type: ignore
...
assert getattr(Foo, "__model__") is generic_arg
@pytest.mark.skipif(Model is None, reason="Odmantic import error")
def test_odmantic_model_inference_ok() -> None:
class OdmanticModelBase(Model): # type: ignore
name: str
class Foo(OdmanticModelFactory[OdmanticModelBase]): ...
assert getattr(Foo, "__model__") is OdmanticModelBase
@pytest.mark.skipif(Document is None, reason="Beanie import error")
def test_beanie_model_inference_ok() -> None:
class BeanieBase(Document):
name: str
class Foo(BeanieDocumentFactory[BeanieBase]): ...
assert getattr(Foo, "__model__") is BeanieBase
@pytest.mark.parametrize(
"base_factory",
[
AttrsFactory,
ModelFactory,
MsgspecFactory,
SQLAlchemyFactory,
TypedDictFactory,
],
)
def test_model_without_generic_type_inference_error(base_factory: Type[BaseFactory]) -> None:
with pytest.raises(ConfigurationException):
class Foo(base_factory): # type: ignore
...
@pytest.mark.parametrize(
"base_factory",
[
AttrsFactory,
ModelFactory,
MsgspecFactory,
SQLAlchemyFactory,
TypedDictFactory,
],
)
def test_model_type_error(base_factory: Type[BaseFactory]) -> None:
with pytest.raises(ConfigurationException):
class Foo(base_factory[int]): # type: ignore
...
def test_model_multiple_inheritance_cannot_infer_error() -> None:
class PFoo(BaseModel):
val: int
class TDFoo(TypedDict):
val: str
with pytest.raises(ConfigurationException):
class Foo(ModelFactory[PFoo], TypedDictFactory[TDFoo]): # type: ignore
...
def test_generic_model_is_not_an_error() -> None:
T = TypeVar("T")
P = TypeVar("P")
class Foo(GenericModel, Generic[T, P]): # type: ignore[misc]
val1: T
val2: P
class FooFactory(ModelFactory[Foo[str, int]]): ...
assert getattr(FooFactory, "__model__") is Foo[str, int]
python-polyfactory-2.21.0/tests/test_options_validation.py 0000664 0000000 0000000 00000002325 15000423051 0024136 0 ustar 00root root 0000000 0000000 import pytest
from polyfactory import ConfigurationException
from polyfactory.factories.pydantic_factory import ModelFactory
from tests.models import Person
def test_validates_model_is_set_on_definition_of_factory() -> None:
with pytest.raises(ConfigurationException):
class MyFactory(ModelFactory):
pass
def test_validates_connection_in_create_sync() -> None:
class MyFactory(ModelFactory):
__model__ = Person
with pytest.raises(ConfigurationException):
MyFactory.create_sync()
def test_validates_connection_in_create_batch_sync() -> None:
class MyFactory(ModelFactory):
__model__ = Person
with pytest.raises(ConfigurationException):
MyFactory.create_batch_sync(2)
@pytest.mark.asyncio()
async def test_validates_connection_in_create_async() -> None:
class MyFactory(ModelFactory):
__model__ = Person
with pytest.raises(ConfigurationException):
await MyFactory.create_async()
@pytest.mark.asyncio()
async def test_validates_connection_in_create_batch_async() -> None:
class MyFactory(ModelFactory):
__model__ = Person
with pytest.raises(ConfigurationException):
await MyFactory.create_batch_async(2)
python-polyfactory-2.21.0/tests/test_passing_build_args_to_child_factories.py 0000664 0000000 0000000 00000012056 15000423051 0027776 0 ustar 00root root 0000000 0000000 from typing import List, Mapping, Optional
from pydantic import BaseModel
from polyfactory.factories.pydantic_factory import ModelFactory
from polyfactory.field_meta import FieldMeta
class Address(BaseModel):
city: str
country: str
class Material(BaseModel):
name: str
origin: str
class Toy(BaseModel):
name: str
weight: float
materials: List[Material]
class Pet(BaseModel):
name: str
age: int
toys: List[Toy]
class Person(BaseModel):
name: str
age: int
pets: List[Pet]
address: Address
class PersonFactory(ModelFactory):
__model__ = Person
def test_factory_child_model_list() -> None:
data = {
"name": "Jean",
"pets": [
{
"name": "dog",
"toys": [
{
"name": "ball",
"materials": [{"name": "yarn"}, {"name": "plastic"}],
},
{
"name": "bone",
},
],
},
{
"name": "cat",
},
],
"address": {
"country": "France",
},
}
person = PersonFactory.build(factory_use_construct=False, **data)
assert person.name == "Jean"
assert len(person.pets) == 2
assert person.pets[0].name == "dog"
dog = person.pets[0]
assert len(dog.toys) == 2
dog_toys = dog.toys
assert dog_toys[0].name == "ball"
assert len(dog.toys[0].materials) == 2
assert dog.toys[0].materials[0].name == "yarn"
assert dog.toys[0].materials[1].name == "plastic"
assert len(dog.toys[1].materials) > 0
assert dog.toys[1].name == "bone"
assert person.pets[1].name == "cat"
assert person.address.country == "France"
def test_factory_child_pydantic_model() -> None:
"""Given a Pydantic Factory, When I build a model using the factory passing a Pydantic model as attribute, Then the
pydantic model is correctly built.
"""
address = Address(city="Paris", country="France")
person = PersonFactory.build(address=address)
assert person.address.city == "Paris"
assert person.address.country == "France"
def test_factory_child_none() -> None:
"""Given a Pydantic Factory, When I build a model using the factory passing None as attribute, Then the pydantic
model is correctly built.
"""
class PersonOptional(BaseModel):
name: str
address: Optional[Address]
class PersonOptionalFactory(ModelFactory):
__model__ = PersonOptional
person = PersonOptionalFactory.build(address=None)
assert person.address is None
def test_factory_with_partial_fields() -> None:
"""Given a Pydantic Model with nested Mapping field_meta, When I build the model using the factory passing only partial
attributes, Then the model is correctly built.
"""
class NestedSchema(BaseModel):
v: str
z: int
class UpperSchema(BaseModel):
a: int
b: Mapping[str, str]
nested: Mapping[str, NestedSchema]
class UpperSchemaFactory(ModelFactory):
__model__ = UpperSchema
nested = NestedSchema(v="hello", z=0)
some_dict = {"test": "fine"}
upper = UpperSchemaFactory.build(b=some_dict, nested={"nested_key": nested})
assert upper.b["test"] == "fine"
assert "nested_key" in upper.nested
assert upper.nested["nested_key"].v == nested.v
assert upper.nested["nested_key"].z == nested.z
def test_factory_with_nested_dict() -> None:
"""Given a Pydantic Model with nested Dict field_meta, When I build the model using the factory passing only partial
attributes, Then the model is correctly built.
"""
class NestedSchema(BaseModel):
z: int
class UpperSchema(BaseModel):
nested: Mapping[str, NestedSchema]
class UpperSchemaFactory(ModelFactory):
__model__ = UpperSchema
nested = NestedSchema(z=0)
upper = UpperSchemaFactory.build(nested={"nested_dict": nested})
assert "nested_dict" in upper.nested
assert upper.nested["nested_dict"].z == nested.z
def test_factory_with_partial_kwargs_deep_in_tree() -> None:
class A(BaseModel):
name: str
age: int
class B(BaseModel):
a: A
class C(BaseModel):
b: B
class D(BaseModel):
c: C
class DFactory(ModelFactory):
__model__ = D
build_result = DFactory.build(factory_use_construct=False, **{"c": {"b": {"a": {"name": "test"}}}})
assert build_result
assert build_result.c.b.a.name == "test"
def test_factory_with_nested_optional_field_overrides_in_dict() -> None:
class MyChildModel(BaseModel):
name: str
class MyParentModel(BaseModel):
child: Optional[MyChildModel]
class MyParentModelFactory(ModelFactory):
__model__ = MyParentModel
@classmethod
def should_set_none_value(cls, field_meta: FieldMeta) -> bool:
return True
result = MyParentModelFactory.build(child={"name": "test"})
assert result.child is not None
assert result.child.name == "test"
python-polyfactory-2.21.0/tests/test_persistence_handlers.py 0000664 0000000 0000000 00000004071 15000423051 0024435 0 ustar 00root root 0000000 0000000 from typing import Any
import pytest
from pydantic import BaseModel
from polyfactory import AsyncPersistenceProtocol, SyncPersistenceProtocol
from polyfactory.factories.pydantic_factory import ModelFactory
class MyModel(BaseModel):
name: str
class MySyncPersistenceHandler(SyncPersistenceProtocol):
def save(self, data: Any, *args: Any, **kwargs: Any) -> Any:
return data
def save_many(self, data: Any, *args: Any, **kwargs: Any) -> Any:
return data
class MyAsyncPersistenceHandler(AsyncPersistenceProtocol):
async def save(self, data: Any, *args: Any, **kwargs: Any) -> Any:
return data
async def save_many(self, data: Any, *args: Any, **kwargs: Any) -> Any:
return data
def test_sync_persistence_handler_is_set_and_called_with_instance() -> None:
class MyFactory(ModelFactory):
__model__ = MyModel
__sync_persistence__ = MySyncPersistenceHandler()
assert MyFactory.create_sync().name
assert [instance.name for instance in MyFactory.create_batch_sync(size=2)]
def test_sync_persistence_handler_is_set_and_called_with_class() -> None:
class MyFactory(ModelFactory):
__model__ = MyModel
__sync_persistence__ = MySyncPersistenceHandler
assert MyFactory.create_sync().name
assert [instance.name for instance in MyFactory.create_batch_sync(size=2)]
@pytest.mark.asyncio()
async def test_async_persistence_handler_is_set_and_called_with_instance() -> None:
class MyFactory(ModelFactory):
__model__ = MyModel
__async_persistence__ = MyAsyncPersistenceHandler()
assert (await MyFactory.create_async()).name
assert [instance.name for instance in (await MyFactory.create_batch_async(size=2))]
@pytest.mark.asyncio()
async def test_async_persistence_handler_is_set_and_called_with_class() -> None:
class MyFactory(ModelFactory):
__model__ = MyModel
__async_persistence__ = MyAsyncPersistenceHandler
assert (await MyFactory.create_async()).name
assert [instance.name for instance in (await MyFactory.create_batch_async(size=2))]
python-polyfactory-2.21.0/tests/test_provider_map.py 0000664 0000000 0000000 00000004031 15000423051 0022714 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from typing import Any, Callable, Dict, Generic, TypeVar
import pytest
from polyfactory.exceptions import ParameterException
from polyfactory.factories.base import BaseFactory
from polyfactory.factories.dataclass_factory import DataclassFactory
def test_provider_map() -> None:
provider_map = BaseFactory.get_provider_map()
provider_map.pop(Any)
for type_, handler in provider_map.items():
value = handler()
assert isinstance(value, type_)
def test_provider_map_with_any() -> None:
@dataclass
class Foo:
foo: Any
class FooFactory(DataclassFactory[Foo]):
@classmethod
def get_provider_map(cls) -> Dict[Any, Callable[[], Any]]:
provider_map = super().get_provider_map()
provider_map[Any] = lambda: "any"
return provider_map
foo = FooFactory.build()
assert foo.foo == "any"
coverage_result = list(FooFactory.coverage())
assert all(result.foo == "any" for result in coverage_result)
def test_provider_map_with_typevar() -> None:
T = TypeVar("T")
@dataclass
class Foo(Generic[T]):
foo: T
class FooFactory(DataclassFactory[Foo]):
@classmethod
def get_provider_map(cls) -> Dict[Any, Callable[[], Any]]:
provider_map = super().get_provider_map()
provider_map[T] = lambda: "any"
return provider_map
foo = FooFactory.build()
assert foo.foo == "any"
coverage_result = list(FooFactory.coverage())
assert all(result.foo == "any" for result in coverage_result)
def test_add_custom_provider() -> None:
class CustomType:
def __init__(self, _: Any) -> None:
pass
@dataclass
class Foo:
foo: CustomType
FooFactory = DataclassFactory.create_factory(Foo)
with pytest.raises(ParameterException):
FooFactory.build()
BaseFactory.add_provider(CustomType, lambda: CustomType("custom"))
# after adding the provider, nothing should raise!
assert FooFactory.build()
python-polyfactory-2.21.0/tests/test_pydantic_factory.py 0000664 0000000 0000000 00000107745 15000423051 0023607 0 ustar 00root root 0000000 0000000 import re
import sys
from collections import Counter, deque
from dataclasses import dataclass
from datetime import date, datetime, time, timedelta
from decimal import Decimal
from ipaddress import IPv4Address, IPv4Interface, IPv4Network, IPv6Address, IPv6Interface, IPv6Network
from pathlib import Path
from typing import Callable, Dict, FrozenSet, List, Literal, Optional, Sequence, Set, Tuple, Type, Union
from uuid import UUID
import pytest
from annotated_types import Ge, Gt, Le, LowerCase, MinLen, UpperCase
from typing_extensions import Annotated, TypeAlias
import pydantic
from pydantic import (
UUID1,
UUID3,
UUID4,
UUID5,
AmqpDsn,
AnyHttpUrl,
AnyUrl,
BaseModel,
ByteSize,
DirectoryPath,
EmailStr,
Field,
FilePath,
FutureDate,
HttpUrl,
IPvAnyAddress,
IPvAnyInterface,
IPvAnyNetwork,
Json,
KafkaDsn,
NameEmail,
NegativeFloat,
NegativeInt,
NonNegativeInt,
NonPositiveFloat,
PastDate,
PositiveFloat,
PositiveInt,
PostgresDsn,
RedisDsn,
SecretBytes,
SecretStr,
StrictBool,
StrictBytes,
StrictFloat,
StrictInt,
StrictStr,
ValidationError,
conbytes,
condecimal,
confloat,
confrozenset,
conint,
conlist,
conset,
constr,
validator,
)
from polyfactory.factories import DataclassFactory
from polyfactory.factories.pydantic_factory import _IS_PYDANTIC_V1, ModelFactory
from tests.models import Person, PetFactory
IS_PYDANTIC_V1 = _IS_PYDANTIC_V1
IS_PYDANTIC_V2 = not _IS_PYDANTIC_V1
REGEX_PATTERN = r"(a|b|c)zz"
@pytest.mark.skipif(IS_PYDANTIC_V2, reason="pydantic v1 only functionality")
def test_const() -> None:
class A(BaseModel):
v: int = Field(1, const=True) # type: ignore[call-overload]
class AFactory(ModelFactory[A]):
__model__ = A
for _ in range(5):
assert AFactory.build()
def test_optional_with_constraints() -> None:
class A(BaseModel):
a: Optional[float] = Field(None, ge=0, le=1)
class AFactory(ModelFactory[A]):
__model__ = A
# Setting random seed so that we get a non-optional value
random_seed = 1
__random_seed__ = random_seed
# verify no pydantic.ValidationError is thrown
assert isinstance(AFactory.build().a, float)
@pytest.mark.skipif(sys.version_info < (3, 10), reason="requires python3.9 or higher")
def test_list_unions() -> None:
# issue: https://github.com/litestar-org/polyfactory/issues/300, no error reproduced
class A(BaseModel):
a: str
class B(BaseModel):
b: str
class C(BaseModel):
c: list[A] | list[B]
class CFactory(ModelFactory[C]):
__forward_ref_resolution_type_mapping__ = {"A": A, "B": B, "C": C}
__model__ = C
assert isinstance(CFactory.build().c, list)
assert len(CFactory.build().c) > 0
assert isinstance(CFactory.build().c[0], (A, B))
@pytest.mark.skipif(IS_PYDANTIC_V1, reason="only for Pydantic v2")
def test_json_type() -> None:
class A(BaseModel):
a: Json[int]
class AFactory(ModelFactory[A]):
__model__ = A
assert isinstance(AFactory.build(), A)
@pytest.mark.skipif(IS_PYDANTIC_V1, reason="only for Pydantic v2")
def test_nested_json_type() -> None:
class A(BaseModel):
a: int
class B(BaseModel):
b: Json[A]
class BFactory(ModelFactory[B]):
__model__ = B
assert isinstance(BFactory.build(), B)
def test_sequence_with_annotated_item_types() -> None:
ConstrainedInt = Annotated[int, Field(ge=100, le=200)]
class Foo(BaseModel):
list_field: List[ConstrainedInt]
tuple_field: Tuple[ConstrainedInt]
variable_tuple_field: Tuple[ConstrainedInt, ...]
set_field: Set[ConstrainedInt]
class FooFactory(ModelFactory[Foo]):
__model__ = Foo
assert FooFactory.build()
def test_mapping_with_annotated_item_types() -> None:
ConstrainedInt = Annotated[int, Field(ge=100, le=200)]
ConstrainedStr = Annotated[str, Field(min_length=1, max_length=3)]
class Foo(BaseModel):
dict_field: Dict[ConstrainedStr, ConstrainedInt]
class FooFactory(ModelFactory[Foo]):
__model__ = Foo
assert FooFactory.build()
def test_use_default_with_callable_default() -> None:
class Foo(BaseModel):
default_field: int = Field(default_factory=lambda: 10)
class FooFactory(ModelFactory[Foo]):
__model__ = Foo
__use_defaults__ = True
foo = FooFactory.build()
assert foo.default_field == 10
@pytest.mark.skipif(IS_PYDANTIC_V1, reason="only for Pydantic v2")
def test_use_default_with_callable_default_with_arg() -> None:
class Foo(BaseModel):
other: int
default_field: int = Field(default_factory=lambda data: data["other"])
class FooFactory(ModelFactory[Foo]):
__model__ = Foo
__use_defaults__ = True
foo = FooFactory.build(other=10)
assert foo.default_field == 10
def test_use_default_with_non_callable_default() -> None:
class Foo(BaseModel):
default_field: int = Field(default=10)
class FooFactory(ModelFactory[Foo]):
__model__ = Foo
__use_defaults__ = True
foo = FooFactory.build()
assert foo.default_field == 10
def test_factory_nested_model_collection_coverage() -> None:
class Nested(BaseModel):
foo: int
class CollectionModel(BaseModel):
collection: List[Nested]
class CollectionModelFactory(ModelFactory[CollectionModel]):
__model__ = CollectionModel
instances = list(CollectionModelFactory.coverage())
assert len(instances) == 1
instance = instances[0]
assert len(instance.collection) == 1
assert isinstance(instance.collection[0], Nested)
def test_factory_nested_model_collection_construct_coverage() -> None:
class Nested(BaseModel):
foo: int
@validator("foo")
@classmethod
def always_invalid(cls, v: int) -> None:
raise ValueError("invalid by validator")
class CollectionModel(BaseModel):
collection: List[Nested]
class CollectionModelFactory(ModelFactory[CollectionModel]):
__model__ = CollectionModel
instances = list(CollectionModelFactory.coverage(factory_use_construct=True))
assert len(instances) == 1
instance = instances[0]
assert len(instance.collection) == 1
assert isinstance(instance.collection[0], Nested)
def test_factory_use_construct() -> None:
# factory should pass values without validation
invalid_age = "non_valid_age"
non_validated_pet = PetFactory.build(factory_use_construct=True, age=invalid_age)
assert non_validated_pet.age == invalid_age # type: ignore[comparison-overlap]
with pytest.raises(ValidationError):
PetFactory.build(age=invalid_age)
def test_factory_use_construct_coverage() -> None:
class Foo(BaseModel):
invalid: int
@validator("invalid")
@classmethod
def always_invalid(cls, v: int) -> None:
raise ValueError("invalid by validator")
class FooFactory(ModelFactory[Foo]):
__model__ = Foo
non_validated = list(FooFactory.coverage(factory_use_construct=True))
assert len(non_validated) == 1
with pytest.raises(ValidationError):
FooFactory.build()
def test_factory_use_construct_nested() -> None:
class Child(BaseModel):
a: int = Field(ge=0)
class Parent(BaseModel):
child: Child
class ParentFactory(ModelFactory[Parent]):
__model__ = Parent
non_validated_parent = ParentFactory.build(factory_use_construct=True, child={"a": -1})
assert non_validated_parent.child.a == -1
with pytest.raises(ValidationError):
ParentFactory.build(child={"a": -1})
def test_factory_use_construct_validator() -> None:
class Foo(BaseModel):
invalid: int
@validator("invalid")
@classmethod
def always_invalid(cls, v: int) -> None:
raise ValueError("invalid by validator")
class FooFactory(ModelFactory[Foo]):
__model__ = Foo
non_validated = FooFactory.build(factory_use_construct=True)
assert isinstance(non_validated.invalid, int)
with pytest.raises(ValidationError):
FooFactory.build()
@pytest.mark.parametrize("sequence_type", (Tuple, List))
def test_factory_use_construct_nested_sequence(sequence_type: Type[Sequence]) -> None:
class Child(BaseModel):
a: int = Field(ge=0)
class Parent(BaseModel):
child: sequence_type[Child] # type: ignore[valid-type]
class ParentFactory(ModelFactory[Parent]):
__model__ = Parent
non_validated_parent = ParentFactory.build(factory_use_construct=True, child=[{"a": -1}])
assert len(non_validated_parent.child) == 1
with pytest.raises(ValidationError):
ParentFactory.build(child=[{"a": -1}])
@pytest.mark.parametrize("set_type", (FrozenSet, Set))
def test_factory_use_construct_nested_set(set_type: Union[Type[FrozenSet], Type[Set]]) -> None:
class Child(BaseModel):
invalid: int = Field()
@validator("invalid", allow_reuse=True)
@classmethod
def always_invalid(cls, v: int) -> None:
raise ValueError("invalid by validator")
def __hash__(self) -> int:
return hash(self.invalid)
class Parent(BaseModel):
child: set_type[Child] # type: ignore[valid-type]
class ParentFactory(ModelFactory[Parent]):
__model__ = Parent
non_validated_parent = ParentFactory.build(factory_use_construct=True)
assert len(non_validated_parent.child) == 1
assert isinstance(non_validated_parent.child, set_type)
with pytest.raises(ValidationError):
ParentFactory.build()
def test_mapping_with_annotated_nested_model() -> None:
class ChildValue(BaseModel):
a: int = Field(ge=0)
class Parent(BaseModel):
dict_field: Dict[str, ChildValue]
class ParentFactory(ModelFactory[Parent]):
__model__ = Parent
non_validated_parent = ParentFactory.build(factory_use_construct=True, dict_field={"arb": {"a": -1}})
assert set(non_validated_parent.dict_field) == {"arb"}
# not converted
assert non_validated_parent.dict_field["arb"] == {"a": -1} # type: ignore[comparison-overlap]
with pytest.raises(ValidationError):
assert ParentFactory.build(dict_field={"arb": {"a": -1}})
@pytest.mark.skipif(
True,
reason=(
"pydantic 1 only test, "
"get_args function not returning the origin type as expected for pydantic v1 constrained values, "
"ex. ConstrainedListValue. "
),
)
def test_factory_use_construct_nested_constraint_list_v1() -> None:
class Child(BaseModel):
a: int = Field(ge=0)
class Parent(BaseModel):
child: conlist(Child, min_items=1, max_items=4) # type: ignore[valid-type]
child_annotated: Annotated[List[Child], Field(min_items=1, max_items=4)]
class ParentFactory(ModelFactory[Parent]):
__model__ = Parent
non_validated_parent = ParentFactory.build(
factory_use_construct=True, child=[{"a": -1}], child_annotated=[{"a": -2}]
)
assert non_validated_parent.child[0].a == -1
assert non_validated_parent.child_annotated[0].a == -2
with pytest.raises(ValidationError):
ParentFactory.build(child=[{"a": -1}])
with pytest.raises(ValidationError):
ParentFactory.build(child_annotated=[{"a": -1}])
@pytest.mark.skipif(IS_PYDANTIC_V1, reason="pydantic 2 only test")
def test_factory_use_construct_nested_constraint_list_v2() -> None:
class Child(BaseModel):
a: int = Field(ge=0)
class Parent(BaseModel):
child: conlist(Child, min_length=1, max_length=4) # type: ignore[valid-type]
child_annotated: Annotated[List[Child], Field(min_length=1, max_length=4)]
class ParentFactory(ModelFactory[Parent]):
__model__ = Parent
non_validated_parent = ParentFactory.build(
factory_use_construct=True, child=[{"a": -1}], child_annotated=[{"a": -2}]
)
assert non_validated_parent.child[0].a == -1
assert non_validated_parent.child_annotated[0].a == -2
with pytest.raises(ValidationError):
ParentFactory.build(child=[{"a": -1}])
with pytest.raises(ValidationError):
ParentFactory.build(child_annotated=[{"a": -1}])
@pytest.mark.skipif(IS_PYDANTIC_V2, reason="pydantic 1 only test")
def test_build_instance_by_field_alias_with_allow_population_by_field_name_flag_pydantic_v1() -> None:
class MyModel(BaseModel):
aliased_field: str = Field(..., alias="special_field")
class Config:
allow_population_by_field_name = True
class MyFactory(ModelFactory):
__model__ = MyModel
instance = MyFactory.build(aliased_field="some")
assert instance.aliased_field == "some"
@pytest.mark.skipif(IS_PYDANTIC_V1, reason="pydantic 2 only test")
def test_build_instance_by_field_alias_with_populate_by_name_flag_pydantic_v2() -> None:
class MyModel(BaseModel):
model_config = {"populate_by_name": True}
aliased_field: str = Field(..., alias="special_field")
class MyFactory(ModelFactory):
__model__ = MyModel
instance = MyFactory.build(aliased_field="some")
assert instance.aliased_field == "some"
def test_build_instance_by_field_name_with_allow_population_by_field_name_flag() -> None:
class MyModel(BaseModel):
aliased_field: str = Field(..., alias="special_field")
class Config:
allow_population_by_field_name = True
class MyFactory(ModelFactory):
__model__ = MyModel
instance = MyFactory.build(special_field="some")
assert instance.aliased_field == "some"
def test_alias_parsing() -> None:
class MyModel(BaseModel):
aliased_field: str = Field(alias="special_field")
class MyFactory(ModelFactory):
__model__ = MyModel
assert isinstance(MyFactory.build().aliased_field, str)
def test_type_property_parsing() -> None:
class Base(BaseModel):
if IS_PYDANTIC_V2:
MongoDsn_pydantic_type: pydantic.networks.MongoDsn
MariaDBDsn_pydantic_type: pydantic.networks.MariaDBDsn
CockroachDsn_pydantic_type: pydantic.networks.CockroachDsn
MySQLDsn_pydantic_type: pydantic.networks.MySQLDsn
PastDatetime_pydantic_type: pydantic.PastDatetime
FutureDatetime_pydantic_type: pydantic.FutureDatetime
AwareDatetime_pydantic_type: pydantic.AwareDatetime
NaiveDatetime_pydantic_type: pydantic.NaiveDatetime
else:
PyObject_pydantic_type: pydantic.types.PyObject
Color_pydantic_type: pydantic.color.Color
class MyModel(Base):
object_field: object
float_field: float
int_field: int
bool_field: bool
str_field: str
bytes_field: bytes
# built-in objects
dict_field: dict
tuple_field: tuple
list_field: list
set_field: set
frozenset_field: frozenset
deque_field: deque
# standard library objects
Path_field: Path
Decimal_field: Decimal
UUID_field: UUID
# datetime
datetime_field: datetime
date_field: date
time_field: time
timedelta_field: timedelta
# ip addresses
IPv4Address_field: IPv4Address
IPv4Interface_field: IPv4Interface
IPv4Network_field: IPv4Network
IPv6Address_field: IPv6Address
IPv6Interface_field: IPv6Interface
IPv6Network_field: IPv6Network
# types
Callable_field: Callable
# pydantic specific
ByteSize_pydantic_type: ByteSize
PositiveInt_pydantic_type: PositiveInt
FilePath_pydantic_type: FilePath
NegativeFloat_pydantic_type: NegativeFloat
NegativeInt_pydantic_type: NegativeInt
PositiveFloat_pydantic_type: PositiveFloat
NonPositiveFloat_pydantic_type: NonPositiveFloat
NonNegativeInt_pydantic_type: NonNegativeInt
StrictInt_pydantic_type: StrictInt
StrictBool_pydantic_type: StrictBool
StrictBytes_pydantic_type: StrictBytes
StrictFloat_pydantic_type: StrictFloat
StrictStr_pydantic_type: StrictStr
DirectoryPath_pydantic_type: DirectoryPath
EmailStr_pydantic_type: EmailStr
NameEmail_pydantic_type: NameEmail
Json_pydantic_type: Json
AnyUrl_pydantic_type: AnyUrl
AnyHttpUrl_pydantic_type: AnyHttpUrl
HttpUrl_pydantic_type: HttpUrl
PostgresDsn_pydantic_type: PostgresDsn
RedisDsn_pydantic_type: RedisDsn
UUID1_pydantic_type: UUID1
UUID3_pydantic_type: UUID3
UUID4_pydantic_type: UUID4
UUID5_pydantic_type: UUID5
SecretBytes_pydantic_type: SecretBytes
SecretStr_pydantic_type: SecretStr
IPvAnyAddress_pydantic_type: IPvAnyAddress
IPvAnyInterface_pydantic_type: IPvAnyInterface
IPvAnyNetwork_pydantic_type: IPvAnyNetwork
AmqpDsn_pydantic_type: AmqpDsn
KafkaDsn_pydantic_type: KafkaDsn
PastDate_pydantic_type: PastDate
FutureDate_pydantic_type: FutureDate
Counter_pydantic_type: Counter
class MyFactory(ModelFactory):
__model__ = MyModel
result = MyFactory.build()
for key in MyFactory.get_provider_map():
key_name = key.__name__ if hasattr(key, "__name__") else key._name
if hasattr(result, f"{key_name}_field"):
assert isinstance(getattr(result, f"{key_name}_field"), key)
elif hasattr(result, f"{key_name}_pydantic_type"):
assert getattr(result, f"{key_name}_pydantic_type") is not None
@pytest.mark.parametrize(
"type_",
[AnyUrl, HttpUrl, KafkaDsn, PostgresDsn, RedisDsn, AmqpDsn, AnyHttpUrl],
)
def test_optional_url_field_parsed_correctly(type_: TypeAlias) -> None:
class MyModel(BaseModel):
url: Optional[type_]
class MyFactory(ModelFactory[MyModel]):
__model__ = MyModel
while not (url := MyFactory.build().url):
assert not url
assert MyModel(url=url) # no validation error raised
@pytest.mark.skipif(IS_PYDANTIC_V2, reason="pydantic 1 only test")
def test_handles_complex_typing_with_custom_root_type() -> None:
class MyModel(BaseModel):
__root__: List[int]
class MyFactory(ModelFactory[MyModel]):
__model__ = MyModel
result = MyFactory.build()
assert result.__root__
assert isinstance(result.__root__, list)
def test_union_types() -> None:
class A(BaseModel):
a: Union[List[str], List[int]]
b: Union[str, List[int]]
c: List[Union[Tuple[int, int], Tuple[str, int]]]
AFactory = ModelFactory.create_factory(A)
assert AFactory.build()
def test_collection_unions_with_models() -> None:
class A(BaseModel):
a: int
class B(BaseModel):
a: str
class C(BaseModel):
a: Union[List[A], List[B]]
b: List[Union[A, B]]
CFactory = ModelFactory.create_factory(C)
assert CFactory.build()
def test_constrained_union_types() -> None:
class A(BaseModel):
a: Union[Annotated[List[str], MinLen(100)], Annotated[int, Ge(1000)]]
b: Union[List[Annotated[str, MinLen(100)]], int]
c: Union[Annotated[List[int], MinLen(100)], None]
d: Union[Annotated[List[int], MinLen(100)], Annotated[List[str], MinLen(100)]]
e: Optional[Union[Annotated[List[int], MinLen(10)], Annotated[List[str], MinLen(10)]]]
f: Optional[Union[Annotated[List[int], MinLen(10)], List[str]]]
AFactory = ModelFactory.create_factory(A, __allow_none_optionals__=False)
assert AFactory.build()
@pytest.mark.parametrize("allow_none", (True, False))
def test_optional_type(allow_none: bool) -> None:
class A(BaseModel):
a: Union[str, None]
b: Optional[str]
c: Optional[Union[str, int, List[int]]]
class AFactory(ModelFactory[A]):
__model__ = A
__allow_none_optionals__ = allow_none
assert AFactory.build()
def test_discriminated_unions() -> None:
class BasePet(BaseModel):
name: str
class BlackCat(BasePet):
pet_type: Literal["cat"]
color: Literal["black"]
class WhiteCat(BasePet):
pet_type: Literal["cat"]
color: Literal["white"]
class Dog(BasePet):
pet_type: Literal["dog"]
class Owner(BaseModel):
pet: Annotated[
Union[Annotated[Union[BlackCat, WhiteCat], Field(discriminator="color")], Dog],
Field(discriminator="pet_type"),
]
name: str
class OwnerFactory(ModelFactory):
__model__ = Owner
assert OwnerFactory.build()
def test_predicated_fields() -> None:
@dataclass
class PredicatedMusician:
name: Annotated[str, UpperCase]
band: Annotated[str, LowerCase]
class PredicatedMusicianFactory(DataclassFactory):
__model__ = PredicatedMusician
assert PredicatedMusicianFactory.build()
def test_tuple_with_annotated_constraints() -> None:
class Location(BaseModel):
long_lat: Tuple[Annotated[float, Ge(-180), Le(180)], Annotated[float, Ge(-90), Le(90)]]
class LocationFactory(ModelFactory[Location]):
__model__ = Location
assert LocationFactory.build()
def test_optional_tuple_with_annotated_constraints() -> None:
class Location(BaseModel):
long_lat: Union[Tuple[Annotated[float, Ge(-180), Le(180)], Annotated[float, Ge(-90), Le(90)]], None]
class LocationFactory(ModelFactory[Location]):
__model__ = Location
assert LocationFactory.build()
def test_legacy_tuple_with_annotated_constraints() -> None:
class Location(BaseModel):
long_lat: Tuple[Annotated[float, Ge(-180), Le(180)], Annotated[float, Ge(-90), Le(90)]]
class LocationFactory(ModelFactory[Location]):
__model__ = Location
assert LocationFactory.build()
def test_legacy_optional_tuple_with_annotated_constraints() -> None:
class Location(BaseModel):
long_lat: Union[Tuple[Annotated[float, Ge(-180), Le(180)], Annotated[float, Ge(-90), Le(90)]], None]
class LocationFactory(ModelFactory[Location]):
__model__ = Location
assert LocationFactory.build()
@pytest.mark.skipif(IS_PYDANTIC_V2, reason="pydantic 1 only test")
def test_constrained_attribute_parsing_pydantic_v1() -> None:
class ConstrainedModel(BaseModel):
conbytes_field: conbytes() # type: ignore[valid-type]
condecimal_field: condecimal() # type: ignore[valid-type]
confloat_field: confloat() # type: ignore[valid-type]
conint_field: conint() # type: ignore[valid-type]
conlist_field: conlist(str, min_items=5, max_items=10) # type: ignore[valid-type]
conset_field: conset(str, min_items=5, max_items=10) # type: ignore[valid-type]
confrozenset_field: confrozenset(str, min_items=5, max_items=10) # type: ignore[valid-type]
constr_field: constr(to_lower=True) # type: ignore[valid-type]
str_field1: str = Field(min_length=11)
str_field2: str = Field(max_length=11)
str_field3: str = Field(min_length=8, max_length=11, regex=REGEX_PATTERN) # type: ignore[call-overload]
int_field: int = Field(gt=1, multiple_of=5)
float_field: float = Field(gt=100, lt=1000)
decimal_field: Decimal = Field(ge=100, le=1000)
list_field: List[str] = Field(min_items=1, max_items=10) # type: ignore[call-overload]
constant_field: int = Field(const=True, default=100) # type: ignore[call-overload]
optional_field: Optional[constr(min_length=1)] # type: ignore[valid-type]
class MyFactory(ModelFactory):
__model__ = ConstrainedModel
result = MyFactory.build()
assert isinstance(result.conbytes_field, bytes)
assert isinstance(result.conint_field, int)
assert isinstance(result.confloat_field, float)
assert isinstance(result.condecimal_field, Decimal)
assert isinstance(result.conlist_field, list)
assert isinstance(result.conset_field, set)
assert isinstance(result.confrozenset_field, frozenset)
assert isinstance(result.str_field1, str)
assert isinstance(result.constr_field, str)
assert len(result.conlist_field) >= 5
assert len(result.conlist_field) <= 10
assert len(result.conset_field) >= 5
assert len(result.conset_field) <= 10
assert len(result.confrozenset_field) >= 5
assert len(result.confrozenset_field) <= 10
assert result.constr_field.lower() == result.constr_field
assert len(result.str_field1) >= 11
assert len(result.str_field2) <= 11
assert len(result.str_field3) >= 8
assert len(result.str_field3) <= 11
match = re.search(REGEX_PATTERN, result.str_field3)
assert match
assert match[0]
assert result.int_field >= 1
assert result.int_field % 5 == 0
assert result.float_field > 100
assert result.float_field < 1000
assert result.decimal_field > 100
assert result.decimal_field < 1000
assert len(result.list_field) >= 1
assert len(result.list_field) <= 10
assert all(isinstance(r, str) for r in result.list_field)
assert result.constant_field == 100
assert result.optional_field is None or len(result.optional_field) >= 1
@pytest.mark.skipif(IS_PYDANTIC_V2, reason="pydantic 1 only test")
def test_complex_constrained_attribute_parsing_pydantic_v1() -> None:
class MyModel(BaseModel):
conlist_with_model_field: conlist(Person, min_items=3) # type: ignore[valid-type]
conlist_with_complex_type: conlist( # type: ignore[valid-type]
Dict[str, Tuple[Person, Person, Person]],
min_items=1,
)
class MyFactory(ModelFactory):
__model__ = MyModel
result = MyFactory.build()
assert len(result.conlist_with_model_field) >= 3
assert all(isinstance(v, Person) for v in result.conlist_with_model_field)
assert result.conlist_with_complex_type
assert isinstance(result.conlist_with_complex_type[0], dict)
assert isinstance(next(iter(result.conlist_with_complex_type[0].values())), tuple)
assert len(next(iter(result.conlist_with_complex_type[0].values()))) == 3
assert all(isinstance(v, Person) for v in next(iter(result.conlist_with_complex_type[0].values())))
@pytest.mark.skipif(IS_PYDANTIC_V2, reason="pydantic 1 only test")
def test_nested_constrained_attribute_handling_pydantic_1() -> None:
# subclassing the constrained fields is not documented by pydantic,
# but is supported apparently
from pydantic import ConstrainedBytes, ConstrainedDecimal, ConstrainedFloat, ConstrainedInt, ConstrainedStr
class MyConstrainedString(ConstrainedStr): # type: ignore[misc,valid-type]
regex = re.compile("^vpc-.*$")
class MyConstrainedBytes(ConstrainedBytes): # type: ignore[misc,valid-type]
min_length = 11
class MyConstrainedInt(ConstrainedInt): # type: ignore[misc,valid-type]
ge = 11
class MyConstrainedFloat(ConstrainedFloat): # type: ignore[misc,valid-type]
ge = 11.0
class MyConstrainedDecimal(ConstrainedDecimal): # type: ignore[misc,valid-type]
ge = Decimal("11.0")
class MyModel(BaseModel):
conbytes_list_field: List[conbytes()] # type: ignore[valid-type]
condecimal_list_field: List[condecimal()] # type: ignore[valid-type]
confloat_list_field: List[confloat()] # type: ignore[valid-type]
conint_list_field: List[conint()] # type: ignore[valid-type]
conlist_list_field: List[conlist(str)] # type: ignore[valid-type]
conset_list_field: List[conset(str)] # type: ignore[valid-type]
constr_list_field: List[constr(to_lower=True)] # type: ignore[valid-type]
my_bytes_list_field: List[MyConstrainedBytes]
my_decimal_list_field: List[MyConstrainedDecimal]
my_float_list_field: List[MyConstrainedFloat]
my_int_list_field: List[MyConstrainedInt]
my_str_list_field: List[MyConstrainedString]
my_bytes_dict_field: Dict[str, MyConstrainedBytes]
my_decimal_dict_field: Dict[str, MyConstrainedDecimal]
my_float_dict_field: Dict[str, MyConstrainedFloat]
my_int_dict_field: Dict[str, MyConstrainedInt]
my_str_dict_field: Dict[str, MyConstrainedString]
class MyFactory(ModelFactory):
__model__ = MyModel
result = MyFactory.build()
assert result.conbytes_list_field
assert result.condecimal_list_field
assert result.confloat_list_field
assert result.conint_list_field
assert result.conlist_list_field
assert result.conset_list_field
assert result.constr_list_field
assert result.my_bytes_list_field
assert result.my_decimal_list_field
assert result.my_float_list_field
assert result.my_int_list_field
assert result.my_str_list_field
assert result.my_bytes_dict_field
assert result.my_decimal_dict_field
assert result.my_float_dict_field
assert result.my_int_dict_field
assert result.my_str_dict_field
@pytest.mark.skipif(
IS_PYDANTIC_V1 or sys.version_info < (3, 9),
reason="pydantic 2 only test, does not work correctly in py 3.8",
)
def test_nested_constrained_attribute_handling_pydantic_2() -> None:
# subclassing the constrained fields is not documented by pydantic,
# but is supported apparently
class MyModel(BaseModel):
conbytes_list_field: List[conbytes()] # type: ignore[valid-type]
condecimal_list_field: List[condecimal()] # type: ignore[valid-type]
confloat_list_field: List[confloat()] # type: ignore[valid-type]
conint_list_field: List[conint()] # type: ignore[valid-type]
conlist_list_field: List[conlist(str)] # type: ignore[valid-type]
conset_list_field: List[conset(str)] # type: ignore[valid-type]
constr_list_field: List[constr(to_lower=True)] # type: ignore[valid-type]
class MyFactory(ModelFactory):
__model__ = MyModel
result = MyFactory.build()
assert result.conbytes_list_field
assert result.condecimal_list_field
assert result.confloat_list_field
assert result.conint_list_field
assert result.conlist_list_field
assert result.conset_list_field
assert result.constr_list_field
@pytest.mark.skipif(
IS_PYDANTIC_V1 or sys.version_info < (3, 9),
reason="pydantic 2 only test, does not work correctly in py 3.8",
)
def test_constrained_attribute_parsing_pydantic_v2() -> None:
class ConstrainedModel(BaseModel):
conbytes_field: conbytes() # type: ignore[valid-type]
condecimal_field: condecimal() # type: ignore[valid-type]
confloat_field: confloat() # type: ignore[valid-type]
conint_field: conint() # type: ignore[valid-type]
conlist_field: conlist(str, min_length=5, max_length=10) # type: ignore[valid-type]
conset_field: conset(str, min_length=5, max_length=10) # type: ignore[valid-type]
confrozenset_field: confrozenset(str, min_length=5, max_length=10) # type: ignore[valid-type]
constr_field: constr(to_lower=True) # type: ignore[valid-type]
str_field1: str = Field(min_length=11)
str_field2: str = Field(max_length=11)
str_field3: str = Field(min_length=8, max_length=11, pattern=REGEX_PATTERN)
int_field: int = Field(gt=1, multiple_of=5)
float_field: float = Field(gt=100, lt=1000)
decimal_field: Decimal = Field(ge=100, le=1000)
list_field: List[str] = Field(min_length=1, max_length=10)
optional_field: Optional[constr(min_length=1)] # type: ignore[valid-type]
class MyFactory(ModelFactory):
__model__ = ConstrainedModel
result = MyFactory.build()
assert isinstance(result.conbytes_field, bytes)
assert isinstance(result.conint_field, int)
assert isinstance(result.confloat_field, float)
assert isinstance(result.condecimal_field, Decimal)
assert isinstance(result.conlist_field, list)
assert isinstance(result.conset_field, set)
assert isinstance(result.confrozenset_field, frozenset)
assert isinstance(result.str_field1, str)
assert isinstance(result.constr_field, str)
assert len(result.conlist_field) >= 5
assert len(result.conlist_field) <= 10
assert len(result.conset_field) >= 5
assert len(result.conset_field) <= 10
assert len(result.confrozenset_field) >= 5
assert len(result.confrozenset_field) <= 10
assert result.constr_field.lower() == result.constr_field
assert len(result.str_field1) >= 11
assert len(result.str_field2) <= 11
assert len(result.str_field3) >= 8
assert len(result.str_field3) <= 11
match = re.search(REGEX_PATTERN, result.str_field3)
assert match
assert match[0]
assert result.int_field >= 1
assert result.int_field % 5 == 0
assert result.float_field > 100
assert result.float_field < 1000
assert result.decimal_field > 100
assert result.decimal_field < 1000
assert len(result.list_field) >= 1
assert len(result.list_field) <= 10
assert all(isinstance(r, str) for r in result.list_field)
assert result.optional_field is None or len(result.optional_field) >= 1
@pytest.mark.skipif(IS_PYDANTIC_V1, reason="pydantic 2 only test")
def test_complex_constrained_attribute_parsing_pydantic_v2() -> None:
class MyModel(BaseModel):
conlist_with_model_field: conlist(Person, min_length=3) # type: ignore[valid-type]
conlist_with_complex_type: conlist( # type: ignore[valid-type]
Dict[str, Tuple[Person, Person, Person]],
min_length=1,
)
class MyFactory(ModelFactory):
__model__ = MyModel
result = MyFactory.build()
assert len(result.conlist_with_model_field) >= 3
assert all(isinstance(v, Person) for v in result.conlist_with_model_field)
assert result.conlist_with_complex_type
assert isinstance(result.conlist_with_complex_type[0], dict)
assert isinstance(next(iter(result.conlist_with_complex_type[0].values())), tuple)
assert len(next(iter(result.conlist_with_complex_type[0].values()))) == 3
assert all(isinstance(v, Person) for v in next(iter(result.conlist_with_complex_type[0].values())))
def test_annotated_children() -> None:
class A(BaseModel):
a: Dict[int, Annotated[str, MinLen(min_length=20)]]
b: List[Annotated[int, Gt(gt=1000)]]
c: Annotated[List[Annotated[int, Gt(gt=1000)]], MinLen(min_length=50)]
d: Dict[int, Annotated[List[Annotated[str, MinLen(1)]], MinLen(1)]]
AFactory = ModelFactory.create_factory(A)
assert AFactory.build()
@pytest.mark.skipif(IS_PYDANTIC_V1, reason="pydantic 2 only test")
def test_skip_validation() -> None:
class A(BaseModel):
a: Annotated[int, pydantic.SkipValidation]
AFactory = ModelFactory.create_factory(A)
assert AFactory.build()
@pytest.mark.skipif(_IS_PYDANTIC_V1, reason="Pydantic 1 doesn't support examples")
def test_use_examples_not_defined() -> None:
class Payment(BaseModel):
amount: int = Field(0)
currency: str = Field(examples=["USD", "EUR", "INR"])
class PaymentFactory(ModelFactory[Payment]): ...
instance = PaymentFactory.build()
# it cannot fit the listed items, because faker uses longer strings
assert instance.currency not in ["USD", "EUR", "INR"]
@pytest.mark.skipif(_IS_PYDANTIC_V1, reason="Pydantic 1 doesn't support examples")
def test_use_examples_true() -> None:
class Payment(BaseModel):
amount: int = Field(0)
currency: str = Field(examples=["USD", "EUR", "INR"])
class PaymentFactory(ModelFactory[Payment]):
__use_examples__ = True
instance = PaymentFactory.build()
assert instance.currency in ["USD", "EUR", "INR"]
@pytest.mark.skipif(_IS_PYDANTIC_V1, reason="Pydantic 1 doesn't support examples")
def test_use_examples_false() -> None:
class Payment(BaseModel):
amount: int = Field(0)
currency: str = Field(examples=["USD", "EUR", "INR"])
class PaymentFactory(ModelFactory[Payment]):
__use_examples__ = False
instance = PaymentFactory.build()
assert instance.currency not in ["USD", "EUR", "INR"]
@pytest.mark.skipif(_IS_PYDANTIC_V1, reason="Pydantic 1 doesn't support examples")
def test_use_examples_value_override() -> None:
class Payment(BaseModel):
amount: int = Field(0)
currency: str = Field(examples=["USD", "EUR", "INR"])
class PaymentFactory(ModelFactory[Payment]):
__use_examples__ = True
instance = PaymentFactory.build(currency="DKK")
assert instance.currency == "DKK"
python-polyfactory-2.21.0/tests/test_pydantic_v1_v2.py 0000664 0000000 0000000 00000006303 15000423051 0023061 0 ustar 00root root 0000000 0000000 """Tests to check that usage of pydantic v1 and v2 at the same time works."""
from typing import Dict, List, Optional, Tuple, Type, Union
import pytest
from typing_extensions import Annotated
import pydantic
from polyfactory.factories.pydantic_factory import ModelFactory
if pydantic.VERSION.startswith("1"):
pytest.skip("only for pydantic v2", allow_module_level=True)
from pydantic import BaseModel as BaseModelV2
try:
from pydantic.v1 import BaseModel as BaseModelV1
except ImportError:
from pydantic import BaseModel as BaseModelV1 # type: ignore[assignment]
@pytest.mark.parametrize("base_model", [BaseModelV1, BaseModelV2])
def test_is_supported_type(base_model: Type[Union[BaseModelV1, BaseModelV2]]) -> None:
class Foo(base_model): # type: ignore[valid-type, misc]
...
assert ModelFactory.is_supported_type(Foo) is True
@pytest.mark.parametrize("base_model", [BaseModelV1, BaseModelV2])
def test_build(base_model: Type[Union[BaseModelV1, BaseModelV2]]) -> None:
class Foo(base_model): # type: ignore[valid-type, misc]
a: int
b: str
c: bool
FooFactory = ModelFactory.create_factory(Foo)
foo = FooFactory.build()
assert isinstance(foo.a, int)
assert isinstance(foo.b, str)
assert isinstance(foo.c, bool)
def test_build_v1_with_constrained_fields() -> None:
from pydantic.v1.fields import Field
ConstrainedInt = Annotated[int, Field(ge=100, le=200)]
ConstrainedStr = Annotated[str, Field(min_length=1, max_length=3)]
class Foo(BaseModelV1):
a: ConstrainedInt
b: ConstrainedStr
c: Union[ConstrainedInt, ConstrainedStr]
d: Optional[ConstrainedInt]
e: Optional[Union[ConstrainedInt, ConstrainedStr]]
f: List[ConstrainedInt]
g: Dict[ConstrainedInt, ConstrainedStr]
ModelFactory.create_factory(Foo).build()
def test_build_v2_with_constrained_fields() -> None:
from pydantic.fields import Field
ConstrainedInt = Annotated[int, Field(ge=100, le=200)]
ConstrainedStr = Annotated[str, Field(min_length=1, max_length=3)]
class Foo(pydantic.BaseModel): # pyright: ignore[reportGeneralTypeIssues]
a: ConstrainedInt
b: ConstrainedStr
c: Union[ConstrainedInt, ConstrainedStr]
d: Optional[ConstrainedInt]
e: Optional[Union[ConstrainedInt, ConstrainedStr]]
f: List[ConstrainedInt]
g: Dict[ConstrainedInt, ConstrainedStr]
ModelFactory.create_factory(Foo).build()
def test_variadic_tuple_length() -> None:
class Foo(pydantic.BaseModel):
bar: Tuple[int, ...]
class Factory(ModelFactory[Foo]):
__randomize_collection_length__ = True
__min_collection_length__ = 7
__max_collection_length__ = 8
result = Factory.build()
assert 7 <= len(result.bar) <= 8
def test_build_v1_with_url_and_email_types() -> None:
from pydantic.v1 import AnyHttpUrl, AnyUrl, EmailStr, HttpUrl, NameEmail
class Foo(BaseModelV1):
http_url: HttpUrl
any_http_url: AnyHttpUrl
any_url: AnyUrl
email_str: EmailStr
name_email: NameEmail
composed: Tuple[HttpUrl, AnyHttpUrl, AnyUrl, EmailStr, NameEmail]
ModelFactory.create_factory(Foo).build()
python-polyfactory-2.21.0/tests/test_pytest_plugin.py 0000664 0000000 0000000 00000005131 15000423051 0023135 0 ustar 00root root 0000000 0000000 from typing import List
import pytest
from pydantic import BaseModel
from polyfactory.exceptions import ParameterException
from polyfactory.factories.pydantic_factory import ModelFactory
from polyfactory.fields import Fixture, Use
from polyfactory.pytest_plugin import register_fixture
from tests.models import Person, PersonFactoryWithoutDefaults
@register_fixture
class PersonFactoryFixture(PersonFactoryWithoutDefaults):
"""Person Factory Fixture."""
@register_fixture(name="another_fixture")
class AnotherPersonFactoryFixture(PersonFactoryWithoutDefaults):
"""Another Person Factory Fixture."""
def test_fixture_register_decorator(
person_factory_fixture: PersonFactoryFixture,
) -> None:
person = person_factory_fixture.build()
assert isinstance(person, Person)
def test_custom_naming_fixture_register_decorator(
another_fixture: AnotherPersonFactoryFixture,
) -> None:
person = another_fixture.build()
assert isinstance(person, Person)
def test_register_with_function_error() -> None:
with pytest.raises(ParameterException):
@register_fixture # type: ignore
def foo() -> None:
pass
def test_register_with_class_not_model_factory_error() -> None:
with pytest.raises(ParameterException):
@register_fixture
class Foo: # type: ignore[type-var]
pass
class MyModel(BaseModel):
best_friend: Person
all_friends: List[Person]
enemies: List[Person]
def test_using_a_fixture_as_field_value() -> None:
class MyFactory(ModelFactory[MyModel]):
__model__ = MyModel
best_friend = Fixture(PersonFactoryFixture, name="mike")
all_friends = Fixture(PersonFactoryFixture, size=5)
enemies = Fixture(PersonFactoryFixture, size=0)
result = MyFactory.build()
assert result.best_friend.name == "mike"
assert len(result.all_friends) == 5
assert result.enemies == []
def test_using_factory_directly() -> None:
class MyFactory(ModelFactory[MyModel]):
__model__ = MyModel
best_friend = Use(PersonFactoryFixture.build, name="mike")
all_friends = Use(PersonFactoryFixture.batch, size=5)
enemies = Use(PersonFactoryFixture.batch, size=0)
result = MyFactory.build()
assert result.best_friend.name == "mike"
assert len(result.all_friends) == 5
assert result.enemies == []
def test_using_non_fixture_with_the_fixture_field_raises() -> None:
class MyFactory(ModelFactory[MyModel]):
__model__ = MyModel
all_friends = Fixture(123) # type: ignore
with pytest.raises(ParameterException):
MyFactory.build()
python-polyfactory-2.21.0/tests/test_random_configuration.py 0000664 0000000 0000000 00000006150 15000423051 0024440 0 ustar 00root root 0000000 0000000 from dataclasses import dataclass
from random import Random
from typing import List, Union
import pytest
from faker import Faker
from faker.config import AVAILABLE_LOCALES
from polyfactory.factories.dataclass_factory import DataclassFactory
FakerLocaleType = Union[str, List[str]]
RANDINT_MAP = {i: Random(i).randint(0, 10) for i in range(3)}
FAKER_LOCALES: List[FakerLocaleType] = [
AVAILABLE_LOCALES[0],
AVAILABLE_LOCALES[1],
AVAILABLE_LOCALES[2],
AVAILABLE_LOCALES[:3],
]
@pytest.mark.parametrize("seed", RANDINT_MAP.keys())
def test_setting_random(seed: int) -> None:
@dataclass
class Foo:
foo: int
class FooFactory(DataclassFactory[Foo]):
__model__ = Foo
__random__ = Random(seed)
@classmethod
def foo(cls) -> int:
return cls.__random__.randint(0, 10)
assert FooFactory.build().foo == RANDINT_MAP[seed]
@pytest.mark.parametrize("seed", RANDINT_MAP.keys())
def test_setting_random_seed_on_random(seed: int) -> None:
@dataclass
class Foo:
foo: int
class FooFactory(DataclassFactory[Foo]):
__model__ = Foo
__random_seed__ = seed
@classmethod
def foo(cls) -> int:
return cls.__random__.randint(0, 10)
assert FooFactory.build().foo == RANDINT_MAP[seed]
@pytest.mark.parametrize("seed", RANDINT_MAP.keys())
def test_setting_random_seed_on_faker(seed: int) -> None:
@dataclass
class Foo:
foo: int
class FooFactory(DataclassFactory[Foo]):
__model__ = Foo
__random_seed__ = seed
@classmethod
def foo(cls) -> int:
return cls.__faker__.random_digit()
assert FooFactory.build().foo == RANDINT_MAP[seed]
def test_setting_random_seed_on_multiple_factories() -> None:
foo_seed = 0
bar_seed = 1
@dataclass
class Foo:
foo: int
@dataclass
class Bar:
bar: int
class FooFactory(DataclassFactory[Foo]):
__model__ = Foo
__random_seed__ = foo_seed
@classmethod
def foo(cls) -> int:
return cls.__random__.randint(0, 10)
class BarFactory(DataclassFactory[Bar]):
__model__ = Bar
__random_seed__ = bar_seed
@classmethod
def bar(cls) -> int:
return cls.__random__.randint(0, 10)
assert FooFactory.build().foo == RANDINT_MAP[foo_seed]
assert BarFactory.build().bar == RANDINT_MAP[bar_seed]
def test_no_override_of_faker() -> None:
faker = Faker()
@dataclass
class Foo:
foo: int
class FooFactory(DataclassFactory[Foo]):
__model__ = Foo
__faker__ = faker
__random_seed__ = 10
assert FooFactory.__faker__ is faker
@pytest.mark.parametrize("locale", FAKER_LOCALES)
def test_faker_locale_preserved(locale: FakerLocaleType) -> None:
@dataclass
class Foo:
foo: int
class FooFactory(DataclassFactory[Foo]):
__model__ = Foo
__faker__ = Faker(locale=locale)
__random_seed__ = 10
expected_locales = [locale] if isinstance(locale, str) else locale
assert FooFactory.__faker__.locales == expected_locales
python-polyfactory-2.21.0/tests/test_random_seed.py 0000664 0000000 0000000 00000003022 15000423051 0022504 0 ustar 00root root 0000000 0000000 from random import randint
from typing import Optional
from pydantic import VERSION, BaseModel, Field
from polyfactory.factories.pydantic_factory import ModelFactory
def test_random_seed() -> None:
class MyModel(BaseModel):
id: int
special_id: str = (
Field(pattern=r"ID-[1-9]{3}\.[1-9]{3}")
if VERSION.startswith("2")
else Field(regex=r"ID-[1-9]{3}\.[1-9]{3}") # type: ignore[call-overload]
)
class MyModelFactory(ModelFactory):
__model__ = MyModel
ModelFactory.seed_random(1651)
ins = MyModelFactory.build()
assert ins.id == 4
assert ins.special_id == "ID-515.943"
def test_deterministic_optionals_seeding() -> None:
class ModelWithOptionalValues(BaseModel):
name: Optional[str]
class FactoryWithNoneOptionals(ModelFactory):
__model__ = ModelWithOptionalValues
seed = randint(0, 1000)
ModelFactory.seed_random(seed)
first_build = [FactoryWithNoneOptionals.build() for _ in range(10)]
ModelFactory.seed_random(seed)
second_build = [FactoryWithNoneOptionals.build() for _ in range(10)]
assert first_build == second_build
def test_deterministic_constrained_strings() -> None:
class MyModel(BaseModel):
id: int
special_id: str = Field(min_length=10, max_length=24)
class MyModelFactory(ModelFactory):
__model__ = MyModel
ModelFactory.seed_random(1651)
ins = MyModelFactory.build()
assert ins.id == 4
assert ins.special_id == "48489ab53c59b24acfe1"
python-polyfactory-2.21.0/tests/test_recursive_models.py 0000664 0000000 0000000 00000005454 15000423051 0023611 0 ustar 00root root 0000000 0000000 from __future__ import annotations
from dataclasses import dataclass, field
from typing import Any, Dict, List, Optional, Union
import pytest
from pydantic import BaseModel, Field
from polyfactory.factories.dataclass_factory import DataclassFactory
from polyfactory.factories.pydantic_factory import ModelFactory
class _Sentinel: ...
@dataclass
class Node:
value: int
union_child: Union[Node, int] # noqa: UP007
list_child: List[Node] # noqa: UP006
optional_child: Optional[Node] # noqa: UP007
child: Node = field(default=_Sentinel) # type: ignore[assignment]
def __post_init__(self) -> None:
# Emulate recursive models set by external init, e.g. ORM relationships
if self.child is _Sentinel: # type: ignore[comparison-overlap]
self.child = self
def test_recursive_model() -> None:
factory = DataclassFactory.create_factory(Node)
result = factory.build()
assert result.child is result, "Default is not used"
assert isinstance(result.union_child, int)
assert result.optional_child is None
assert result.list_child == []
assert factory.build(child={"child": None}).child.child is None
class PydanticNode(BaseModel):
value: int
union_child: Union[PydanticNode, int] # noqa: UP007
list_child: List[PydanticNode] # noqa: UP006
optional_union_child: Union[PydanticNode, None] # noqa: UP007
optional_child: Optional[PydanticNode] # noqa: UP007
child: PydanticNode = Field(default=_Sentinel) # type: ignore[assignment]
recursive_key: Dict[PydanticNode, Any] # noqa: UP006
recursive_value: Dict[str, PydanticNode] # noqa: UP006
@pytest.mark.parametrize("factory_use_construct", (True, False))
def test_recursive_pydantic_models(factory_use_construct: bool) -> None:
factory = ModelFactory.create_factory(PydanticNode)
result = factory.build(factory_use_construct)
assert result.child is _Sentinel, "Default is not used" # type: ignore[comparison-overlap]
assert isinstance(result.union_child, int)
assert result.optional_union_child is None
assert result.optional_child is None
assert result.list_child == []
assert result.recursive_key == {}
assert result.recursive_value == {}
@dataclass
class Author:
name: str
books: List[Book] # noqa: UP006
_DEFAULT_AUTHOR = Author(name="default", books=[])
@dataclass
class Book:
name: str
author: Author = field(default_factory=lambda: _DEFAULT_AUTHOR)
def test_recursive_list_model() -> None:
factory = DataclassFactory.create_factory(Author)
assert factory.build().books[0].author is _DEFAULT_AUTHOR
assert factory.build(books=[]).books == []
book_factory = DataclassFactory.create_factory(Book)
assert book_factory.build().author.books == []
assert book_factory.build(author=None).author is None
python-polyfactory-2.21.0/tests/test_regex_factory.py 0000664 0000000 0000000 00000007365 15000423051 0023103 0 ustar 00root root 0000000 0000000 """The tests in this file have been adapted from:
https://github.com/crdoconnor/xeger/blob/master/xeger/tests/test_xeger.py
"""
import re
from random import Random
from typing import TYPE_CHECKING, Union
import pytest
from polyfactory.value_generators.regex import RegexFactory
if TYPE_CHECKING:
from re import Pattern
def match(pattern: Union[str, "Pattern"]) -> None:
for _ in range(100):
assert re.match(pattern, RegexFactory(random=Random())(pattern))
def test_single_dot() -> None:
"""Verify that the dot character produces only a single character."""
match(r"^.$")
def test_dot() -> None:
"""Verify that the dot character doesn't produce newlines.
See: https://bitbucket.org/leapfrogdevelopment/rstr/issue/1/
"""
for _ in range(100):
match(r".+")
def test_date() -> None:
match(r"^([1-9]|0[1-9]|[12][0-9]|3[01])\D([1-9]|0[1-9]|1[012])\D(19[0-9][0-9]|20[0-9][0-9])$")
def test_up_to_closing_tag() -> None:
match(r"([^<]*)")
def test_ipv4() -> None:
match(r"^(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5]){3}$")
def test_year_1900_2099() -> None:
match(r"^(19|20)[\d]{2,2}$")
def test_positive_or_negative_number() -> None:
match(r"^-{0,1}\d*\.{0,1}\d+$")
def test_positive_integers() -> None:
match(r"^\d+$")
def test_email_complicated() -> None:
match(r'^([0-9a-zA-Z]([\+\-_\.][0-9a-zA-Z]+)*)+"@(([0-9a-zA-Z][-\w]*[0-9a-zA-Z]*\.)+[a-zA-Z0-9]{2,17})$')
def test_email() -> None:
match(r"(.*?)\@(.*?)\.(.*?)")
def test_alpha() -> None:
match(r"[:alpha:]")
def test_zero_or_more_anything_non_greedy() -> None:
match(r"(.*?)")
def test_literals() -> None:
match(r"foo")
def test_digit() -> None:
match(r"\d")
def test_nondigits() -> None:
match(r"\D")
def test_literal_with_repeat() -> None:
match(r"A{3}")
def test_literal_with_range_repeat() -> None:
match(r"A{2, 5}")
def test_word() -> None:
match(r"\w")
def test_nonword() -> None:
match(r"\W")
def test_or() -> None:
match(r"foo|bar")
def test_or_with_subpattern() -> None:
match(r"(foo|bar)")
def test_range() -> None:
match(r"[A-F]")
def test_character_group() -> None:
match(r"[ABC]")
def test_caret() -> None:
match(r"^foo")
def test_dollarsign() -> None:
match(r"foo$")
def test_not_literal() -> None:
match(r"[^a]")
def test_negation_group() -> None:
match(r"[^AEIOU]")
def test_lookahead() -> None:
match(r"foo(?=bar)")
def test_lookbehind() -> None:
pattern = r"(?<=foo)bar"
assert re.search(pattern, RegexFactory(random=Random())(pattern))
def test_backreference() -> None:
match(r"(foo|bar)baz\1")
def test_zero_or_more_greedy() -> None:
match(r"a*")
match(r"(.*)")
def test_zero_or_more_non_greedy() -> None:
match(r"a*?")
@pytest.mark.parametrize("limit", range(5))
def test_incoherent_limit_and_qualifier(limit: int) -> None:
r = RegexFactory(limit=limit, random=Random())
o = r(r"a{2}")
assert len(o) == 2
@pytest.mark.parametrize("seed", [777, 1234, 369, 8031])
def test_regex_factory_object_seeding(seed: int) -> None:
xg1 = RegexFactory(random=Random(x=seed))
string1 = xg1(r"\w{3,4}")
xg2 = RegexFactory(random=Random(x=seed))
string2 = xg2(r"\w{3,4}")
assert string1 == string2
def test_regex_factory_random_instance() -> None:
xg1 = RegexFactory(random=Random())
xg_random = xg1._random
xg2 = RegexFactory(random=Random())
xg2._random = xg_random
assert xg1._random == xg2._random
# xg_random is used by both, so if we give
# the same seed, the result should be the same
xg_random.seed(90)
string1 = xg1(r"\w\d\w")
xg_random.seed(90)
string2 = xg2(r"\w\d\w")
assert string1 == string2
python-polyfactory-2.21.0/tests/test_type_coverage_generation.py 0000664 0000000 0000000 00000025446 15000423051 0025311 0 ustar 00root root 0000000 0000000 # ruff: noqa: UP007, UP006
from __future__ import annotations
from dataclasses import dataclass, make_dataclass
from datetime import date
from typing import Any, Dict, FrozenSet, Iterable, List, Literal, Optional, Set, Tuple, Type, Union
from uuid import UUID
import pytest
from typing_extensions import TypedDict
from pydantic import BaseModel
from polyfactory.decorators import post_generated
from polyfactory.exceptions import ParameterException
from polyfactory.factories.dataclass_factory import DataclassFactory
from polyfactory.factories.pydantic_factory import ModelFactory
from polyfactory.factories.typed_dict_factory import TypedDictFactory
from polyfactory.utils.types import NoneType
from tests.test_pydantic_factory import IS_PYDANTIC_V1
def test_coverage_count() -> None:
@dataclass
class Profile:
name: str
high_score: Union[int, float]
dob: date
data: Union[str, date, int, float]
class ProfileFactory(DataclassFactory[Profile]):
__model__ = Profile
results = list(ProfileFactory.coverage())
assert len(results) == 4
for result in results:
assert isinstance(result, Profile)
def test_coverage_tuple() -> None:
@dataclass
class Pair:
tuple_: Tuple[Union[int, str], Tuple[Union[int, float], int]]
class TupleFactory(DataclassFactory[Pair]):
__model__ = Pair
results = list(TupleFactory.coverage())
assert len(results) == 2
a0, (b0, c0) = results[0].tuple_
a1, (b1, c1) = results[1].tuple_
assert isinstance(a0, int) and isinstance(b0, int) and isinstance(c0, int)
assert isinstance(a1, str) and isinstance(b1, float) and isinstance(c1, int)
@pytest.mark.parametrize(
"collection_annotation",
(Set[Union[int, str]], List[Union[int, str]], FrozenSet[Union[int, str]]),
)
def test_coverage_collection(collection_annotation: type) -> None:
Collective = make_dataclass("Collective", [("collection", collection_annotation)])
class CollectiveFactory(DataclassFactory[Collective]): # type: ignore
__model__ = Collective
results = list(CollectiveFactory.coverage())
assert len(results) == 1
result = results[0]
collection = result.collection # type: ignore
assert len(collection) == 2
v0, v1 = collection
assert {type(v0), type(v1)} == {int, str}
def test_coverage_literal() -> None:
@dataclass
class Literally:
literal: Literal["a", "b", 1, 2]
class LiterallyFactory(DataclassFactory[Literally]):
__model__ = Literally
results = list(LiterallyFactory.coverage())
assert len(results) == 4
assert results[0].literal == "a"
assert results[1].literal == "b"
assert results[2].literal == 1
assert results[3].literal == 2
def test_coverage_dict() -> None:
@dataclass
class Thesaurus:
dict_simple: Dict[str, int]
dict_more_key_types: Dict[Union[str, int, float], Union[int, str]]
dict_more_value_types: Dict[str, Union[int, str]]
class ThesaurusFactory(DataclassFactory[Thesaurus]):
__model__ = Thesaurus
results = list(ThesaurusFactory.coverage())
assert len(results) == 3
@pytest.mark.skip(reason="Does not support recursive types yet.")
def test_coverage_recursive() -> None:
@dataclass
class Recursive:
r: Union[Recursive, None]
class RecursiveFactory(DataclassFactory[Recursive]):
__model__ = Recursive
results = list(RecursiveFactory.coverage())
assert len(results) == 2
def test_coverage_typed_dict() -> None:
class TypedThesaurus(TypedDict):
number: int
string: str
union: Union[int, str]
collection: List[Union[int, str]]
class TypedThesaurusFactory(TypedDictFactory[TypedThesaurus]):
__model__ = TypedThesaurus
results = list(TypedThesaurusFactory.coverage())
assert len(results) == 2
example = TypedThesaurusFactory.build()
for result in results:
assert result.keys() == example.keys()
def test_coverage_typed_dict_field() -> None:
class TypedThesaurus(TypedDict):
number: int
string: str
union: Union[int, str]
collection: List[Union[int, str]]
class TypedThesaurusFactory(TypedDictFactory[TypedThesaurus]):
__model__ = TypedThesaurus
results = list(TypedThesaurusFactory.coverage())
assert len(results) == 2
example = TypedThesaurusFactory.build()
for result in results:
assert result.keys() == example.keys()
def test_coverage_values_unique() -> None:
@dataclass
class Unique:
uuid: UUID
data: Union[int, str]
class UniqueFactory(DataclassFactory[Unique]):
__model__ = Unique
results = list(UniqueFactory.coverage())
assert len(results) == 2
assert results[0].uuid != results[1].uuid
def test_coverage_post_generated() -> None:
@dataclass
class Model:
i: int
j: int
class Factory(DataclassFactory[Model]):
__model__ = Model
@post_generated
@classmethod
def i(cls, j: int) -> int:
return j + 10
results = list(Factory.coverage())
assert len(results) == 1
assert results[0].i == results[0].j + 10
class CustomInt:
def __init__(self, value: int) -> None:
self.value = value
def test_coverage_parameter_exception() -> None:
@dataclass
class Model:
i: CustomInt
class Factory(DataclassFactory[Model]):
__model__ = Model
with pytest.raises(ParameterException):
list(Factory.coverage())
def test_coverage_optional_field() -> None:
@dataclass
class OptionalInt:
i: Optional[int]
class OptionalIntFactory(DataclassFactory[OptionalInt]):
__model__ = OptionalInt
results = list(OptionalIntFactory.coverage())
assert len(results) == 2
assert isinstance(results[0].i, int)
assert results[1].i is None
def type_exists_at_path_any(objs: Iterable, path: List[Union[int, str]], target_type: Type) -> bool:
return any(type_exists_at_path(obj, path, target_type) for obj in objs)
def type_exists_at_path(obj: Any, path: List[Union[int, str]], target_type: Type) -> bool:
"""Determine if a type exists at a path through a given object
type_exists_at_path(obj, ["i", "*"], int)
returns true if 'obj' contains an iterable attribute called 'i' with an 'int' value
'*' is used to mean any of an iterable
type_exists_at_path(obj, ["i", 5], int)
returns true if 'obj' contains an iterable attribute called 'i' with an 'int' value at the index 5
Direct indexing is useful for checking tuples
:param obj: Object to search through
:param path: List of either indexes or attr keys to dereference
:param target_type: Type to match
:returns: A boolean, True if the type exists at the path, False otherwise
"""
# Handle fully dereferenced item and the end of path
if len(path) == 0:
return isinstance(obj, target_type)
if path[0] == "*":
if not isinstance(obj, Iterable):
return False
for piece in obj:
if type_exists_at_path(piece, path[1:], target_type):
return True
return False
item, success = get_or_index(obj, path[0])
if not success:
return False
return type_exists_at_path(item, path[1:], target_type)
def get_or_index(obj: Any, idx: Union[int, str]) -> Tuple[Any, bool]:
if isinstance(idx, str):
if idx not in dir(obj):
return None, False
return getattr(obj, idx), True
if len(obj) < idx:
return None, False
return obj[idx], True
def test_coverage_optional_list() -> None:
@dataclass
class OptionalIntList:
i: Optional[List[int]]
class OptionalIntFactory(DataclassFactory[OptionalIntList]):
__model__ = OptionalIntList
results = list(OptionalIntFactory.coverage())
assert type_exists_at_path_any(results, ["i"], list)
assert type_exists_at_path_any(results, ["i", "*"], int)
assert type_exists_at_path_any(results, ["i"], NoneType)
def test_optional_lists() -> None:
class Model(BaseModel):
just_a_list: List[int]
optional_list: Optional[List[int]]
optional_nested_list: Optional[List[List[List[int]]]]
results = list(ModelFactory.create_factory(Model).coverage())
assert type_exists_at_path_any(results, ["just_a_list"], list)
assert type_exists_at_path_any(results, ["optional_list"], list)
assert type_exists_at_path_any(results, ["optional_list"], NoneType)
assert type_exists_at_path_any(results, ["optional_nested_list"], NoneType)
assert type_exists_at_path_any(results, ["optional_nested_list", "*"], list)
assert type_exists_at_path_any(results, ["optional_nested_list", "*", "*"], list)
assert type_exists_at_path_any(results, ["optional_nested_list", "*", "*", "*"], int)
def test_tuple_types() -> None:
class Model(BaseModel):
tii: Tuple[int, int]
results = list(ModelFactory.create_factory(Model).coverage())
assert type_exists_at_path_any(results, ["tii"], tuple)
assert type_exists_at_path_any(results, ["tii", 0], int)
assert type_exists_at_path_any(results, ["tii", 1], int)
def test_hetero_tuple_types() -> None:
class Model(BaseModel):
tis: Tuple[int, str]
results = list(ModelFactory.create_factory(Model).coverage())
assert type_exists_at_path_any(results, ["tis"], tuple)
assert type_exists_at_path_any(results, ["tis", 0], int)
assert type_exists_at_path_any(results, ["tis", 1], str)
def test_optional_list_uuid() -> None:
class Model(BaseModel):
maybe_uuids: Optional[List[UUID]]
results = list(ModelFactory.create_factory(Model).coverage())
assert type_exists_at_path_any(results, ["maybe_uuids"], list)
assert type_exists_at_path_any(results, ["maybe_uuids", "*"], UUID)
assert type_exists_at_path_any(results, ["maybe_uuids"], NoneType)
def test_optional_set_uuid() -> None:
class Model(BaseModel):
maybe_uuids: Optional[Set[UUID]]
results = list(ModelFactory.create_factory(Model).coverage())
assert type_exists_at_path_any(results, ["maybe_uuids"], set)
assert type_exists_at_path_any(results, ["maybe_uuids", "*"], UUID)
assert type_exists_at_path_any(results, ["maybe_uuids"], NoneType)
@pytest.mark.skipif(
IS_PYDANTIC_V1,
reason="This should be possible but more work needs to be done",
)
def test_optional_mixed_collections() -> None:
class Model(BaseModel):
maybe_uuids: Optional[Union[Set[UUID], List[UUID]]]
results = list(ModelFactory.create_factory(Model).coverage())
assert type_exists_at_path_any(results, ["maybe_uuids"], set)
assert type_exists_at_path_any(results, ["maybe_uuids"], list)
assert type_exists_at_path_any(results, ["maybe_uuids", "*"], UUID)
assert type_exists_at_path_any(results, ["maybe_uuids"], NoneType)
python-polyfactory-2.21.0/tests/test_typeddict_factory.py 0000664 0000000 0000000 00000004001 15000423051 0023742 0 ustar 00root root 0000000 0000000 from typing import Dict, List, Optional
from annotated_types import Ge
from typing_extensions import Annotated, NotRequired, Required, TypedDict
from pydantic import BaseModel
from polyfactory.factories import TypedDictFactory
from polyfactory.factories.pydantic_factory import ModelFactory
class TypedDictModel(TypedDict):
id: int
name: str
list_field: List[Dict[str, int]]
int_field: Optional[int]
def test_factory_with_typeddict() -> None:
class MyFactory(TypedDictFactory[TypedDictModel]):
__model__ = TypedDictModel
result = MyFactory.build()
assert isinstance(result, dict)
assert result["id"]
assert result["name"]
assert result["list_field"][0]
assert type(result["int_field"]) in (type(None), int)
def test_factory_model_with_typeddict_attribute_value() -> None:
class MyModel(BaseModel):
td: TypedDictModel
name: str
list_field: List[Dict[str, int]]
int_field: Optional[int]
class MyFactory(ModelFactory[MyModel]):
__model__ = MyModel
result = MyFactory.build()
assert isinstance(result.td, dict)
assert result.td["id"]
assert result.td["name"]
assert result.td["list_field"][0]
assert type(result.td["int_field"]) in (type(None), int)
def test_typeddict_with_required_and_non_required_fields() -> None:
class TypedDictModel(TypedDict):
id: Required[int]
name: NotRequired[str]
annotated: Required[Annotated[int, Ge(100)]]
list_field: List[Dict[str, int]]
optional_int: Required[Optional[int]]
class TypedDictModelFactory(TypedDictFactory[TypedDictModel]):
__model__ = TypedDictModel
result = TypedDictModelFactory.build()
assert isinstance(result["id"], int)
assert isinstance(result["annotated"], int)
assert result["annotated"] >= 100
assert isinstance(result["list_field"], list)
assert isinstance(result["optional_int"], (type(None), int))
assert "name" in result
assert isinstance(result["name"], str)
python-polyfactory-2.21.0/tests/test_utils.py 0000664 0000000 0000000 00000016004 15000423051 0021370 0 ustar 00root root 0000000 0000000 import random
import sys
import textwrap
from decimal import Decimal
from types import ModuleType
from typing import Any, Callable, NewType, Union
import pytest
from hypothesis import given
from hypothesis.strategies import decimals, floats, integers
from pydantic import BaseModel
from polyfactory.factories.pydantic_factory import ModelFactory
from polyfactory.utils.helpers import unwrap_annotation, unwrap_new_type
from polyfactory.utils.predicates import is_new_type, is_union
from polyfactory.value_generators.constrained_numbers import (
is_multiply_of_multiple_of_in_range,
)
def test_is_union() -> None:
class UnionTest(BaseModel):
union: Union[int, str]
no_union: Any
class UnionTestFactory(ModelFactory):
__model__ = UnionTest
for field_meta in UnionTestFactory.get_model_fields():
if field_meta.name == "union":
assert is_union(field_meta.annotation)
else:
assert not is_union(field_meta.annotation)
# for python 3.10 we need to run the test as well with the union_pipe operator
if sys.version_info >= (3, 10):
class UnionTestWithPipe(BaseModel):
union_pipe: int | str | None # Pipe syntax supported from Python 3.10 onwards
union_normal: Union[int, str]
no_union: Any
class UnionTestWithPipeFactory(ModelFactory):
__model__ = UnionTestWithPipe
for field_meta in UnionTestWithPipeFactory.get_model_fields():
if field_meta.name in ("union_pipe", "union_normal"):
assert is_union(field_meta.annotation)
else:
assert not is_union(field_meta.annotation)
def test_is_new_type() -> None:
assert is_new_type(NewType("MyInt", int))
assert not is_new_type(int)
def test_unwrap_new_type_is_needed() -> None:
MyInt = NewType("MyInt", int)
WrappedInt = NewType("WrappedInt", MyInt)
assert unwrap_new_type(MyInt) is int
assert unwrap_new_type(WrappedInt) is int
assert unwrap_new_type(int) is int
def test_is_multiply_of_multiple_of_in_range_extreme_cases() -> None:
assert is_multiply_of_multiple_of_in_range(minimum=0.0, maximum=10.0, multiple_of=20.0)
assert not is_multiply_of_multiple_of_in_range(minimum=5.0, maximum=10.0, multiple_of=20.0)
assert is_multiply_of_multiple_of_in_range(minimum=1.0, maximum=1.0, multiple_of=0.33333333333)
assert is_multiply_of_multiple_of_in_range(
minimum=Decimal(1),
maximum=Decimal(1),
multiple_of=Decimal("0.33333333333"),
)
assert not is_multiply_of_multiple_of_in_range(minimum=Decimal(1), maximum=Decimal(1), multiple_of=Decimal("0.333"))
assert is_multiply_of_multiple_of_in_range(minimum=5, maximum=5, multiple_of=5)
# while multiple_of=0.0 leads to ZeroDivision exception in pydantic
# it can handle values close to zero properly, so we should support this too
assert is_multiply_of_multiple_of_in_range(minimum=10.0, maximum=20.0, multiple_of=1e-10)
# test corner case found by peterschutt
assert not is_multiply_of_multiple_of_in_range(
minimum=Decimal("999999999.9999999343812775"),
maximum=Decimal("999999999.990476"),
multiple_of=Decimal("-0.556"),
)
@given(
floats(allow_nan=False, allow_infinity=False, min_value=1e-6, max_value=1000000000),
integers(min_value=-100000, max_value=100000),
)
def test_is_multiply_of_multiple_of_in_range_for_floats(base_multiple_of: float, multiplier: int) -> None:
if multiplier != 0:
for multiple_of in [base_multiple_of, -base_multiple_of]:
minimum, maximum = sorted(
[
multiplier * multiple_of + random.random() * 100,
(multiplier + random.randint(1, 100)) * multiple_of + random.random() * 100,
],
)
assert is_multiply_of_multiple_of_in_range(minimum=minimum, maximum=maximum, multiple_of=multiple_of)
minimum, maximum = sorted(
[
(multiplier + (random.random() / 2 + 0.01)) * multiple_of,
(multiplier + (random.random() / 2 + 0.45)) * multiple_of,
],
)
assert not is_multiply_of_multiple_of_in_range(minimum=minimum, maximum=maximum, multiple_of=multiple_of)
@given(
integers(min_value=-1000000000, max_value=1000000000),
integers(min_value=-100000, max_value=100000),
)
def test_is_multiply_of_multiple_of_in_range_for_int(base_multiple_of: int, multiplier: int) -> None:
if multiplier != 0 and base_multiple_of not in [-1, 0, 1]:
for multiple_of in [base_multiple_of, -base_multiple_of]:
minimum, maximum = sorted(
[
multiplier * multiple_of + random.randint(1, 100),
(multiplier + random.randint(1, 100)) * multiple_of + random.randint(1, 100),
],
)
assert is_multiply_of_multiple_of_in_range(minimum=minimum, maximum=maximum, multiple_of=multiple_of)
@pytest.mark.skip(reason="fails on edge cases")
@given(
decimals(min_value=Decimal("-1000000000"), max_value=Decimal("1000000000")),
integers(min_value=-100000, max_value=100000),
)
def test_is_multiply_of_multiple_of_in_range_for_decimals(base_multiple_of: Decimal, multiplier: int) -> None:
if multiplier != 0 and base_multiple_of != 0:
for multiple_of in [base_multiple_of, -base_multiple_of]:
minimum, maximum = sorted(
[
multiplier * multiple_of + Decimal(random.random() * 100),
(multiplier + random.randint(1, 100)) * multiple_of + Decimal(random.random() * 100),
],
)
assert is_multiply_of_multiple_of_in_range(minimum=minimum, maximum=maximum, multiple_of=multiple_of)
minimum, maximum = sorted(
[
(multiplier + Decimal(random.random() / 2 + 0.01)) * multiple_of,
(multiplier + Decimal(random.random() / 2 + 0.45)) * multiple_of,
],
)
assert not is_multiply_of_multiple_of_in_range(minimum=minimum, maximum=maximum, multiple_of=multiple_of)
def test_unwrap_legacy_type_alias(create_module: Callable[[str], ModuleType]) -> None:
"""Check that legacy type aliases are properly unwrapped."""
module = create_module(
textwrap.dedent("""
from typing_extensions import TypeAlias
MyIntLegacyAlias: TypeAlias = int
""")
)
unwrapped = unwrap_annotation(module.MyIntLegacyAlias, random=random.SystemRandom())
assert unwrapped is int
@pytest.mark.skipif(sys.version_info < (3, 12), reason="3.12 only syntax")
def test_unwrap_pep695_type_alias(create_module: Callable[[str], ModuleType]) -> None:
"""Check that PEP 695 type aliases are properly unwrapped.
See issue #683.
"""
module = create_module(
textwrap.dedent("""
type MyInt = int
""")
)
unwrapped = unwrap_annotation(module.MyInt, random=random.SystemRandom())
assert unwrapped is int
python-polyfactory-2.21.0/tests/typing_test_strict.py 0000664 0000000 0000000 00000001705 15000423051 0023134 0 ustar 00root root 0000000 0000000 """Module exists only to test generic boundaries.
Filename should not start with "test_".
"""
import dataclasses
from typing import TypedDict
import pydantic.dataclasses
from pydantic import BaseModel
from polyfactory.factories import DataclassFactory, TypedDictFactory
from polyfactory.factories.pydantic_factory import ModelFactory
class PydanticClass(BaseModel):
field: str
class PydanticClassFactory(ModelFactory[PydanticClass]):
__model__ = PydanticClass
@pydantic.dataclasses.dataclass
class PydanticDataClass:
field: str
class PydanticDataClassFactory(DataclassFactory[PydanticDataClass]):
__model__ = PydanticDataClass
@dataclasses.dataclass()
class PythonDataClass:
field: str
class PythonDataClassFactory(DataclassFactory[PythonDataClass]):
__model__ = PythonDataClass
class TypedDictClass(TypedDict):
field: str
class TypedDictClassFactory(TypedDictFactory[TypedDictClass]):
__model__ = TypedDictClass
python-polyfactory-2.21.0/tests/utils/ 0000775 0000000 0000000 00000000000 15000423051 0017756 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/tests/utils/test_deprecation.py 0000664 0000000 0000000 00000000776 15000423051 0023676 0 ustar 00root root 0000000 0000000 from __future__ import annotations
import pytest
from polyfactory.utils.deprecation import check_for_deprecated_parameters
def test_parameter_deprecation() -> None:
def my_func(a: int, b: int | None = None) -> None:
check_for_deprecated_parameters("5", parameters=(("b", b),))
with pytest.warns(
DeprecationWarning,
match="Use of deprecated parameter 'b'. Deprecated in polyfactory 5. This parameter will be removed in the next major version",
):
my_func(1, 2)
python-polyfactory-2.21.0/tests/utils/test_frozendict.py 0000664 0000000 0000000 00000000524 15000423051 0023537 0 ustar 00root root 0000000 0000000 import pytest
from polyfactory.utils.types import Frozendict
def test_frozendict_immutable() -> None:
instance = Frozendict({"bar": "foo"})
with pytest.raises(TypeError, match="Unable to mutate Frozendict"):
instance["foo"] = "bar"
def test_frozendict_hashable() -> None:
assert isinstance(hash(Frozendict()), int)
python-polyfactory-2.21.0/tools/ 0000775 0000000 0000000 00000000000 15000423051 0016614 5 ustar 00root root 0000000 0000000 python-polyfactory-2.21.0/tools/build_docs.py 0000664 0000000 0000000 00000002622 15000423051 0021277 0 ustar 00root root 0000000 0000000 from __future__ import annotations
import argparse
import shutil
import subprocess
from contextlib import contextmanager
from pathlib import Path
REDIRECT_TEMPLATE = """
<!DOCTYPE HTML>
<html lang="en-US">
<head>
<title>Page Redirection
You are being redirected. If this does not work, click this link