ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Py​Tags

by qfel ST2

Python source code indexing and completion

Details

  • 2012.12.15.22.34.57
  • github.​com
  • github.​com
  • 7 years ago
  • 1 hour ago
  • 7 years ago

Installs

  • Total 5K
  • Win 3K
  • OS X 887
  • Linux 1K
Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14 Jul 13 Jul 12 Jul 11 Jul 10 Jul 9 Jul 8 Jul 7 Jul 6 Jul 5 Jul 4 Jul 3 Jul 2 Jul 1 Jun 30 Jun 29 Jun 28 Jun 27 Jun 26 Jun 25 Jun 24 Jun 23 Jun 22 Jun 21 Jun 20 Jun 19 Jun 18 Jun 17 Jun 16 Jun 15 Jun 14 Jun 13 Jun 12 Jun 11 Jun 10 Jun 9 Jun 8 Jun 7
Windows 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
OS X 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

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 “shell 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
```python
"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.