/!\ This page is primarily intended for Mercurial's developers.

Coding Style

How to make your code pretty the Mercurial way.

1. Introduction

This page is intended to save new developers a few round-trips when contributing changes. It doesn't cover everything, but it does cover some of the most common mistakes people make.

2. Some code doesn't agree with the coding style!

Yes, because some code predates the coding style and has not yet been rewritten to conform. Please follow the coding style for all new code.

3. Naming conventions

For consistency and ease of reference, Mercurial uses a single style for all identifiers: all lowercase, with no underbars between words. This matches Python's core style (with the notable exception of has_key which is deprecated). For private methods and helper functions, the convention is to use a single leading underbar. Use a trailing underbar to avoid shadowing built-ins and imported modules.

Throughout the code, the following variables usually refer to the same thing:

name

description

p1, p2

first and second parents

ctx

a context.changectx instance (or derivative)

fctx

a context.filectx instance

fn, fname

filename

fp

a python file(like) object

repo

a localrepo or review object

unfi

an unfiltered local repo instance

4. Whitespace and syntax

We approximately follow PEP 8 guidelines for whitespace:

5. Language features and compatibility

6. Classes

7. Unicode and character encoding

Character encoding is a complex topic (see Encoding Strategy for an overview) but Mercurial generally follows these rules:

8. Status and error messages

Short messages should look like this:

adding foo.txt

Note the following:

Some existing strings don't follow this style and are kept like that for backwards compatibility reasons. But please write all new strings in this style.

The above message should look like this in your code:

ui.status(_('adding %s\n') % filename)

Please note:

9. Miscellaneous

10. Automated checking

A lot of the rules in this document and a bunch of others can be automatically checked with our 'check-code' script:

$ python contrib/check-code.py --blame `hg manifest`
mercurial/i18n.py:42 (working directory):
 >     u = u'\n\n'.join([p and t.ugettext(unicode(p, 'ascii')) or '' for p in paragraphs])
 line too long

We recommend you run this script before every submission. In addition to catching style and portability issues in Python code, it will also inspect our C code and test suite.

11. See also


CategoryDeveloper

CodingStyle (last edited 2017-05-13 21:34:57 by GregorySzorc)