added extra info in `rasa --version` command #5726

koaning · 2020-04-27T17:41:18Z

Proposed changes:

This PR implements the changes proposed here. The idea is to add extra information to the rasa --version command so that it is less effort to file a bug report.

This is the new behavior.

> python -m rasa --version
Rasa Version     : 1.9.7
Python Version   : 3.6.8 (v3.6.8:3c6b436a57, Dec 24 2018, 02:04:31) 
Operating System : [GCC 4.2.1 Compatible Apple LLVM 6.0 (clang-600.0.57)]
Virtualen Env    : /Users/vincent/Development/rasa/venv
Rasa SDK Version : 1.9.0

If you don't have rasa-x locally it won't print it.

> python -m pip uninstall rasa-sdk
> python -m rasa --version      
Rasa Version     : 1.9.7
Python Version   : 3.6.8 (v3.6.8:3c6b436a57, Dec 24 2018, 02:04:31) 
Operating System : [GCC 4.2.1 Compatible Apple LLVM 6.0 (clang-600.0.57)]
Virtualen Env    : /Users/vincent/Development/rasa/venv

Status (please check what you already did):

added some tests for the functionality
updated the documentation
updated the changelog (please check changelog for instructions)
reformat files using black (please check Readme for instructions)

…info-command

koaning · 2020-04-27T18:26:33Z

CI seems to complain about lines that are in master, found here. I could remove them, but I left them because I assumed they were there for a reason.

koaning · 2020-04-27T18:42:36Z

Fixed a bug such that this will work outside of a virtualenv. The previous implementation looked at the environment variable for python path. It is now retreived from sys.path.

>  rasa --version
Rasa Version     : 1.10.0a3
Python Version   : 3.6.8 (v3.6.8:3c6b436a57, Dec 24 2018, 02:04:31) 
Operating System : [GCC 4.2.1 Compatible Apple LLVM 6.0 (clang-600.0.57)]
Python Path      : /Users/vincent/Development/rasa/venv/bin
Rasa SDK Version : 1.9.0

The CI was complaining that coverage went down because of the few lines that I added so I added a unit test that checks if certain properties are reported.

koaning · 2020-04-28T06:39:36Z

Mhmmm....

 FAILED: /home/runner/work/rasa/rasa/.pytype/pyi/rasa/__main__.pyi 
/home/runner/.cache/pypoetry/virtualenvs/rasa-wb3tDUZd-py3.7/bin/python -m pytype.single --imports_info /home/runner/work/rasa/rasa/.pytype/imports/rasa.__main__.imports --module-name rasa.__main__ -V 3.7 -o /home/runner/work/rasa/rasa/.pytype/pyi/rasa/__main__.pyi --analyze-annotated --nofail --quick /home/runner/work/rasa/rasa/rasa/__main__.py
File "/home/runner/work/rasa/rasa/rasa/__main__.py", line 81, in print_version: Can't find module 'rasax.community.version'. [import-error]

I get why the Code Quality tool is complaining here, but then again, I don't see a way around this. We need to try to import something and we don't know if it is installed. I could remove rasa-x here since some of the time this information is not fetched from the command line but it feels like this command show list all relevant items. Would love to get advice on this. @erohmensing?

…info-command

koaning · 2020-04-30T13:24:04Z

@erohmensing I have now removed the check for 'Rasa X'. It was giving build errors, but since typically people do not have rasa-x locally installed anyway it felt like something best removed.

erohmensing

Let me take a look at rasa x -- probably just an issue of where the version is found?

Can we put all of the info-gathering code before the prints please?

rasa/__main__.py

erohmensing · 2020-05-04T12:01:27Z

@koaning maybe we can make pytype ignore the import error then? google/pytype#163

…info-command

koaning · 2020-05-04T13:37:24Z

The DeepSource: Python is currently complaining about these lines of code.

It is importing os and sys inside of a function that does not have a docstring is the complaint. I could fix it, but the comment # Running as a standalone python application makes me think twice about it.

In the meantime I have moved back Rasa X and I seem to have fixed the checking issue by adding # pytype: disable=import-error inline.

This is what the command currently does on my machine;

> python -m rasa --version         
Rasa Version     : 1.10.0
Rasa SDK Version : 1.9.0
Rasa X Version   : None
Python Version   : 3.6.8 (v3.6.8:3c6b436a57, Dec 24 2018, 02:04:31) 
Operating System : [GCC 4.2.1 Compatible Apple LLVM 6.0 (clang-600.0.57)]
Python Path      : /Users/vincent/Development/rasa/venv/bin/python

erohmensing · 2020-05-04T17:01:56Z

It's fine to not always do exactly what deepsource says, though i was going to recommend a docstring because it's not just putting out the rasa version as one might expect

erohmensing · 2020-05-04T17:02:50Z

Sorry to clarify -- if deepsource is yelling at code that's not yours, don't worry about it. But a docstring for version() might be nice.

…info-command

koaning · 2020-05-07T10:19:27Z

@erohmensing I think everything is now covered. The deepsource still complains about lines of code outside of the ones I made. I added code changes based on your comments (thanks for those by the way!).

erohmensing

Nice! Just some style stuff and the OS thing we talked about

rasa/__main__.py

changelog/5637.enhancement.rst

Co-authored-by: Ella Rohm-Ensing <[email protected]>

erohmensing

Awesome, I think this is going to be super helpful

rasa/__main__.py

erohmensing · 2020-05-07T14:22:04Z

rasa/__main__.py

+    print(f"Rasa SDK Version : {rasa_sdk_version}")
+    print(f"Rasa X Version   : {rasa_x_info}")
+    print(f"Python Version   : {python_version}")
+    print(f"Operating System : {platform.system()}")


why not platform.platform()?

It gives slightly more information that could potentially be relevant, like that the system is 64bit. It's not super needed but I figured it was more complete.

Wait, platform.system() does? Because for me:

In [1]: import platform In [2]: platform.platform() Out[2]: 'Darwin-19.3.0-x86_64-i386-64bit' In [3]: platform.system() Out[3]: 'Darwin'

I would also like the slightly more information :)

Crud, mybad! Somehow I merged the whole thing with system instead of platform. I've added a quick fix PR here: #5793

Co-authored-by: Ella Rohm-Ensing <[email protected]>

koaning added 2 commits April 27, 2020 19:38

added extra info in version

32386c8

ran black

0f68232

koaning added the area:rasa-oss 🎡 Anything related to the open source Rasa framework label Apr 27, 2020

koaning added 4 commits April 27, 2020 19:45

Merge branch 'master' into rasa-info-command

05b3fda

virtualenv path

43bed03

Merge branch 'rasa-info-command' of github.com:RasaHQ/rasa into rasa-…

31f773a

…info-command

remove-unneeded-import

bbd5947

added test + windows fix

3e687ed

koaning changed the title ~~added extra info in version~~ added extra info in rasa --version command Apr 27, 2020

koaning requested a review from erohmensing April 28, 2020 12:07

koaning added 5 commits April 29, 2020 14:44

Merge branch 'master' into rasa-info-command

095e774

removed rasa-x from versioncheck

43caba7

Merge branch 'rasa-info-command' of github.com:RasaHQ/rasa into rasa-…

b66d6f1

…info-command

Merge branch 'master' into rasa-info-command

94854c6

Update 5637.enhancement.rst

d333d3d

erohmensing reviewed May 4, 2020

View reviewed changes

rasa/__main__.py Outdated Show resolved Hide resolved

koaning added 4 commits May 4, 2020 14:47

good point on first collecting and then printing

d588480

Merge branch 'rasa-info-command' of github.com:RasaHQ/rasa into rasa-…

85cf660

…info-command

added-rasa-x-back-to-check-ci

6c7854f

two spaces!

01e8a38

man black is brutal

6020d2f

Merge branch 'master' into rasa-info-command

d39bf89

koaning added 2 commits May 7, 2020 11:15

treat rasa-sdk as a true dependency

6a4531d

Merge branch 'rasa-info-command' of github.com:RasaHQ/rasa into rasa-…

595f6e3

…info-command

replaced sys.info with platform

808435d

erohmensing reviewed May 7, 2020

View reviewed changes

rasa/__main__.py Outdated Show resolved Hide resolved

rasa/__main__.py Outdated Show resolved Hide resolved

rasa/__main__.py Outdated Show resolved Hide resolved

changelog/5637.enhancement.rst Outdated Show resolved Hide resolved

koaning and others added 3 commits May 7, 2020 16:06

Update changelog/5637.enhancement.rst

261198f

Co-authored-by: Ella Rohm-Ensing <[email protected]>

styleguide

f4fd437

one minor change extra

8a361ae

erohmensing approved these changes May 7, 2020

View reviewed changes

koaning and others added 2 commits May 7, 2020 17:01

Update rasa/__main__.py

b47d3a1

Co-authored-by: Ella Rohm-Ensing <[email protected]>

Update rasa/__main__.py

b32abe2

Co-authored-by: Ella Rohm-Ensing <[email protected]>

koaning merged commit 88aa903 into master May 7, 2020

koaning deleted the rasa-info-command branch May 7, 2020 16:56

koaning mentioned this pull request Aug 27, 2020

Rasa --version now breaks on Windows #6496

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added extra info in `rasa --version` command #5726

added extra info in `rasa --version` command #5726

koaning commented Apr 27, 2020 •

edited

Loading

koaning commented Apr 27, 2020 •

edited

Loading

koaning commented Apr 27, 2020 •

edited

Loading

koaning commented Apr 28, 2020 •

edited

Loading

koaning commented Apr 30, 2020 •

edited

Loading

erohmensing left a comment

erohmensing commented May 4, 2020

koaning commented May 4, 2020 •

edited

Loading

erohmensing commented May 4, 2020

erohmensing commented May 4, 2020

koaning commented May 7, 2020 •

edited

Loading

erohmensing left a comment

erohmensing left a comment

erohmensing May 7, 2020

koaning May 7, 2020

erohmensing May 7, 2020

koaning May 8, 2020

added extra info in rasa --version command #5726

added extra info in rasa --version command #5726

Conversation

koaning commented Apr 27, 2020 • edited Loading

koaning commented Apr 27, 2020 • edited Loading

koaning commented Apr 27, 2020 • edited Loading

koaning commented Apr 28, 2020 • edited Loading

koaning commented Apr 30, 2020 • edited Loading

erohmensing left a comment

Choose a reason for hiding this comment

erohmensing commented May 4, 2020

koaning commented May 4, 2020 • edited Loading

erohmensing commented May 4, 2020

erohmensing commented May 4, 2020

koaning commented May 7, 2020 • edited Loading

erohmensing left a comment

Choose a reason for hiding this comment

erohmensing left a comment

Choose a reason for hiding this comment

erohmensing May 7, 2020

Choose a reason for hiding this comment

koaning May 7, 2020

Choose a reason for hiding this comment

erohmensing May 7, 2020

Choose a reason for hiding this comment

koaning May 8, 2020

Choose a reason for hiding this comment

added extra info in `rasa --version` command #5726

added extra info in `rasa --version` command #5726

koaning commented Apr 27, 2020 •

edited

Loading

koaning commented Apr 27, 2020 •

edited

Loading

koaning commented Apr 27, 2020 •

edited

Loading

koaning commented Apr 28, 2020 •

edited

Loading

koaning commented Apr 30, 2020 •

edited

Loading

koaning commented May 4, 2020 •

edited

Loading

koaning commented May 7, 2020 •

edited

Loading