`show_in_browser()` method for folium.folium.Map #953

Demetrio92 · 2018-09-04T18:57:58Z

fixes #946

Adds show_in_browser() method for folium.folium.Map which should work even in a vanilla python, e.g. try:

python3 examples/OpenMapInBrowser.py

I did not write any tests for the new functionality, as I am not quite sure how to test it. Suggestions welcome.
On the other hand, some tests were failing before I added any of my code, and some packages were missing in the requirements-dev.txt. I collected all the fixes here: #952

p.s. sorry for the branch name, this should work:

git checkout 'show_in_browser()-method-for-folium.folium.Map'

examples/OpenMapInBrowser.py

stickler-ci · 2018-09-04T18:58:17Z

folium/_server.py

+if sys.version_info[0] < 3:
+    raise NotImplementedError('Only works with python 3!')
+
+import webbrowser


E402 module level import not at top of file

that seems to be the case for most of the other files in the repo, so I chose consistency over purity.

stickler-ci · 2018-09-04T18:58:17Z

folium/_server.py

+    raise NotImplementedError('Only works with python 3!')
+
+import webbrowser
+from http.server import BaseHTTPRequestHandler, HTTPServer


E402 module level import not at top of file

that seems to be the case for most of the other files in the repo, so I chose consistency over purity.

stickler-ci · 2018-09-04T18:58:17Z

folium/_server.py

+
+import webbrowser
+from http.server import BaseHTTPRequestHandler, HTTPServer
+from textwrap import dedent


E402 module level import not at top of file

that seems to be the case for most of the other files in the repo, so I chose consistency over purity.

Please follow the liner cues here. We are cleaning up the code and new code should be compliant from the start.

folium/_server.py

Demetrio92 · 2018-09-04T19:14:34Z

So, err, both checks fail :(

Linter is right, but I just followed the convention in other files. In that sense none of the files in the repository would pass the above linter.
Travis is right, the feature does not work in python 2, in which case it gives a NotImplementedError with a message. Ofc, I could pass it with a print, but do we really want it? The rest seem to work flawlessly.

ocefpaf · 2018-09-04T19:38:36Z

Travis is right, the feature does not work in python 2, in which case it gives a NotImplementedError with a message. Ofc, I could pass it with a print, but do we really want it? The rest seem to work flawlessly.

Raising a NotImplementedError is OK there.

ocefpaf · 2018-09-04T19:39:23Z

examples/OpenMapInBrowser.py

+HeatMap(data).add_to(folium_map)
+
+# open in in browser
+folium_map.show_in_browser()


No need for this example. This can be in the method docstring.

ocefpaf · 2018-09-04T19:40:23Z

folium/_server.py

+
+import sys
+if sys.version_info[0] < 3:
+    raise NotImplementedError('Only works with python 3!')


Maybe a more verbose message like:

This feature is only available on Python 3.

I actually realised i might have misunderstood something. Because there is an http server in python 2, so I'll check it again tomorrow.

ocefpaf · 2018-09-04T19:41:13Z

folium/_server.py

+        HTTPServer.allow_reuse_address = True
+        httpd = HTTPServer((self.host, self.port), HTTPServerRequestHandler)
+
+        # run the temporary http server with graceful exit option


Most of these comment can be removed. I guess that they were added on SO to explain the answer. We don't need them here.

Conengmo · 2018-09-04T19:54:08Z

I definitely appreciate the effort @Demetrio92, but to be honest I think having an HTTP server is overkill. Currently (as far as I know) all data is embedded in the map, so you could just as easily call webbrowser.open() on a temporary HTML file, which has the added benefit of not unnecessarily blocking the program.

I learned from @ocefpaf he would like to work towards not having all data embedded in the map, which is fine. But let's implement an HTTP server when or if we get there. All code needs to be maintained, so the less the better.

ocefpaf · 2018-09-04T19:56:00Z

I learned from @ocefpaf he would like to work towards not having all data embedded in the map,

That is in the long term and may never happen...

But let's implement an HTTP server when or if we get there.

Yep.

All code needs to be maintained, so the less the better.

💯

Demetrio92 · 2018-09-04T21:40:27Z

@Conengmo @ocefpaf
This a bit of bummer. As far as i understood the discussion in #946 simply opening a file might randomly fail. So i've spent some time tidying up that simple http server.
I totally agree with less is better, but would you prefer to have a method that might not work as the user expects it?

In defence of the "server" code, it's base python and I really doubt there will be major compatibility breaks or maintenance required.

Please let me know if this PR generally would be accepted or not. If yes, I'll address the remaining issues, otherwise let's just close it.
I'll think of submitting another one that is based on temp-files (which i initially considered, but went for this option due to functionality).

examples/OpenMapInBrowser.py

stickler-ci · 2018-09-07T16:13:23Z

folium/_server.py

+    from SimpleHTTPServer import SimpleHTTPRequestHandler as BaseHTTPRequestHandler
+    from SocketServer import TCPServer as HTTPServer
+
+import webbrowser


E402 module level import not at top of file

same as before this seems to be a convention in the repo

stickler-ci · 2018-09-07T16:13:23Z

folium/_server.py

+    from SocketServer import TCPServer as HTTPServer
+
+import webbrowser
+from textwrap import dedent


E402 module level import not at top of file

same as before this seems to be a convention in the repo

folium/folium.py

python-visualization#953 (comment)

stickler-ci · 2018-09-07T16:25:10Z

folium/_server.py

+    from SimpleHTTPServer import SimpleHTTPRequestHandler as BaseHTTPRequestHandler
+    from SocketServer import TCPServer as HTTPServer
+
+import webbrowser


E402 module level import not at top of file

stickler-ci · 2018-09-07T16:25:11Z

folium/_server.py

+    from SocketServer import TCPServer as HTTPServer
+
+import webbrowser
+from textwrap import dedent


E402 module level import not at top of file

folium/folium.py

Demetrio92 · 2018-09-07T16:46:24Z

I fixed python 2.7 issue, and addressed all the feedback, except that we don't really need the feature :D

Linter complaining about E402 can keep complaining, E402 is not followed in the repository and should be excluded from stickler-ci,

Conengmo · 2022-11-17T13:33:01Z

Close in favor of #1651

Thanks for your efforts on this, sorry it got left hanging for so long.

Demetrio92 added 4 commits September 4, 2018 17:03

fix requirements dev

f7fc8af

first we need an HTTP server (borrowed from StackOverflow)

a05062d

add show_in_browser functionality

7755220

show_in_browser usage example

dc35d5c

stickler-ci reviewed Sep 4, 2018

View reviewed changes

ocefpaf reviewed Sep 4, 2018

View reviewed changes

now also works in python2

81e087c

stickler-ci reviewed Sep 7, 2018

View reviewed changes

Demetrio92 added 2 commits September 7, 2018 18:19

strip unnecessary comments.

395e0e1

python-visualization#953 (comment)

move example into the function docstring

6e87103

python-visualization#953 (comment)

stickler-ci reviewed Sep 7, 2018

View reviewed changes

ocefpaf force-pushed the master branch 3 times, most recently from 53546b8 to 9f2299a Compare February 26, 2019 19:49

eabase mentioned this pull request Aug 24, 2022

show folium outside of ipython notebooks #946

Closed

Conengmo mentioned this pull request Nov 16, 2022

Map.show_in_browser() using temp file #1651

Merged

Conengmo closed this Nov 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

`show_in_browser()` method for folium.folium.Map #953

`show_in_browser()` method for folium.folium.Map #953

Demetrio92 commented Sep 4, 2018

stickler-ci Sep 4, 2018

Demetrio92 Sep 4, 2018

stickler-ci Sep 4, 2018

Demetrio92 Sep 4, 2018

stickler-ci Sep 4, 2018

Demetrio92 Sep 4, 2018

ocefpaf Sep 4, 2018

Demetrio92 commented Sep 4, 2018

ocefpaf commented Sep 4, 2018

ocefpaf Sep 4, 2018

ocefpaf Sep 4, 2018

Demetrio92 Sep 4, 2018

ocefpaf Sep 4, 2018

Conengmo commented Sep 4, 2018

ocefpaf commented Sep 4, 2018

Demetrio92 commented Sep 4, 2018 •

edited

Loading

stickler-ci Sep 7, 2018

Demetrio92 Sep 7, 2018

stickler-ci Sep 7, 2018

Demetrio92 Sep 7, 2018

stickler-ci Sep 7, 2018

stickler-ci Sep 7, 2018

Demetrio92 commented Sep 7, 2018

Conengmo commented Nov 17, 2022

show_in_browser() method for folium.folium.Map #953

show_in_browser() method for folium.folium.Map #953

Conversation

Demetrio92 commented Sep 4, 2018

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

Demetrio92 commented Sep 4, 2018

ocefpaf commented Sep 4, 2018

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

Conengmo commented Sep 4, 2018

ocefpaf commented Sep 4, 2018

Demetrio92 commented Sep 4, 2018 • edited Loading

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

Demetrio92 commented Sep 7, 2018

Conengmo commented Nov 17, 2022

`show_in_browser()` method for folium.folium.Map #953

`show_in_browser()` method for folium.folium.Map #953

Demetrio92 commented Sep 4, 2018 •

edited

Loading