Awesome
Python Improved
A better Python .tmLanguage
syntax highlighting definition for Sublime Text and TextMate. It includes support for both Python 2 and Python 3, and unlike any other Python syntax definition now fully supports Unicode identifiers anywhere in your code! It also provides its own improved regex syntax definition for inline highlighting of raw string literals.
Inspired by:
- the original TextMate and Sublime Text
Python.tmLanguage
files - facelessuser's Better Python
- Peter Varo's Python 3 syntax definition
as well as a number of my own changes to make things more consistent and understandable. For customized syntax highlighting taking advantage of all the new scopes, use PythonImproved with the Neon Color Scheme, or modify your own favorite color scheme with the scopes below.
Installation and Use
If you haven't already, install Package Control, then select Python Improved
from the Package Control: Install Package
option in the Command Palette. To use PythonImproved as your default Python syntax, open a .py
file, then select View -> Syntax -> Open all with current extension as... -> PythonImproved
.
While I haven't yet tried to install PythonImproved with TextMate, I can't think of a good reason as to why it wouldn't work. You could try putting it in the same directory as the standard Python.tmbundle
package, in the Syntaxes
subdirectory. Then, just pick PythonImproved
from the syntax menu.
New/Changed Scopes
If you prefer to modify your own color scheme, here is a list of new/modified scopes, along with some examples. It's not perfectly complete, but it's a start.
support.ipython.in
andsupport.ipython.out
: IPythonIn [1]:
/Out [1]:
fields — designed for use with SublimeREPL. The cell number can be themed with a different color usingsupport.ipython.cell-number
.constant.numeric.integer.(long).binary.python
: binary literals0b00101010
,0b00101010L
keyword.control.import.python
now containsimport
,from
, andas
support.type.exception.python
now matches any identifier that ends withException
orError
, not just the built-in ones likeIndentationError
orRuntimeException
, allowing for the highlighting of custom exceptions such as those included in third-party modules.- Function annotation support for Python 3, thanks to @facelessuser. New scopes added:
punctuation.separator.annotation.python
,punctuation.separator.annotation.result.python
,punctuation.definition.parameters-group.begin.python
, andpunctuation.definition.parameters-group.end.python
. - You can now have comments in multi-line function definitions:
def myfunc(self, # gotta have self
param1="value", # values are cool
param2=True, # or False, whatever
*args, # I'm here for an argument
**kwargs): # you never know
- New scopes for bytes, unicode, and raw/regex strings, thanks to @simonzack:
string.quoted.(single|double).(block|single-line).(bytes|bytes-raw|bytes-raw-regex).python
- Also from @simonzack, highlighting of
self|cls
in parameter strings:variable.parameter.function.(keyword|language)
comment.line.note.python
is a comment line that contains(BUG|FIXME|TODO|XXX)
at the beginning.comment.line.note.notation.python
matches the actual word itself, so you can differentially highlight the word and the whole line:
constant.other.allcaps.python
captures variable names that are in all caps (OPENING_PORT
, for example), assuming the convention that these are generally treated as constants in the code. MatchesCONSTANT
,class.CONSTANT
and theCONSTANT
part ofCLASS.CONSTANT
, but notCLASS.function()
,class.FUNCTION()
, orFUNCTION()
.- Fixed the octal integers so the Python 3-style
0o123
is matched as well as the old-style0123
- Built-in functions like
any()
,dict()
,len()
,raw_input()
, etc. now have their arguments highlighted just like any other function. Many thanks to @facelessuser for the regex, and @FichteFoll for valuable discussion. For those working with Python 2,print
is still a standalone keyword (as areassert
anddel
). support.function.magic
andsupport.function.builtin
have now been split in two —name
andcall
, so that__init__
(support.function.magic.name.python
), for example, can be themed differently than__init__()
(support.function.magic.call.python
).- Relatedly, magic function names (and calls), also known as the "dunder" methods for being surrounded by double underscores, have been collated from the 2.7 and 3.5 Data Model docs and cleaned up so that as much as possible is included there, but outdated or incorrect things are not. The same is true of the magic variables (
support.variable.magic
). support.type
now contains only what's defined in https://docs.python.org/X/library/functions.html and stdtypes.html (whereX
is2
or3
) where the item is a class. They are highlighted as such only if not followed by an opening parenthesis — if it is, it's highlighted assupport.function.builtin.call
. This addresses #16.- Defined escaped characters (like
\n
,\'
,\\
, etc.) are now individually named asconstant.character.escape.*
, where*
isnewline
,single-quote
,backslash
, etc. - And probably some more stuff I forgot about...
Notes
- To facilitate hacking, I'm also including my
.YAML-tmLanguage
file in the repo, which I use for my day-to-day work (I really hate debugging regexes embedded in XML). InstallPackageDev
for syntax highlighting, and tools for converting between YAML, JSON, and XML/Plist formats. Neon of course has great coloring for the.YAML-tmLanguage
format, and especially the regexes :) - Speaking of which, for raw/regex strings, regexes will be scoped according to the accompanying
Regular Expressions (Python Improved).tmLanguage
file, instead of the builtin Python regular expressions definition. If you're using Neon for syntax highlighting (or any color scheme that highlights regexes), use a lowercaser
to denote your string as containing a regex (i.e.,r"\b(?i:(0[o]?[0-7]+))"
). However, if you're just using a raw string literal to, for example, define a Windows path and you don't want regex highlighing for all the back slashes and whatnot, use an uppercaseR
(R"C:\Users\MattDMo"
). Python can't tell the difference, but it will look nicer in your editor. - All Django-related stuff has been removed. If you want it back, just dig through the repo's history and you can find it. It was just too distracting.
- I removed the SQL-related stuff from the string definitions, because 1) somebody complained, and 2) like Django, it was distracting. It didn't cover all of SQL, only highlighted some keywords, and just wasn't worth it.
- Unicode escapes should now appear correctly in all strings, as with Python 3 all strings are Unicode. I think I got it right, if you think otherwise just let me know.
- I've begun working on correctly highlighting all the various elements of the new-style string formatting mini-language, but I haven't applied it to the most recent release while I work out the kinks. Feel free to join the discussion.
- Now that the ST3 public beta supports
.sublime-syntax
files, I'm going to begin transitioning PI over to that format. If you'd like to contribute, chime in on this issue. One major advantage will be fixing this bug with raw string literals.
Issues
If you have questions, concerns, or suggested improvements, I'd love to hear from you! Feel free to open an issue or send a pull request and I'll get back to you as soon as I can. You can also email me at mattdmo@mattdmo.com or find me on Twitter @MattDMo.
License
© 2013-2022 Matt Morrison mattdmo@mattdmo.com.
This is free software. It is licensed under the MIT License. Feel free to use this in your own work. However, if you modify and/or redistribute it, please attribute me in some way, and it would be great if you distribute your work under this or a similar license, but it's not required.. A shout-out or a beer would be appreciated.
Support
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=R97MGGYES6GAJ&lc=US&item_name=Matthew%20D%2e%20Morrison&item_number=PythonImproved¤cy_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHosted"><img src="https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif" border="0" name="Donate" alt="PayPal - The safer, easier way to pay online!"></a>