Fix and improve tests for Python != 3.7 by Jamim · Pull Request #95 · open-telemetry/opentelemetry-python

Jamim · 2019-08-20T22:49:14Z

Hello everyone,

I believe it would be nice to have tests on CI not only for Python 3.7, but for all supported Python versions.

These changes:

~~fix test_span_members test~~ (already fixed by Fix test failures involving contextvars. #96)
fix compatibility with Python 3.5 and 3.4
add tests for various Python versions on CI
allow running tests for any branches
~~relax the pylint rule for constants~~ (moved to Relax the pylint rule for constants #108)
~~update isort settings~~ (moved to Describe isort's multi_line_output setting #109)

Cheers!

carlosalberto · 2019-08-20T23:03:05Z

.travis.yml

+  - '3.6'
  - '3.7'
+  - 'pypy3.5'
+  - '3.8-dev'


Nice. However, we really don't need to have 3.8-dev, and specially the nightly one, IHMO (even with the allow_failures flag) ;)

I don't think there's any benefit IHMO. dev can change relatively a lot. I don't think there's any value in having it here honestly (unless we were married to some internal or prototype feature of it).

Anyway, I wouldn't totally be against this, so I will leave others give their opinion ;)

Python 3.8 is almost there, so it makes sense to have tests for it.

In addition, I believe that it's always better to know about any incompatibilities sooner rather than later.
Especially if running the tests costs nothing.

It does make builds slower. But I have no strong opinion on dev either. I also believe that nightly is too much, things can still change there so if we fix an error in nightly and then nightly changes to make the fix unnecessary, we wasted time.

Hi @carlosalberto and @Oberon00,
I've removed nightly for now.

a-feld · 2019-08-20T23:07:21Z

Hi @Jamim thanks for your PR! 🎉

Python 3.4 has reached end of life and I would imagine OpenTelemetry would not add support for this version of Python since this software will be released after the end-of-life.

That being said, ultimately the maintainers have control over the project direction regarding Python 3.4 😄

carlosalberto · 2019-08-20T23:11:04Z

opentelemetry-api/src/opentelemetry/trace/__init__.py


 from contextlib import contextmanager
-import typing
+from typing import Callable


IIRC we decided to import modules, i.e. typing, rather than importing individual members (not sure we documented it anywhere, btw).

Please reconsider this.

_TRACER_FACTORY: typing.Optional[ typing.Callable[[typing.Type[Tracer]], typing.Optional[Tracer]]] = None

looks really terrible.

One could also argue the same with importing a different class per line ;) I've never liked this in Java, for example. You can also always put each parameter in a new line. Oh well, a matter of taste, I guess.

Maybe @reyang happens to remember whether we had some style guidelines?

One could also argue the same with importing a different class per line ;)

We have to say "thank you" to isort for that.

I'd like to propose to change preferences for isort to make imports less ugly.

This was documented in #36. I'm not entirely sure but if isort doesn't complain it should be fine? My opinion was that we definitely must not have from x import y with the same x multiple times (like this does), and we definitely must not have an import x, y (multiple modules in the same import). If we want to discuss other aspects, we should not do this here but reopen #36 or create a new issue. I agree that both possibilities that isort allows now are suboptimal (multiple from import for the same module is something I definitely don't want though).

I've updated isort settings in c9821ec.

Related PR: #109

Jamim · 2019-08-20T23:12:10Z

Hello @a-feld,

Thank you for the feedback.
Actually, I know that 3.4 was EOLed.
To be honest, I always prefer to not support EOLed Python versions, but it was already there, so I kept it.
I can remove support for Python 3.4 if everyone agrees.

carlosalberto · 2019-08-20T23:13:08Z

Python 3.4 has reached end of life and I would imagine OpenTelemetry would not add support for this version of Python since this software will be released after the end-of-life.

I'm wondering about this too. Initially we decided to support this, but I started having second thoughts on this ;)

Worth discussing it again in #25 (and maybe in the SIG this Thursday as well).

Oberon00 · 2019-08-21T11:35:07Z

ext/opentelemetry-ext-wsgi/tests/test_wsgi_middleware.py

                self.assertEqual(value, b"*")
            except StopIteration:
-                self.span_context_manager.__exit__.assert_called()
+                self.span_context_manager.__exit__.assert_called_with(


Too bad we need this change. 🙁 Which Python version requires it?

We need it for 3.5 and 3.4.
The assert_called method was introduced in 3.6.

tox.ini

Oberon00 · 2019-08-21T11:46:01Z

opentelemetry-api/src/opentelemetry/trace/__init__.py


 from contextlib import contextmanager
-import typing
+from typing import Callable


This was documented in #36. I'm not entirely sure but if isort doesn't complain it should be fine? My opinion was that we definitely must not have from x import y with the same x multiple times (like this does), and we definitely must not have an import x, y (multiple modules in the same import). If we want to discuss other aspects, we should not do this here but reopen #36 or create a new issue. I agree that both possibilities that isort allows now are suboptimal (multiple from import for the same module is something I definitely don't want though).

opentelemetry-api/src/opentelemetry/trace/__init__.py

Oberon00 · 2019-08-21T11:56:15Z

opentelemetry-api/src/opentelemetry/context/__init__.py



-Context: typing.Optional[BaseRuntimeContext]
+Context = (  # pylint: disable=invalid-name


This makes me wonder if we shouldn't relax the pylint rule for "constants" (maybe even to .*) since there are so many things it demands UPPER_CASE for which are not really constants. Then this could be a single line without the awkward parens.

It's done. Please review b05f347.

Related PR: #108

Oberon00 · 2019-08-21T11:59:04Z

@Jamim thank you for taking care of this! 🎉

Oberon00 · 2019-08-21T12:26:12Z

Please avoid force-pushing over already reviewed commits, that makes it hard to see what changed since the last review (force-pushing before merging to clean up the commit history is totally fine though).
I just noticed you can click the force-pushed link to see the diff 😄 Still it breaks the Diff UI's "changes since you last reviewed" feature.

Jamim · 2019-08-21T16:46:17Z

Hello @carlosalberto and @Oberon00,
Please re-review this PR and consider resolving or updating of the discussions.
Thanks!

carlosalberto · 2019-08-21T17:31:11Z

If we want to discuss other aspects, we should not do this here but reopen #36 or create a new issue.

I think we should have this PR without the isort and related style changes - or wait till we re-review #36 (re-open it maybe?)

Jamim · 2019-08-21T17:37:30Z

@carlosalberto I can extract b05f347 and c9821ec into a separate PR.
How do you think?

Oberon00 · 2019-08-22T08:47:09Z

LGTM now, but the style changes need further discussion (though I like them personally). So splitting this up is probably for the best.

Jamim · 2019-08-22T11:38:12Z

Hello @carlosalberto and @Oberon00,

I've excluded b05f347 and c9821ec for now.
Once this PR is merged, I'll create a corresponding PR including changes from those commits.
Please let me now if any additional changes are required.

Thanks!

Oberon00 · 2019-08-22T12:09:52Z

The only thing that keeps me from approving now is the long list of from typing imports in loader.py. If you want my approval now, change it back to a single import typing, otherwise you'll have to wait with this PR until the import discussion is resolved (maybe in today's SIG meeting?).

I believe it would be nice to have tests on CI not only for Python 3.7, but for all supported Python versions. These changes: - fix compatibility with Python 3.5 and 3.4 - add tests for various Python versions on CI - allow running tests for any branches

Jamim · 2019-08-22T12:38:51Z

@Oberon00:
If you want my approval now, change it back to a single import typing

It's done.

Oberon00

LGTM. Several questions were spawned by this PR (Python 3.4 support, import style, pylint constant naming rule) but they can be discussed independently later.

Jamim · 2019-08-23T13:53:36Z

Hello @carlosalberto,
What can I do to gain your approval? Please let me know.
Thanks!

carlosalberto · 2019-08-23T14:01:45Z

@Jamim remind me ;) (it's approved now)

Jamim · 2019-08-24T19:43:45Z

Hi everyone,
Since this PR is approved and there is no additional feedback, can it be merged now?

Oberon00 · 2019-08-26T10:48:26Z

Done! Thx for the reminder!

These changes follow up the "Fix and improve tests for Python != 3.7" PR. The multi_line_output was already set to 3 in the "Add initial black formatting" PR, so after rebasing to master this commit contains only comment that describes a magic number from the isort configuration file. Corresponding PR: - open-telemetry#109 Related discussions: - open-telemetry#95 (comment) - open-telemetry#95 (comment)

These changes follow up the "Fix and improve tests for Python != 3.7" PR. The multi_line_output was already set to 3 in the "Add initial black formatting" PR, so after rebasing to master this commit contains only comment that describes a magic number from the isort configuration file. Corresponding PR: - #109 Related discussions: - #95 (comment) - #95 (comment)

These changes follow up the "Fix and improve tests for Python != 3.7" PR. The multi_line_output was already set to 3 in the "Add initial black formatting" PR, so after rebasing to master this commit contains only comment that describes a magic number from the isort configuration file. Corresponding PR: - open-telemetry/opentelemetry-python#109 Related discussions: - open-telemetry/opentelemetry-python#95 (comment) - open-telemetry/opentelemetry-python#95 (comment)

Jamim requested review from Oberon00, c24t, carlosalberto and reyang as code owners August 20, 2019 22:49

Jamim force-pushed the fix/tests branch from 61c526b to 402b309 Compare August 20, 2019 22:59

carlosalberto reviewed Aug 20, 2019

View reviewed changes

Jamim mentioned this pull request Aug 21, 2019

Fix test failures involving contextvars. #96

Merged

Jamim force-pushed the fix/tests branch from 402b309 to 64645ce Compare August 21, 2019 11:40

Oberon00 changed the title ~~Fix and improve tests~~ Fix and improve tests for Python != 3.7 Aug 21, 2019

Oberon00 reviewed Aug 21, 2019

View reviewed changes

Jamim force-pushed the fix/tests branch from 64645ce to dc79a14 Compare August 21, 2019 12:07

Jamim force-pushed the fix/tests branch from e2c5866 to 92e5889 Compare August 22, 2019 11:33

Improve testing

79edaf0

I believe it would be nice to have tests on CI not only for Python 3.7, but for all supported Python versions. These changes: - fix compatibility with Python 3.5 and 3.4 - add tests for various Python versions on CI - allow running tests for any branches

Jamim force-pushed the fix/tests branch from 92e5889 to 79edaf0 Compare August 22, 2019 12:36

Oberon00 approved these changes Aug 22, 2019

View reviewed changes

Oberon00 mentioned this pull request Aug 22, 2019

Requests integration #94

Merged

carlosalberto self-requested a review August 23, 2019 14:01

carlosalberto approved these changes Aug 23, 2019

View reviewed changes

Oberon00 merged commit 2bcb228 into open-telemetry:master Aug 26, 2019

Jamim deleted the fix/tests branch August 26, 2019 17:43

This was referenced Aug 27, 2019

Relax the pylint rule for constants #108

Merged

Describe isort's multi_line_output setting #109

Merged

c24t mentioned this pull request Feb 11, 2020

Use travis pypy3 #408

Merged

srikanthccv pushed a commit to srikanthccv/opentelemetry-python that referenced this pull request Nov 1, 2020

Move SpanOptions to separate module (open-telemetry#95)

e0d4c61



		Context: typing.Optional[BaseRuntimeContext]
		Context = ( # pylint: disable=invalid-name

Conversation

Jamim commented Aug 20, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

carlosalberto Aug 20, 2019 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Jamim Aug 20, 2019 • 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!

Choose a reason for hiding this comment

Uh oh!

Jamim Aug 21, 2019 • 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!

a-feld commented Aug 20, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

carlosalberto Aug 20, 2019 • 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!

Jamim Aug 20, 2019 • 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!

Jamim Aug 20, 2019 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Jamim commented Aug 20, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

carlosalberto commented Aug 20, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Oberon00 commented Aug 21, 2019

Uh oh!

Oberon00 commented Aug 21, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Jamim commented Aug 21, 2019

Uh oh!

carlosalberto commented Aug 21, 2019

Uh oh!

Jamim commented Aug 21, 2019

Uh oh!

Oberon00 commented Aug 22, 2019

Uh oh!

Jamim commented Aug 20, 2019 •

edited

Loading

carlosalberto Aug 20, 2019 •

edited

Loading

Jamim Aug 20, 2019 •

edited

Loading

Jamim Aug 21, 2019 •

edited

Loading

carlosalberto Aug 20, 2019 •

edited

Loading

Jamim Aug 20, 2019 •

edited

Loading

Jamim Aug 20, 2019 •

edited

Loading

Jamim commented Aug 20, 2019 •

edited

Loading

Oberon00 commented Aug 21, 2019 •

edited

Loading