atom / language-python

Python package for Atom
Other
190 stars 146 forks source link

SQL syntax coloring in string literals broken for versions greater than 0.51.9 #306

Open fgiamma opened 5 years ago

fgiamma commented 5 years ago

Prerequisites

Description

I have been using Atom for Python coding for a while and I think the core language-python module works extremely well.

Updating Atom from version 1.36.1 to 1.37.0 or even the new 1.38.0 beta, something has changed though. Until version 0.59.1 of language-python, SQL code in string is correctly "syntax highlighted", while in subsequent versions (included in newer versions of Atom) is not. See the attached screenshots below.

Is there any way to restore the original behaviour? For long sql strings in code not having syntax highlighting is a major drawback. Thank you very much. Fabrizio

Screenshot 2019-06-04 at 13 43 11 Screenshot 2019-06-04 at 13 43 48

Steps to Reproduce

See screenshots attached

Expected behavior:

SQL syntax recognized (and properly colored) in string literals

SQL syntax not recognized in strings

Reproduces how often:

Always

Versions

Atom: 1.37.0 or greater Language-Python: All versions after 0.59.1

rsese commented 5 years ago

Thanks for the report! Can you share the code itself so we can copy/paste to try it out?

fgiamma commented 5 years ago

Hello, I will attach the code below, but any sql string will do.

#!/usr/bin/env python3
from initclass import InitClass
import sys
import os
sys.path.append(os.path.abspath("../../"))

class Test(InitClass):
    def __init__(self):
        super().__init__()

    def process(self):
        # This is my comment
        sql = "SELECT documents.* FROM documents"
        documents = self.db.fetch_all(sql, [])
        for document in documents:
            print(document["name"])

t = Test()
t.process()

Fabrizio

Arcanemagus commented 5 years ago

This is due to language-sql currently not having a Tree-sitter based implementation, meaning that language-python can't bring it in to syntax highlight the strings. You can check out https://github.com/atom/language-ruby/issues/249#issuecomment-486420325 for a detailed explanation about this issue with regards to language-ruby, the core problem is the same though.

For now if you need that functionality you can switch to the old TextMate grammar by unchecking "Use Tree-sitter parsers" option: image

Note however that the highlighting of your Python code (and other languages) will suffer from doing that, as TextMate grammars have many other issues with parsing that the Tree-sitter system allows us to solve easily.

fgiamma commented 5 years ago

Thanks @Arcanemagus, I wasn't aware of this issue, I still can't understand why for versions of atom under 1.37.0 the syntax highlight still works. My current atom setup is a downgraded 1.36.1 and even though "Use tree sitter parsers" is checked, it works like a charm and correctly highlights sql in strings, if I upgrade to 1.37.0 or newer it doesn't work anymore...

contang0 commented 4 years ago

For me downgrading to 1.36 doesn't help. Any chance this issue will be solved?