mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
Code Issues 25 Releases Wiki Activity

Fixed #35179 -- Made admindocs detect positional/keyword-only arguments.

Browse Source
This commit is contained in:
Salvo Polizzi 2024-02-10 17:50:55 +01:00 committed by Mariusz Felisiak
parent bf692b2fdc
commit e6fa74f020
3 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
django/utils/inspect.py
View File

@ -68,9 +68,7 @@ def func_accepts_var_args(func):
def method_has_no_args(meth): def method_has_no_args(meth):
"""Return True if a method only accepts 'self'.""" """Return True if a method only accepts 'self'."""
count = len( count = len([p for p in _get_callable_parameters(meth) if p.kind in ARG_KINDS])
[p for p in _get_callable_parameters(meth) if p.kind == p.POSITIONAL_OR_KEYWORD]
)
return count == 0 if inspect.ismethod(meth) else count == 1 return count == 0 if inspect.ismethod(meth) else count == 1

6
tests/admin_docs/models.py
View File

@ -54,6 +54,12 @@ class Person(models.Model):
def dummy_function(self, baz, rox, *some_args, **some_kwargs): def dummy_function(self, baz, rox, *some_args, **some_kwargs):
return some_kwargs return some_kwargs
def dummy_function_keyword_only_arg(self, *, keyword_only_arg):
return keyword_only_arg
def all_kinds_arg_function(self, position_only_arg, /, arg, *, kwarg):
return position_only_arg, arg, kwarg
@property @property
def a_property(self): def a_property(self):
return "a_property" return "a_property"

4
tests/admin_docs/test_views.py
View File

@ -280,6 +280,8 @@ class TestModelDetailView(TestDataMixin, AdminDocsTestCase):
self.assertContains(self.response, "<h3>Methods with arguments</h3>") self.assertContains(self.response, "<h3>Methods with arguments</h3>")
self.assertContains(self.response, "<td>rename_company</td>") self.assertContains(self.response, "<td>rename_company</td>")
self.assertContains(self.response, "<td>dummy_function</td>") self.assertContains(self.response, "<td>dummy_function</td>")
self.assertContains(self.response, "<td>dummy_function_keyword_only_arg</td>")
self.assertContains(self.response, "<td>all_kinds_arg_function</td>")
self.assertContains(self.response, "<td>suffix_company_name</td>") self.assertContains(self.response, "<td>suffix_company_name</td>")
def test_methods_with_arguments_display_arguments(self): def test_methods_with_arguments_display_arguments(self):
@ -287,6 +289,7 @@ class TestModelDetailView(TestDataMixin, AdminDocsTestCase):
Methods with arguments should have their arguments displayed. Methods with arguments should have their arguments displayed.
""" """
self.assertContains(self.response, "<td>new_name</td>") self.assertContains(self.response, "<td>new_name</td>")
self.assertContains(self.response, "<td>keyword_only_arg</td>")
def test_methods_with_arguments_display_arguments_default_value(self): def test_methods_with_arguments_display_arguments_default_value(self):
""" """
@ -302,6 +305,7 @@ class TestModelDetailView(TestDataMixin, AdminDocsTestCase):
self.assertContains( self.assertContains(
self.response, "<td>baz, rox, *some_args, **some_kwargs</td>" self.response, "<td>baz, rox, *some_args, **some_kwargs</td>"
) )
self.assertContains(self.response, "<td>position_only_arg, arg, kwarg</td>")
def test_instance_of_property_methods_are_displayed(self): def test_instance_of_property_methods_are_displayed(self):
"""Model properties are displayed as fields.""" """Model properties are displayed as fields."""