Skip to content

Latest commit

 

History

History
95 lines (79 loc) · 3.26 KB

README.md

File metadata and controls

95 lines (79 loc) · 3.26 KB
Raw

PyTags

This package provides Python source code indexing and navigation in Sublime Text 2. You can also enable import completions.

Quick Start

Install the package and add to your settings:

"pytags_index_on_load": true,
"pytags_index_on_save": true,
"pytags_databases":
    [
        {
            "include_project_folders": true,
            "path": "$HOME/.pytags.db"
        }
    ]

Now all Python files that you open or that are in your project folders will get indexed.

Requirements

Since SQLite is used to store indexed data, external python interpreter is used (Sublime's embedded interpreter doesn't ship with sqlite module). Just make sure that

python -u some_script.py

works. I tested it with Python 2.7, but I expect it to work with Python >= 2.6, 3.x included.

Command Palette

  • Update Index - Indexes files that have changed since last scan.
  • Rebuild Index - Indexes all files.
  • Find Definition - Skips to specified symbol definition.

Key Bindings

Ctrl+T, Ctrl+R updates the index. Ctrl+T, Ctrl+T skips to definition of symbol under cursor.

Settings

  • pytags_index_on_save - Whether to index saved files.
  • pytags_index_on_load - Whether to index opened files.
  • pytags_complete_imports - Whether to enable import completions.
  • pytags_exclusive_completions - Whether regular completions should be hidden when import completions are available.
  • pytags_databases - List of databases to search/update, see next section.

Database Definitions

You can use multiple databases at a time. This allows indexing of project related stuff in one place and site packages in another, sharing some databases among different projects. Each database definition requires "path" field (path to the SQLite database file), and may include any of the following fields:

  • include_project_folders - Whether this database should index files found in project folders.
  • roots - List of directories containing files that should be indexed.
  • pattern - Regular expression that each indexed file should match.

All file paths can contain environment variables expandable with Python's os.path.expandvars.

Import Completions

With import completions on, typing from <ctrl+space> will pop up a list of indexed modules, and typing from foo.bar import <ctrl+space> will bring up a list of indexed foo.bar's members.

Compatibility Issues

For completions to work, a little extended "Python (PyTags)" syntax is required. If you enable import completions, it will be automatically used instead of default Python syntax. "Python (PyTags)" top-level scope is source.python.pytags. Plugins that incorrectly check scopes, like

"some_string" in scope.split()

may have compatibility issues. Also, the syntax file name is "Python.tmLanguage", which makes View->Syntax menu incorrectly mark both Python and Python (PyTags) as currently used. Using this name makes Sublime Linter work though.