Base implementation of inspect request impl. #11

mvassilev · 2023-06-17T11:44:00Z

There is a problem here with the inspect_request_impl function not being invoked which prevents handling input like "? std::vector" that is supposed to display documentation to the user.

vgvassilev · 2023-06-18T06:18:01Z

@SylvainCorlay do you have a clue?

SylvainCorlay · 2023-06-28T09:20:03Z

Hey there, sorry for not getting back to you earlier.

The way to trigger these inspect requests from a JupyterLab UI is to open the "Contextual Help" from the "Help" topbar menu.

Then any keystroke will trigger an inspect request when the contextual help is open.

ioanaif · 2023-07-06T09:02:59Z

Hi!

I have this working locally and will be adding the changes here (as discussed with @vgvassilev via Skype) :

mvassilev#1

SylvainCorlay · 2023-07-06T23:05:23Z

Hourray, this ia amazing!

Ping @gouarin for awareness.

vgvassilev · 2023-07-07T07:58:30Z

Do we have a clang-format configuration for this project? If not, shall we use the standard one from llvm?

vgvassilev · 2023-07-12T09:27:39Z

@SylvainCorlay, @gouarin what is the way to move forward here?

gouarin · 2023-07-20T11:52:52Z

@mvassilev and @ioanaif thank you for your PR. It's a nice feature and it's great that it's working again! I'm really sorry for the delay and I will try to make a review soon. I also need to look at what @SylvainCorlay did in this project. Since I wrote xeus-cling, I haven't spent much time contributing to it. I will try to change that ;).

@vgvassilev we have no clang-format for this project for now but I can add one.

SylvainCorlay · 2023-07-14T06:32:17Z

CMakeLists.txt

@@ -171,7 +171,7 @@ macro(xeus_cpp_set_common_options target_name)
    endif ()

    set_target_properties(${target_name} PROPERTIES
-        INSTALL_RPATH_USE_LINK_PATH TRUE


Why changing the RPATH setting?

(This seems to be somewhat unrelated to the rest of the changes.)

@ioanaif Can you comment on this?

I made that change to have the install work on my local machine (macos) and avoid this error:

-- Installing: /Users/ioana/opt/anaconda3/envs/xeus-cpp/libn/libxeus-cpp.0.dylib error: /Users/ioana/opt/anaconda3/envs/xeus-cpp/bin/install_name_tool: for: /Users/ioana/opt/anaconda3/envs/xeus-cpp/libn/libxeus-cpp.0.0.1.dylib (for architecture x86_64) option "-add_rpath /Users/ioana/opt/anaconda3/envs/xeus-cpp/lib" would duplicate path, file already has LC_RPATH for: /Users/ioana/opt/anaconda3/envs/xeus-cpp/lib

From the CI logs it seems this is not a necessary change for macos and it was just my environment that was not properly set up.

So in that case I'd propose to revert these changes.

SylvainCorlay · 2023-07-14T06:33:25Z

src/xinspect.hpp

-        }
-        */
+	    clang::QualType QT = E->getType();
+        return  QT.getAsString();


Nice! Really happy that we can get away from the typeid approach.

SylvainCorlay · 2023-07-21T08:29:29Z

etc/xeus-cpp/tags.d/xtensor.json

@@ -0,0 +1,4 @@
+{
+    "url": "https://xtensor.readthedocs.io/en/latest/",
+    "tagfile": "xtensor.tag"


I suggest we don't install the xtensor tag files as part of this PR, since it should probably be installed by xtensor itself.

SylvainCorlay · 2023-07-21T08:31:31Z

src/xinterpreter.cpp

-        {
+        {   std::string exp = R"(\w*(?:\:{2}|\<.*\>|\(.*\)|\[.*\])?)";
+            std::regex re(R"((\w*(?:\:{2}|\<.*\>|\(.*\)|\[.*\])?)(\.?)*$)");
+            auto inspect_request = is_inspect_request(code, re);


An inspect request is a different type of message, triggered by keystrokes in the editor when the inspector panel is open.

I don't think we should call this function is_inspect_request but more like is_help_magic

is_help_magic returns bool so what should be the logic here in the cases of true or false?

SylvainCorlay · 2023-07-21T08:31:59Z

src/xinterpreter.cpp

+            auto inspect_request = is_inspect_request(code, re);
+            if (inspect_request.first)
+            {
+                inspect(inspect_request.second[0], kernel_res, *m_interpreter);


Happy to discuss this. Maybe we should not rebind into the inspect function here.

Maybe this would be related to the previous conversation regarding the replacement of is_inspect_request with is_help_magic

SylvainCorlay · 2023-07-21T08:33:14Z

I left a few comments in the review. Happy to discuss the changes. It seems that the CI failures come from an issue with the header inclusion order. I have come across this in earlier PRs and had to make sure some things were included earlier than other.

This should fix the bot error: expected ')' before 'PRIxPTR' A similar issue is reported in tensorflow/tensorflow#12998

They will be installed by extensor itself.

vgvassilev · 2023-08-04T13:14:01Z

@SylvainCorlay, @gouarin, this looks mostly okay to me.

@SylvainCorlay, can you take a look and answer to the remaining questions?

I have a question on my own: Is there a way to avoid putting share/xeus-cpp/tagfiles/cppreference-doxygen-web.tag in the repository and download it from somewhere instead?

vgvassilev

I'd prefer to move forward here and break the stalemate. We can rely on a post-commit review here. LGTM!

SylvainCorlay · 2023-11-16T14:34:31Z

I have a question on my own: Is there a way to avoid putting share/xeus-cpp/tagfiles/cppreference-doxygen-web.tag in the repository and download it from somewhere instead?

I don't think this file exist otherwise.

SylvainCorlay reviewed Jul 21, 2023

View reviewed changes

mvassilev and others added 2 commits July 21, 2023 20:07

Base implementation of inspect request impl.

9f0c904

Make rendering the type help in the pager work.

213acd2

mvassilev force-pushed the InspectRequestImplementation branch from c0d3681 to 213acd2 Compare July 21, 2023 17:16

Add the missing llvm definitions.

62f2f3a

This should fix the bot error: expected ')' before 'PRIxPTR' A similar issue is reported in tensorflow/tensorflow#12998

vgvassilev force-pushed the InspectRequestImplementation branch 4 times, most recently from 8efe593 to a17da7e Compare July 21, 2023 22:48

Fix windows builds by not using dirent.h

22af8f3

vgvassilev force-pushed the InspectRequestImplementation branch 2 times, most recently from 47b9b6b to 0dbf6b4 Compare July 21, 2023 23:16

[cmake] Enable explicitly exceptions

a12fe36

vgvassilev force-pushed the InspectRequestImplementation branch from 0dbf6b4 to a12fe36 Compare July 21, 2023 23:20

mvassilev added 6 commits August 1, 2023 09:59

No need to install xtensor tag files here.

c1407e4

They will be installed by extensor itself.

Remove redundant new lines.

de82077

Remove redundant file.

8d2e6a4

Revert changing the INSTALL_RPATH_USE_LINK_PATH setting.

654a77a

Update copyright.

a5d9f2b

Revert changes.

0e6c04a

vgvassilev approved these changes Aug 30, 2023

View reviewed changes

vgvassilev merged commit eb4d98a into compiler-research:main Aug 30, 2023
2 of 8 checks passed

mvassilev mentioned this pull request Aug 30, 2023

Implement quick help for types #6

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Base implementation of inspect request impl. #11

Base implementation of inspect request impl. #11

mvassilev commented Jun 17, 2023 •

edited

Loading

vgvassilev commented Jun 18, 2023

SylvainCorlay commented Jun 28, 2023

ioanaif commented Jul 6, 2023 •

edited

Loading

SylvainCorlay commented Jul 6, 2023 •

edited

Loading

vgvassilev commented Jul 7, 2023

vgvassilev commented Jul 12, 2023 •

edited

Loading

gouarin commented Jul 20, 2023

SylvainCorlay Jul 14, 2023

SylvainCorlay Jul 21, 2023

mvassilev Jul 31, 2023

ioanaif Aug 1, 2023

vgvassilev Aug 3, 2023

SylvainCorlay Jul 14, 2023

SylvainCorlay Jul 21, 2023

SylvainCorlay Jul 21, 2023

mvassilev Aug 1, 2023

SylvainCorlay Jul 21, 2023

mvassilev Aug 1, 2023

SylvainCorlay commented Jul 21, 2023

vgvassilev commented Aug 4, 2023

vgvassilev left a comment

SylvainCorlay commented Nov 16, 2023

Base implementation of inspect request impl. #11

Base implementation of inspect request impl. #11

Conversation

mvassilev commented Jun 17, 2023 • edited Loading

vgvassilev commented Jun 18, 2023

SylvainCorlay commented Jun 28, 2023

ioanaif commented Jul 6, 2023 • edited Loading

SylvainCorlay commented Jul 6, 2023 • edited Loading

vgvassilev commented Jul 7, 2023

vgvassilev commented Jul 12, 2023 • edited Loading

gouarin commented Jul 20, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SylvainCorlay commented Jul 21, 2023

vgvassilev commented Aug 4, 2023

vgvassilev left a comment

Choose a reason for hiding this comment

SylvainCorlay commented Nov 16, 2023

mvassilev commented Jun 17, 2023 •

edited

Loading

ioanaif commented Jul 6, 2023 •

edited

Loading

SylvainCorlay commented Jul 6, 2023 •

edited

Loading

vgvassilev commented Jul 12, 2023 •

edited

Loading