Python pyls_document_symbols Examples

Example #1

def test_symbols(config):
    doc = Document(DOC_URI, DOC)
    config.update({
        'plugins': {
            'jedi_symbols': {
                'all_scopes': False,
                'hide_imports': True
            }
        }
    })
    symbols = pyls_document_symbols(config, doc)

    # Only local symbols (a, B, main, y)
    assert len(symbols) == 4

    config.update({
        'plugins': {
            'jedi_symbols': {
                'all_scopes': False,
                'hide_imports': False
            }
        }
    })
    symbols = pyls_document_symbols(config, doc)

    # All five symbols (import sys, a, B, main, y)
    assert len(symbols) == 5

    def sym(name):
        return [s for s in symbols if s['name'] == name][0]

    # Check we have some sane mappings to VSCode constants
    assert sym('a')['kind'] == SymbolKind.Variable
    assert sym('B')['kind'] == SymbolKind.Class
    assert sym('main')['kind'] == SymbolKind.Function

    # Not going to get too in-depth here else we're just testing Jedi
    assert sym('a')['location']['range']['start'] == {
        'line': 2,
        'character': 0
    }

    # Ensure that the symbol range spans the whole definition
    assert sym('main')['location']['range']['start'] == {
        'line': 9,
        'character': 0
    }
    assert sym('main')['location']['range']['end'] == {
        'line': 12,
        'character': 0
    }

Example #2

File: test_symbols.py Project: pnijhara/python-language-server

def test_symbols_all_scopes_with_jedi_environment(config):
    doc = Document(DOC_URI, MockWorkspace(), DOC)

    # Update config extra environment
    env_path = '/tmp/pyenv/bin/python'
    config.update({'plugins': {'jedi': {'environment': env_path}}})
    doc.update_config(config)
    symbols = pyls_document_symbols(config, doc)
    helper_check_symbols_all_scope(symbols)

Example #3

def test_symbols_all_scopes_with_jedi_environment(workspace):
    doc = Document(DOC_URI, workspace, DOC)

    # Update config extra environment
    env_path = '/tmp/pyenv/bin/python'
    settings = {'pyls': {'plugins': {'jedi': {'environment': env_path}}}}
    doc.update_config(settings)
    symbols = pyls_document_symbols(doc._config, doc)
    helper_check_symbols_all_scope(symbols)

Example #4

def test_symbols_hierarchical(config):
    doc = Document(DOC_URI, DOC)

    config.update({
        'plugins': {
            'jedi_symbols': {
                'hierarchical_symbols': True,
                'hide_imports': True
            }
        }
    })
    symbols = pyls_document_symbols(config, doc)

    # Only local symbols (a, B, main, y)
    assert len(symbols) == 4

    config.update({
        'plugins': {
            'jedi_symbols': {
                'hierarchical_symbols': True,
                'hide_imports': False
            }
        }
    })
    symbols = pyls_document_symbols(config, doc)

    # All five symbols (import sys, a, B, main, y)
    assert len(symbols) == 5

    def sym(name):
        return [s for s in symbols if s['name'] == name][0]

    def child_sym(sym, name):
        if not sym['children']:
            return None
        return [s for s in sym['children'] if s['name'] == name][0]

    # Check we have some sane mappings to VSCode constants
    assert sym('a')['kind'] == SymbolKind.Variable
    assert sym('B')['kind'] == SymbolKind.Class
    assert len(sym('B')['children']) == 1
    assert child_sym(sym('B'), '__init__')['kind'] == SymbolKind.Function
    assert child_sym(sym('B'), '__init__')['detail'] == 'B.__init__'
    assert sym('main')['kind'] == SymbolKind.Function

Example #5

def test_symbols_all_scopes(config):
    doc = Document(DOC_URI, DOC)
    symbols = pyls_document_symbols(config, doc)

    # All eight symbols (import sys, a, B, __init__, x, y, main, y)
    assert len(symbols) == 8

    def sym(name):
        return [s for s in symbols if s['name'] == name][0]

    # Check we have some sane mappings to VSCode constants
    assert sym('a')['kind'] == SymbolKind.Variable
    assert sym('B')['kind'] == SymbolKind.Class
    assert sym('__init__')['kind'] == SymbolKind.Function
    assert sym('main')['kind'] == SymbolKind.Function

    # Not going to get too in-depth here else we're just testing Jedi
    assert sym('a')['location']['range']['start'] == {'line': 2, 'character': 0}

Example #6

File: test_symbols.py Project: rbarraud/python-language-server

def test_symbols():
    doc = Document(DOC_URI, DOC)
    symbols = pyls_document_symbols(doc)

    # All four symbols (import sys, a, B, main)
    assert len(symbols) == 4

    def sym(name):
        return [s for s in symbols if s['name'] == name][0]

    # Check we have some sane mappings to VSCode constants
    assert sym('sys')['kind'] == SymbolKind.Module
    assert sym('a')['kind'] == SymbolKind.Variable
    assert sym('B')['kind'] == SymbolKind.Class
    assert sym('main')['kind'] == SymbolKind.Function

    # Not going to get too in-depth here else we're just testing Jedi
    assert sym('a')['location']['range']['start'] == {'line': 2, 'character': 0}

Example #7

File: test_symbols.py Project: pnijhara/python-language-server

def test_symbols_all_scopes(config, workspace):
    doc = Document(DOC_URI, workspace, DOC)
    symbols = pyls_document_symbols(config, doc)
    helper_check_symbols_all_scope(symbols)