Skip to content

Fix #1868: elpy-goto-definition breaks with python 3.9 #1902

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
galaunay wants to merge 2 commits into from
Closed

Fix #1868: elpy-goto-definition breaks with python 3.9 #1902

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e6023a6
Fix #1868: elpy-goto-definition breaks with python 3.9
gabylaunay-alp Mar 28, 2021
75546d6
Added missing library
galaunay Apr 19, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion elpy/rpc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
import json
import sys
import traceback
from pathlib import Path



class JSONRPCServer(object):
Expand Down Expand Up @@ -67,14 +69,18 @@ def read_json(self):
raise EOFError()
return json.loads(line)

def json_defaults(self, x):
if isinstance(x, Path):
return str(x)

def write_json(self, **kwargs):
"""Write an JSON object on a single line.

The keyword arguments are interpreted as a single JSON object.
It's not possible with this method to write non-objects.

"""
self.stdout.write(json.dumps(kwargs) + "\n")
self.stdout.write(json.dumps(kwargs, default=self.json_defaults) + "\n")
Copy link
Copy Markdown
Collaborator

@gopar gopar Mar 28, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs for json.dumps say that it should raise a TypeError if the object cannot be serializable, (In this case, all other objects that are not Path and are not primitive types will be encoded as null since json_defaults is implicitly returning None.

>>> import json
>>> json.dumps(None)
'null'
>>>

Also relevant CPython source code that shows this will happen

I don't think this is the intended outcome?

Copy link
Copy Markdown

@akshaybadola akshaybadola Apr 29, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The docs for json.dumps say that it should raise a TypeError if the object cannot be serializable, (In this case, all other objects that are not Path and are not primitive types will be encoded as null since json_defaults is implicitly returning None.

>>> import json
>>> json.dumps(None)
'null'
>>>

Also relevant CPython source code that shows this will happen

I don't think this is the intended outcome?

Hi @gopar. Sorry I've been extremely busy. Yes, definitely that shouldn't be there. I had completely overlooked that and forgot to return the default value. It should be:

def json_defaults(x):
    if isinstance(x, Path): 
         return str(x) 
    else: 
        return json.dumps(x)

See docstring of default in JSONEncoder.

Actually pydantic would be a good approach to go for it as it is primarily a parsing library. Though I think @gfederix's PR (See discussion in #1895) requires a few fixes.

At this point I'm not sure which things to refactor, for example in rpc.py, as there are parallel changes in #1895 which are not yet merged. Any suggestions?

self.stdout.flush()

def handle_request(self):
Expand Down