Code Style

[brunobelarmino]

Hey @lafrech @losintikfos,
i was wondering whether editorconfig and pylint can't help us keeping away problems like:

• space vs tab
• trailing whitespace
• pep8 code conventions

is it a good idea?

[lafrech]

Hi @brunobelarmino.

I totally support pylint usage.

I use vi with syntastic plugin to check the code with pylint when I write a file.

Here's my syntastic config (I tweaked a bit the suggested one because it screwed up the diffs):

" https://github.com/scrooloose/syntastic
set statusline+=%#warningmsg#
set statusline+=%{SyntasticStatuslineFlag()}
set statusline+=%*
let g:syntastic_always_populate_loc_list = 1
let g:syntastic_auto_loc_list = 0
let g:syntastic_check_on_open = 0
let g:syntastic_check_on_wq = 0
:command SC SyntasticToggleMode

function! ToggleErrors()
    let old_last_winnr = winnr('$')
    lclose
    if old_last_winnr == winnr('$')
        " Nothing was closed, open syntastic error location panel
        Errors
    endif
endfunction

nnoremap <silent> <C-e> :<C-u>call ToggleErrors()<CR>

Using this, I can show/hide the error panel using Ctrl+E.

I also have a script that does a few useful modifications (trailing whitespace, tabs -> 4 spaces, AltGr+space -> space).

(In the second line, the first space in the replacement commend should be a Alt

And I never did it before, but there are ways to integrate pylint with GitHub to check commits, probably through Travis.

From a quick search:

xenserver/xenserver-build-env@274423f
http://stackoverflow.com/questions/12450348/how-to-integrate-any-python-lint-with-github-commit-status-api
http://stackoverflow.com/questions/9799209/enforcing-pep-8ish-formatting-in-github-commits

Total perfection is probably unreachable under pylint, unless we remove a lot of rules, so we should make sure we won't get a failed status under Travis just because of pylint. What we want is not a boolean status, but rather a mark (/100) and ideally a readable report that points the warnings / errors that were introduced.

I don't know if this is readily available or if it needs tweaking a bit with the configuration.

[lafrech]

BTW, @brunobelarmino, if you're interested in further development of flask-mongoengine, and maybe join the team, please show up in #71.

[brunobelarmino]

thanks @lafrech for your tip! 😀

[lafrech]

I think we can close this.

flask8 is not added to Travis (#270) and will report code style issues.

It is up to the dev to chose his own tools to check code style while coding.