feat: v3 - Make polyfactory an optional dependency (#4062)

Remove polyfactory from default dependencies

Author: provinzkraut

docs/examples/openapi/generating_examples.py

@@ -0,0 +1,10 @@
+from litestar import Litestar
+from litestar.openapi.config import OpenAPIConfig
+
+app = Litestar(
+    openapi_config=OpenAPIConfig(
+        title="My API",
+        version="0.1.0",
+        create_examples=True,
+    ),
+)

docs/getting-started.rst

@@ -62,6 +62,9 @@ Installation
     :doc:`Mako Templating </usage/templating>`
         :code:`pip install litestar[mako]`
 
+    :ref:`Polyfactory to generate OpenAPI examples <usage/openapi/schema_generation:Generating examples>`
+        :code:`pip install litestar[structlog]`
+
     Standard Installation (includes Uvicorn and Jinja2 templating):
         :code:`pip install litestar[standard]`
 

docs/release-notes/whats-new-3.rst

@@ -281,3 +281,11 @@ The unsupported ``body`` parameter of :class:`~.ASGIStreamingResponse`
 and :class:`.ASGIFileResponse` has been removed.
 
 This does not change any behaviour, as this parameter was previously ignored.
+
+
+``polyfactory`` package removed from default dependencies
+----------------------------------------------------------
+
+The `polyfactory <https://polyfactory.litestar.dev/>`_ library is not included by
+default anymore, and has been moved to the ``litestar[polyfactory]`` package extra. It
+is also included in ``litestar[full]``.

docs/usage/openapi/schema_generation.rst

@@ -319,3 +319,17 @@ The above example will result in an OpenAPI schema object that looks like this:
    converter. To work around this, Litestar will honor an `alias` field provided to the
    `dataclass.field <https://docs.python.org/3/library/dataclasses.html#dataclasses.field>`_ metadata
    when generating the field name in the schema.
+
+
+Generating examples
+-------------------
+
+Litestar can automatically generate examples for the ``example`` section of a schema.
+To enable this feature, you'll need to have the
+`polyfactory <https://polyfactory.litestar.dev/>`_ library installed, which is included
+as a package extra under ``litestar[polyfactory`` and ``litestar[full]``.
+
+Once installed, you can turn on example generation via the OpenAPI config:
+
+.. literalinclude:: /examples/openapi/customize_pydantic_model_name.py
+    :language: python

pyproject.toml

@@ -37,7 +37,6 @@ dependencies = [
   "importlib-metadata; python_version < \"3.10\"",
   "msgspec>=0.19.0",
   "multidict>=6.0.2",
-  "polyfactory>=2.6.3",
   "pyyaml",
   "typing-extensions",
   "click",
@@ -83,8 +82,8 @@ brotli = ["brotli"]
 cli = ["jsbeautifier", "uvicorn[standard]", "uvloop>=0.18.0; sys_platform != 'win32'"]
 cryptography = ["cryptography"]
 full = [
-  "litestar[annotated-types,attrs,brotli,cli,cryptography,jinja,jwt,mako,minijinja,opentelemetry,piccolo,picologging,prometheus,pydantic,redis,sqlalchemy,standard,structlog,valkey]; python_version < \"3.13\"",
-  "litestar[annotated-types,attrs,brotli,cli,cryptography,jinja,jwt,mako,minijinja,opentelemetry,piccolo,prometheus,pydantic,redis,sqlalchemy,standard,structlog,valkey]; python_version >= \"3.13\"",
+  "litestar[annotated-types,attrs,brotli,cli,cryptography,jinja,jwt,mako,minijinja,opentelemetry,piccolo,polyfactory,picologging,prometheus,pydantic,redis,sqlalchemy,standard,structlog,valkey]; python_version < \"3.13\"",
+  "litestar[annotated-types,attrs,brotli,cli,cryptography,jinja,jwt,mako,minijinja,opentelemetry,piccolo,polyfactory,prometheus,pydantic,redis,sqlalchemy,standard,structlog,valkey]; python_version >= \"3.13\"",
 ]
 jinja = ["jinja2>=3.1.2"]
 jwt = ["cryptography", "pyjwt>=2.9.0"]
@@ -110,6 +109,7 @@ standard = [
 ]
 structlog = ["structlog"]
 valkey = ["valkey[libvalkey]>=6.0.2"]
+polyfactory = ["polyfactory>=2.6.3"]
 
 [project.scripts]
 litestar = "litestar.__main__:run_cli"