This repository was archived by the owner on Aug 19, 2025. It is now read-only.
Repository navigation
This repository was archived by the owner on Aug 19, 2025. It is now read-only.
Creating records with empty ForeignKeys fails by default, even when allow_null is True #162
Description
Checklist
- The bug is reproducible against the latest release and/or
master. - There are no similar issues or pull requests to fix it yet.
Describe the bug
When defining a model with a foreign key, validation will always fail on object creation unless the foreign key relationship is non-null.
This is because the allow_null value is not passed through to the validator that's created along with the field (see https://github.com/encode/orm/blob/master/orm/fields.py#L152-L154).
A workaround is to create the field outside of the model, and manually set a default value. E.g.:
company_fk = ForeignKey(ContactList, allow_null=True)
company_fk.validator.default = None
class Employee(orm.Model):
tablename = "employee"
registry = models
fields = {
"id": orm.Integer(primary_key=True, unique=True),
"company": company_fk,
}What we should really do is somehow cascade the allow_null value to the validator so it can validate appropriately.
To reproduce
Define a model like the following, with a foreign key & allow_null set to True.
class Employee(orm.Model):
tablename = "employee"
registry = models
fields = {
"id": orm.Integer(primary_key=True, unique=True),
"company": ForeignKey(ContactList, allow_null=True),
}Create the table, and then run in a shell:
await Employee.objects.create()Expected behavior
An employee is created.
Actual behavior
The following runtime exception occurs.
Expand for details
Traceback (most recent call last):
File "/projects/__pypackages__/3.10/lib/uvicorn/protocols/http/h11_impl.py", line 403, in run_asgi
result = await app(self.scope, self.receive, self.send)
File "/projects/__pypackages__/3.10/lib/uvicorn/middleware/proxy_headers.py", line 78, in __call__
return await self.app(scope, receive, send)
File "/projects/__pypackages__/3.10/lib/starlette/applications.py", line 124, in __call__
await self.middleware_stack(scope, receive, send)
File "/projects/__pypackages__/3.10/lib/starlette/middleware/errors.py", line 184, in __call__
raise exc
File "/projects/__pypackages__/3.10/lib/starlette/middleware/errors.py", line 162, in __call__
await self.app(scope, receive, _send)
File "/projects/__pypackages__/3.10/lib/starlette/middleware/exceptions.py", line 75, in __call__
raise exc
File "/projects/__pypackages__/3.10/lib/starlette/middleware/exceptions.py", line 64, in __call__
await self.app(scope, receive, sender)
File "/projects/__pypackages__/3.10/lib/starlette/routing.py", line 680, in __call__
await route.handle(scope, receive, send)
File "/projects/__pypackages__/3.10/lib/starlette/routing.py", line 427, in handle
await self.app(scope, receive, send)
File "/projects/__pypackages__/3.10/lib/starlette/routing.py", line 680, in __call__
await route.handle(scope, receive, send)
File "/projects/__pypackages__/3.10/lib/starlette/routing.py", line 275, in handle
await self.app(scope, receive, send)
File "/projects/__pypackages__/3.10/lib/starlette/routing.py", line 65, in app
response = await func(request)
File "/projects/./app/endpoints.py", line 34, in contacts_post
contact, _ = await Contact.objects.get_or_create(
File "/projects/__pypackages__/3.10/lib/orm/models.py", line 449, in get_or_create
instance = await self.create(**kwargs)
File "/projects/__pypackages__/3.10/lib/orm/models.py", line 402, in create
kwargs = validator.validate(kwargs)
File "/projects/__pypackages__/3.10/lib/typesystem/schemas.py", line 71, in validate
raise ValidationError(messages=error_messages)
typesystem.base.ValidationError: {'company': 'This field is required.'}
Environment
- OS: 12.4 (21F79)
- Python version: Python 3.10.5
- ORM version: 0.3.1
Activity
dlo commentedon Aug 7, 2022
Looks like this has been fixed with ea14b68, but it's not been released yet.