How do I change Emacs's font face for Python docstrings?

I'm just starting to learn Python and use Emacs as my editor. Currently, Emacs uses the same color for normal strings (single quotes) and docstrings (triple quotes). I want docstrings to be a different color, so I used the 'Options->Customize Emacs' menu option to change 'font-lock-doc-face' to a new color and saved the changes. However, Emacs continues to keep docstrings the same color as normal strings. Changing the color of normal strings applies the change to docstrings as well.

It would seem that Emacs is treating docstrings and normal strings as the same. Is there a way to get Emacs to properly find and color Python docstrings separately from normal strings?

Edit: I'm using Emacs 23.1.1 (Kubuntu 10.10 package) with the default Python mode settings. I also use the color-theme package with the midnight theme.


Asked by: Ryan731 | Posted: 30-11-2021






Answer 1

Interesting. I was going to say that due to the way the emacs syntax table works, emacs thinks """ and ''' represent an empty string folowed by the start of a new string.

You can easily verify this in your copy of emacs by pasting the following code into a python buffer:

class MrsRobinson(object):
    '''
    What's that you say?
    '''
    pass

In emacs 23.1.1 [update: and apparently on stackoveflow!] this completely breaks the syntax highlighting for the rest of the file.

I always use """ specifically to avoid apostrophe problems in docstrings, so I didn't notice until right this minute that in emacs 23.2.1, this is somehow finally fixed...

(Yep, there's a new function called python-quote-syntax in python.el)

So: in your version of emacs, this is impossible because the strings aren't parsed correctly. If you upgrade to the latest emacs, you may be able to make it happen by modifying that function in python.el to treat them differently.

Answered by: Roman114 | Posted: 01-01-2022



Answer 2

I was able to accomplish this:

By doing M-x customize-face and enter: font-lock-doc-face.

The reason they are both the same color is because font-lock-doc-face inherits from font-lock-string-face:

I updated font-lock-string-face to font-lock-comment-face (as I prefer my doc-strings to have the same color as my comments). You can either do the same or select "Show all attributes" to choose your own

Answered by: Alissa152 | Posted: 01-01-2022



Similar questions

python - Docstrings for data?

Is there a way to describe the module's data in a similar way that a docstring describes a module or a funcion? class MyClass(object): def my_function(): """This docstring works!""" return True my_list = [] """This docstring does not work!"""


syntax error - python docstrings

ok so I decided to learn python (perl, c, c++, java, objective-c, ruby and a bit of erlang and scala under my belt). and I keep on getting the following error when I try executing this: Tue Jul 21{stevenhirsch@steven-hirschs-macbook-pro-2}/projects/python:-->./apache_logs.py File "./apache_logs.py", line 17 print __doc__ ^ SyntaxError: invalid syntax #!/usr/local/bin/python """...


Python decorator handling docstrings

I have a problem using docstrings with decorators. Given the following example: def decorator(f): def _decorator(): print 'decorator active' f() return _decorator @decorator def foo(): '''the magic foo function''' print 'this is function foo' help(foo) Now the help doesn't show me the docstring of foo as expected, it shows: Hel...


Are Python docstrings and comments stored in memory when a module is loaded?

Are Python docstrings and comments stored in memory when a module is loaded? I've wondered if this is true, because I usually document my code well; may this affect memory usage? Usually every Python object has a __doc__ method. Are those docstrings read from the file, or processed otherwise? I've done searches here in the forums, Google and...


How to fold long docstrings in python source code in VIM?

Does anybody know of a method, or perhaps a plugin, that will automatically fold long docstrings in Python? I have docstrings in my code that span several pages, so it is troublesome to keep paging through them. The other tricky part is that there is embedded python testing code in the docstrings, so that might make parsing them difficult. Note that I only need to automatically fold the entire docstr...


python - Using shorter textwidth in comments and docstrings

From the mighty PEP 8: [P]lease limit all lines to a maximum of 79 characters. For flowing long blocks of text (docstrings or comments), limiting the length to 72 characters is recommended. When editing Python code in Vim, I set my textwidth to 79, and Vim au...


python - Writing docstrings - specifying functions arguments and returns

Suppose I have a function, say: >>> def foo(a): return a+1 I want to write a documentation string for it. what is the convention in specifying in the docstring that it takes a and returns a+1?


python - Is there a way to keep docstrings separate from the functions they document?

I'm working on a module with many small functions but whose docstrings tend to be quite long. The docstrings make working on the module irritating as I have to constantly scroll over a long docstring to find a little bit of actual code. Is there a way to keep docstrings separate from the functions they document? I'd really like to be able to specify the docstrings at the end of the file away from the code or, even...


python - Put docstrings on special methods?

I'm trying to decide what information to put in the class docstring and what to put in the __init__ method docstring. Up until now I've been putting an overview of the class and how to work with it in the class docstring, while stuff directly related to initialization (argument details etc.) I put in the __init__ docstring. Today I started wondering if this was the right way of doing it, s...


static analysis - How to calculate lines of code, comments and docstrings for a Python module?

Is there a tool or snippet that produces the following output in some form: lines_of_code = 98 lines_of_comments = 24 lines_of_documentation = 11 NOTE 1: I will then try to feed this data to Jenkins to graph. NOTE 2: I am aware that CLOC co...






Still can't find your answer? Check out these communities...



PySlackers | Full Stack Python | NHS Python | Pythonist Cafe | Hacker Earth | Discord Python



top