Allow staticmethods to be detected as test functions by waisbrot · Pull Request #2531 · pytest-dev/pytest

waisbrot · 2017-06-26T17:46:35Z

Allow a class method decorated @staticmethod to be collected as a test function
(if it meets the usual criteria).

Add a new news fragment into the changelog folder
Target: for bugfix, vendor, doc or trivial fixes, target master; for removals or features target features;
Make sure to include reasonable tests for your change if necessary
Add yourself to AUTHORS;

robert-cody · 2017-06-26T17:49:33Z

testing/python/collect.py

            "*collected 0*",
        ])

+    def test_staticmethid(self, testdir):


test_static_method or test_staticmethod would be better

Spelling fix: argh, yes. Underscores: happy to change it but I was copying the decorator name and the method just below named test_setup_teardown_class_as_classmethod (for the @classmethod decorator)

The-Compiler · 2017-06-26T17:57:50Z

Thanks! This should go to features though, IMHO.

nicoddemus · 2017-06-26T18:06:03Z

This should go to features though, IMHO.

Definitely. 👍

Also, please rename the changelog entry to 2528.feature

waisbrot · 2017-06-26T18:11:59Z

Changed it to a feature and changed the target branch to features.

coveralls · 2017-06-26T18:17:33Z

Coverage increased (+0.002%) to 92.14% when pulling bd3c7ef on waisbrot:staticmethods into 6e2b5a3 on pytest-dev:master.

nicoddemus · 2017-06-26T18:19:28Z

Thanks!

coveralls · 2017-06-26T19:00:51Z

Coverage increased (+0.002%) to 92.155% when pulling beb63d2 on waisbrot:staticmethods into 9b51fc6 on pytest-dev:features.

blueyed · 2017-06-26T20:13:10Z

Seems to fail with "py26" (restarted out of current habit).

RonnyPfannschmidt

i like it and i'd like to hear other opinions

RonnyPfannschmidt · 2017-06-26T21:30:58Z

python 2.6 needs support code - we do have a helper for that

waisbrot · 2017-06-26T23:09:01Z

Sorry I didn't try the fix on 2.6 earlier.

The 2.6 failure is because 2.6 staticmethods are different -- they don't have the __func__ reference that I was using to unwrap them in 2.7 and beyond. I'll look for how I can do it in 2.6, but suggestions are welcome.

@RonnyPfannschmidt can you point me to the 2.6 helper-code you mentioned?

RonnyPfannschmidt · 2017-06-27T05:33:30Z

i was wrong, the helper cant apply because the functionality cant work on python 2.6

i propose intentionally leaving it crippled on python2.6 and skipping the tests there + adding a comment

the problem is that staticmethod on python26 doesn't expose __func__ or other attributes,

one can abuse __get__ to obtain it, but i oppose cripling our code more just to keep python2.6 working

The-Compiler · 2017-06-27T07:58:34Z

By the way, are staticmethods always guaranteed to have a __func__ outside of Python 2.6? Should we use safe_getattr to get it? Should we just ignore when it hasn't been found?

RonnyPfannschmidt · 2017-06-27T07:59:32Z

@The-Compiler as far as i can tell its supported on all python versions that are not EOL

RonnyPfannschmidt · 2017-06-27T08:00:18Z

i propose simply issuing a warning if the attribute is not present

waisbrot · 2017-06-27T13:55:16Z

Thanks for all the comments! I pushed a new version where I attempt to implement @RonnyPfannschmidt's suggestion: if it looks like a test, and it's a static method, but we can't find a __func__, issue a warning and don't collect.
The test for this expects to collect nothing on 2.6 and below and succeed otherwise. I tested locally with 2.6, 2.7, and 3.6.

The-Compiler · 2017-06-27T14:07:47Z

_pytest/python.py

+                    self.warn(code="C2", message="cannot collect static method %r because it is not a function (always the case in Python 2.6)" % name)
+            return (
+                safe_getattr(obj, "__call__", False) and fixtures.getfixturemarker(obj) is None
+            )


There should probably be a return False here?

coveralls · 2017-06-27T14:29:17Z

Coverage decreased (-0.007%) to 92.147% when pulling fc400b2 on waisbrot:staticmethods into 9b51fc6 on pytest-dev:features.

coveralls · 2017-06-27T15:27:23Z

Coverage decreased (-0.02%) to 92.137% when pulling 0a9489d on waisbrot:staticmethods into 9b51fc6 on pytest-dev:features.

nicoddemus

Thanks a lot! Just asking for two small changes which once addressed it can be merged IMHO.

nicoddemus · 2017-06-27T15:42:55Z

testing/python/collect.py

+        result = testdir.runpytest()
+        if sys.version_info < (2,7):
+            # in 2.6, the code to handle static methods doesn't work
+            result.stdout.fnmatch_lines(["*collected 0*"])


Please improve matching here:

if sys.version_info < (2, 7): result.stdout.fnmatch_lines([ "*collected 0 items*", "*cannot collect static method*", ]) else: result.stdout.fnmatch_lines([ "*collected 1*", "*1 passed in*", ])

This way we ensure that we are showing the appropriate warning and that we are collecting and running it in Py27+.

nicoddemus · 2017-06-27T15:43:53Z

_pytest/python.py

+                    return False
+            return (
+                safe_getattr(obj, "__call__", False) and fixtures.getfixturemarker(obj) is None
+            )


For consistency please return False in case you don't execute the block inside if self.funcnamefilter(name) or self.isnosetest(obj):.

waisbrot · 2017-06-27T22:42:01Z

I'll push the requested changes on Thursday. (I love how quickly this got reviewed but I'm away from my editor)

nicoddemus · 2017-06-28T02:50:39Z

Sure thing, no rush, and thanks again!

Allow a class method decorated `@staticmethod` to be collected as a test function (if it meets the usual criteria). This feature will not work in Python 2.6 -- static methods will still be ignored there.

coveralls · 2017-06-29T12:37:17Z

Coverage decreased (-0.02%) to 92.138% when pulling 9b9fede on waisbrot:staticmethods into 9b51fc6 on pytest-dev:features.

RonnyPfannschmidt · 2017-06-29T14:19:09Z

thanks, well done 👍

waisbrot · 2017-06-29T14:21:44Z

Thank you! This was a fun PR. You're all doing an awesome job of making contributions easy!

robert-cody reviewed Jun 26, 2017

View reviewed changes

waisbrot force-pushed the staticmethods branch from 362c72c to 35e385e Compare June 26, 2017 18:08

waisbrot changed the base branch from master to features June 26, 2017 18:10

waisbrot force-pushed the staticmethods branch from 35e385e to bd3c7ef Compare June 26, 2017 18:11

nicoddemus approved these changes Jun 26, 2017

View reviewed changes

waisbrot force-pushed the staticmethods branch from bd3c7ef to beb63d2 Compare June 26, 2017 18:20

RonnyPfannschmidt approved these changes Jun 26, 2017

View reviewed changes

waisbrot force-pushed the staticmethods branch from beb63d2 to fc400b2 Compare June 27, 2017 13:50

The-Compiler reviewed Jun 27, 2017

View reviewed changes

waisbrot force-pushed the staticmethods branch from fc400b2 to 0a9489d Compare June 27, 2017 14:13

nicoddemus requested changes Jun 27, 2017

View reviewed changes

allow staticmethods to be detected as test functions

9b9fede

Allow a class method decorated `@staticmethod` to be collected as a test function (if it meets the usual criteria). This feature will not work in Python 2.6 -- static methods will still be ignored there.

waisbrot force-pushed the staticmethods branch from 0a9489d to 9b9fede Compare June 29, 2017 11:44

RonnyPfannschmidt merged commit 0303d95 into pytest-dev:features Jun 29, 2017

waisbrot deleted the staticmethods branch June 29, 2017 14:21

nicoddemus mentioned this pull request Aug 17, 2017

staticmethod functions are not collected for testing #2528

Closed

nicoddemus mentioned this pull request Dec 1, 2022

Inconsistent support for staticmethod/classmethod #10525

Closed

Uh oh!

Conversation

waisbrot commented Jun 26, 2017

Uh oh!

robert-cody Jun 26, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

waisbrot Jun 26, 2017

Choose a reason for hiding this comment

Uh oh!

The-Compiler commented Jun 26, 2017

Uh oh!

nicoddemus commented Jun 26, 2017

Uh oh!

waisbrot commented Jun 26, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coveralls commented Jun 26, 2017

Uh oh!

nicoddemus commented Jun 26, 2017

Uh oh!

coveralls commented Jun 26, 2017

Uh oh!

blueyed commented Jun 26, 2017

Uh oh!

RonnyPfannschmidt left a comment

Choose a reason for hiding this comment

Uh oh!

RonnyPfannschmidt commented Jun 26, 2017

Uh oh!

waisbrot commented Jun 26, 2017

Uh oh!

RonnyPfannschmidt commented Jun 27, 2017

Uh oh!

The-Compiler commented Jun 27, 2017

Uh oh!

RonnyPfannschmidt commented Jun 27, 2017

Uh oh!

RonnyPfannschmidt commented Jun 27, 2017

Uh oh!

waisbrot commented Jun 27, 2017

Uh oh!

The-Compiler Jun 27, 2017

Choose a reason for hiding this comment

Uh oh!

coveralls commented Jun 27, 2017

Uh oh!

coveralls commented Jun 27, 2017

Uh oh!

nicoddemus left a comment

Choose a reason for hiding this comment

Uh oh!

nicoddemus Jun 27, 2017

Choose a reason for hiding this comment

Uh oh!

nicoddemus Jun 27, 2017

Choose a reason for hiding this comment

Uh oh!

waisbrot commented Jun 27, 2017 via email

Uh oh!

nicoddemus commented Jun 28, 2017

Uh oh!

coveralls commented Jun 29, 2017

Uh oh!

RonnyPfannschmidt commented Jun 29, 2017

Uh oh!

waisbrot commented Jun 29, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

robert-cody Jun 26, 2017 •

edited

Loading

waisbrot commented Jun 26, 2017 •

edited

Loading