tortoise-orm Re-added support for __set_name__ as the Python class datamodel presc…

Re-added support for __set_name__ as the Python class datamodel presc…

Open wolph opened this issue 3 years ago • 2 comments

The Python class datamodel normally supports the set_name method on a class, allowing you to do:

class A:
    x = C()  # Automatically calls: x.__set_name__(A, 'x')

This is a very useful feature for custom fields but the Model metaclass has removed this functionality. With this small patch it's re-added.

Description

Add __set_name__ support to the Model metaclass Add a __set_name__ type stub to Field because mypy doesn't support __set_name__ yet: https://github.com/python/mypy/issues/8057 Added a test to confirm it works

Motivation and Context

I'm building a native Postgres enum field, and having the name of the field available in the class makes this a lot easier. Instead of doing this:

class SomeModel(Model):
    some_enum = EnumField('some_enum')

I can now do:

class SomeModel(Model):
    some_enum = EnumField()

How Has This Been Tested?

I've added a simple test to confirm that the test works. And I've run make test and make style ci

Checklist:

[x] My code follows the code style of this project.
[ ] My change requires a change to the documentation.
[ ] I have updated the documentation accordingly.
[x] I have added the changelog accordingly.
[x] I have read the CONTRIBUTING document.
[x] I have added tests to cover my changes.
[x] All new and existing tests passed.

Mar 12 '22 02:03 wolph

Since we're testing with pytest, it might be beneficial to allow assert statements within the tests at least :) https://docs.pytest.org/en/latest/how-to/assert.html

Mar 12 '22 02:03 wolph