Add an informative main.py #620

hynek · 2017-04-20T17:27:50Z

Give users an easy way to figure out what versions they're running.

These questions come up with every bug.

Give users an easy way to figure out what versions they're running.

codecov · 2017-04-20T17:37:44Z

Codecov Report

Merging #620 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #620      +/-   ##
==========================================
+ Coverage   96.78%   96.79%   +<.01%     
==========================================
  Files          16       18       +2     
  Lines        5628     5642      +14     
  Branches      392      393       +1     
==========================================
+ Hits         5447     5461      +14     
  Misses        121      121              
  Partials       60       60

Impacted Files	Coverage Δ
src/OpenSSL/debug.py	`100% <100%> (ø)`
tests/test_debug.py	`100% <100%> (ø)`
tests/test_util.py	`100% <100%> (ø)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7706e14...a81358d. Read the comment docs.

hynek · 2017-04-20T18:15:13Z

FTR, on my computer the output looks like this:

➤ python -m OpenSSL
pyOpenSSL: 17.1.0.dev0
cryptography: 1.7.2
OpenSSL: OpenSSL 1.0.2k  26 Jan 2017
Python: /Users/hynek/.virtualenvs/pyopenssl/bin/python
Python version: 2.7.13 (default, Dec 26 2016, 08:37:46)
[GCC 4.2.1 Compatible Apple LLVM 8.0.0 (clang-800.0.42.1)]
Platform: darwin
sys.path: ['', '/Users/hynek/.virtualenvs/pyopenssl/lib/python27.zip', '/Users/hynek/.virtualenvs/pyopenssl/lib/python2.7', '/Users/hynek/.virtualenvs/pyopenssl/lib/python2.7/plat-darwin', '/Users/hynek/.virtualenvs/pyopenssl/lib/python2.7/plat-mac', '/Users/hynek/.virtualenvs/pyopenssl/lib/python2.7/plat-mac/lib-scriptpackages', '/Users/hynek/.virtualenvs/pyopenssl/lib/python2.7/lib-tk', '/Users/hynek/.virtualenvs/pyopenssl/lib/python2.7/lib-old', '/Users/hynek/.virtualenvs/pyopenssl/lib/python2.7/lib-dynload', '/Users/hynek/.pyenv/versions/2.7.13/lib/python2.7', '/Users/hynek/.pyenv/versions/2.7.13/lib/python2.7/plat-darwin', '/Users/hynek/.pyenv/versions/2.7.13/lib/python2.7/lib-tk', '/Users/hynek/.pyenv/versions/2.7.13/lib/python2.7/plat-mac', '/Users/hynek/.pyenv/versions/2.7.13/lib/python2.7/plat-mac/lib-scriptpackages', '/Users/hynek/.virtualenvs/pyopenssl/lib/python2.7/site-packages', '/Users/hynek/Projects/pyopenssl/src']

That should be helpful when pinning down packaging problems.

Opinions?

alexwlchan

Worth a note in CONTRIBUTING.rst suggesting that users include the output in their bug report?

hynek · 2017-04-20T18:28:38Z

I would even add a bug template…BUT: not before it’s released?

alex · 2017-04-20T20:11:59Z

-m OpenSSL is way too generic a name for this; maybe -m OpenSSL.debug or something.

alex · 2017-04-20T20:12:16Z

src/OpenSSL/__main__.py

+if __name__ != "__main__":
+    raise ImportError("This module can't be imported.")
+
+wot = """\


I don't know what "wot" means, please use a real variable name.

alex · 2017-04-20T20:12:34Z

src/OpenSSL/__main__.py

+
+
+if __name__ != "__main__":
+    raise ImportError("This module can't be imported.")


This code should go in a main function which is invoked in the __main__ block, that way it can be tested in memory

alex · 2017-04-20T20:13:31Z

src/OpenSSL/__main__.py

+wot = """\
+pyOpenSSL: {pyopenssl}
+cryptography: {cryptography}
+OpenSSL: {openssl}


You may want to distinguish between the linked version of OpenSSL and the compiled-against version.

hynek · 2017-04-21T09:05:56Z

I wasn’t quite sure what you meant with linked/compiled? I’ve added the OpenSSL the Python ist compiled against, since that is occasionally useful too:

pyOpenSSL: 17.1.0.dev0
cryptography: 1.7.2
cryptography's OpenSSL: OpenSSL 1.0.2k  26 Jan 2017
Pythons's OpenSSL: OpenSSL 1.0.2k  26 Jan 2017
Python executable: /Users/hynek/.virtualenvs/pyopenssl/bin/python
Python version: 2.7.13 (default, Dec 26 2016, 08:37:46)
[GCC 4.2.1 Compatible Apple LLVM 8.0.0 (clang-800.0.42.1)]
Platform: darwin
sys.path: ['', '/Users/hynek/.virtualenvs/pyopenssl/lib/python27.zip', '/Users/hynek/.virtualenvs/pyopenssl/lib/python2.7', '/Users/hynek/.virtualenvs/pyopenssl/lib/python2.7/plat-darwin', '/Users/hynek/.virtualenvs/pyopenssl/lib/python2.7/plat-mac', '/Users/hynek/.virtualenvs/pyopenssl/lib/python2.7/plat-mac/lib-scriptpackages', '/Users/hynek/.virtualenvs/pyopenssl/lib/python2.7/lib-tk', '/Users/hynek/.virtualenvs/pyopenssl/lib/python2.7/lib-old', '/Users/hynek/.virtualenvs/pyopenssl/lib/python2.7/lib-dynload', '/Users/hynek/.pyenv/versions/2.7.13/lib/python2.7', '/Users/hynek/.pyenv/versions/2.7.13/lib/python2.7/plat-darwin', '/Users/hynek/.pyenv/versions/2.7.13/lib/python2.7/lib-tk', '/Users/hynek/.pyenv/versions/2.7.13/lib/python2.7/plat-mac', '/Users/hynek/.pyenv/versions/2.7.13/lib/python2.7/plat-mac/lib-scriptpackages', '/Users/hynek/.virtualenvs/pyopenssl/lib/python2.7/site-packages', '/Users/hynek/Projects/pyopenssl/src']

hynek · 2017-04-25T11:46:29Z

I’ve add the cffi version which is (not only) interesting for #622.

alex

One comment, besides this LGTM

alex · 2017-05-13T13:55:48Z

src/OpenSSL/debug/__main__.py

@@ -0,0 +1,36 @@
+from __future__ import print_function


This doesn't need to be a package, just debug.py is sufficient.

reaperhulk · 2017-05-13T14:27:01Z

When @alex said linked vs compiled he meant that when cryptography is compiled the OpenSSL headers are used to determine version. You can obtain the version that was seen during the compile phase with _util.lib.OPENSSL_VERSION_TEXT. The version that is actually loaded by the dynamic linker is obtained via the mechanism you already have in this PR. The reason it's interesting to see both is that sometimes people install cryptography/pyOpenSSL and then upgrade OpenSSL. This can occasionally cause problems and that makes it useful to see the mismatch

Add an informative __main__.py

b982875

Give users an easy way to figure out what versions they're running.

hynek added 3 commits April 20, 2017 20:07

Why not more info!

cd7b3eb

Add test

6a1589c

No empty last line

4bf5dc3

alexwlchan reviewed Apr 20, 2017

View reviewed changes

alex reviewed Apr 20, 2017

View reviewed changes

Make @alex happy

e29bb46

hynek added 2 commits April 21, 2017 11:08

DIAF Python 2.6

ae3b758

Add cffi's version

e5f8541

alex reviewed May 13, 2017

View reviewed changes

Make debug a module

9ba915d

Add cryptography's compile-time OpenSSL

a81358d

reaperhulk approved these changes May 13, 2017

View reviewed changes

reaperhulk merged commit d52975c into pyca:master May 13, 2017

github-actions bot locked as resolved and limited conversation to collaborators Aug 18, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add an informative main.py #620

Add an informative main.py #620

hynek commented Apr 20, 2017

codecov bot commented Apr 20, 2017 •

edited

Loading

hynek commented Apr 20, 2017 •

edited

Loading

alexwlchan left a comment

hynek commented Apr 20, 2017

alex commented Apr 20, 2017

alex Apr 20, 2017

alex Apr 20, 2017

alex Apr 20, 2017

hynek commented Apr 21, 2017

hynek commented Apr 25, 2017

alex left a comment

alex May 13, 2017

reaperhulk commented May 13, 2017



		if __name__ != "__main__":
		raise ImportError("This module can't be imported.")

Add an informative __main__.py #620

Add an informative __main__.py #620

Conversation

hynek commented Apr 20, 2017

codecov bot commented Apr 20, 2017 • edited Loading

Codecov Report

hynek commented Apr 20, 2017 • edited Loading

alexwlchan left a comment

Choose a reason for hiding this comment

hynek commented Apr 20, 2017

alex commented Apr 20, 2017

alex Apr 20, 2017

Choose a reason for hiding this comment

alex Apr 20, 2017

Choose a reason for hiding this comment

alex Apr 20, 2017

Choose a reason for hiding this comment

hynek commented Apr 21, 2017

hynek commented Apr 25, 2017

alex left a comment

Choose a reason for hiding this comment

alex May 13, 2017

Choose a reason for hiding this comment

reaperhulk commented May 13, 2017

Add an informative main.py #620

Add an informative main.py #620

codecov bot commented Apr 20, 2017 •

edited

Loading

hynek commented Apr 20, 2017 •

edited

Loading