Esse não é um tutorial, não é um guia, muito menos um guia completo. São apenas minhas anotações pessoais sobre Python que podem servir como um guia de referência rápida (Cheat Sheet).

• Python 3 (python2 será aposentado em 2020)
• vim
• vim-syntastic
• vim-youcompleteme
• black
• venv (virtualenv no python3)
• Dentro do venv:
  • pip via python
  • pylint3
  • pytest3

Como programo sempre em ambiente Linux com o editor VIM as dicas aqui são focadas nisso.

Meu arquivo de configuração do VIM (~/.vimrc) que chama o ~/.vimrc-python:

autocmd BufNewFile *.py              :source ~/.vimrc-python
autocmd BufRead    *.py              :source ~/.vimrc-python

Meu arquivo de configuração .vimrc-python

filetype indent on
set expandtab           " enter spaces when tab is pressed
set textwidth=90        " break lines when line length increases
set tabstop=4           " use 4 spaces to represent tab
set softtabstop=4
set shiftwidth=4        " number of spaces to use for auto indent
set autoindent
set backspace=indent,eol,start
let g:syntastic_python_python_exec = '/usr/bin/python3'
let g:syntastic_python_pylint_exec = '/usr/bin/pylint3'
source $VIMRUNTIME/indent/python.vim

• Integrado ao vim: verifica sempre que o arquivo é salvo
• Sugere:
  • Melhores comandos
  • Melhores sintaxes
  • Erros de sintaxe
  • Documentação
  • etc
• Analise se não é melhor instalar via pip dentro do venv, assim cada ambiente fica com o pylint correto direto (python2 / 3)

Uso:

• Integrado ao vim
• Via linha de comandos:

  pylint3 exemplo.py

• Para obter os códigos das mensagens:

  pylint3 --msg-template='{msg_id}:{line:3d},{column}: {obj}: {msg}' exemplo.py

• Para inibir determinada mensagem:
  • No arquivo (a partir da linha):

    # pylint: disable=C0103

  • ou:

    # pylint: disable=invalid-name

  • Numa linha:

    var = 3 # pylint: disable=C0103

  • Se precisar reabilitar (a partir da linha):

    # pylint: enable=C0103

  • Em todos os arquivos:
    • Edite o arquivo de configuração do pylint, item disable= seção [MESSAGES CONTROL]
    • Se o arquivo não existir:

      pylint3 --generate-rcfile exemplo1.py > ~/.pylintrc

• Só pra formatação
• Uso independente
• Não destrutivo

Referência sobre ambientes virtuais e sobre gerenciamento de pacotes com venv no python.

• Criando um virtualenv:

  $ python3 -m venv <path>
  # ou
  $ pyvenv <path>

• Ativando o virtualenv:

  $ source <path>/bin/activate

• Obtendo o que é usado num projeto:

  $ pip freeze

  • Pode se salvar a saída disso num arquivo para incluir no projeto como requirements.txt