superhelp

https://github.com/grantps/superhelp

Número da versão: 1.9.5 Autor: Grant Paton-Simpson

Visão geral

Superhelp é ajuda para humanos! O objetivo é fornecer ajuda personalizada para trechos de código simples. O Superhelp não se destina a substituir a ajuda do Python embutida, mas a complementá-lo para as estruturas básicas de código Python. O Superhelp também será opinativo. A ajuda pode ser fornecida em uma variedade de contextos, incluindo os navegadores do terminal e da web (talvez como parte dos tutoriais on-line).

Início rápido

Clique no botão abaixo para abrir um caderno Jupyter que você pode brincar em por exemplo, obtenha conselhos sobre um snippet ou linha de python

Ou coloque o seguinte no topo do seu script python e execute o script:

 import superhelp
superhelp.this()

Instalação

Nota - Python 3.9+ somente. Se você tiver uma versão mais antiga do Python, use o botão Jupyter Notebook (veja mais alto)

Para instalar

Observação

1. Use pip

Por exemplo

 $ python3 -m pip install superhelp

Verifique a execução

 $ shelp

Se não funcionar, e você estiver no Linux, adicionando o seguinte ao seu arquivo .bashrc pode corrigir o problema:

 export PATH=$PATH:~/.local/bin

2. Ou clonar o repositório

   $ git clone https://github.com/grantps/superhelp.git $ python3 setup.py install

Exemplo de uso de casos

• Charlotte gosta de verificar seu código antes que outros o vejam, então inclui

    import superhelp
    superhelp.this(warnings_only=True)
  

  no topo de cada script. Quando ela está feliz com o código, comenta essas duas linhas.

• Avi é iniciante em Python e quer obter conselhos sobre uma função de cinco linhas que ele escreveu para exibir saudações para uma lista de pessoas. Ele aprende sobre as convenções do Python para nomeação variável e melhores maneiras de combinar cordas.

• Zach quer obter conselhos sobre uma tupla nomeada. Ele aprende a adicionar strings de documentos aos campos individuais.

• Noor está pensando em enviar algum código para empilhar o excesso, mas deseja melhorá -lo primeiro (ou possivelmente obter idéias para uma solução diretamente). Ela descobre que uma compreensão da lista pode funcionar. Ela também toma conhecimento das compreensões do dicionário pela primeira vez.

• Al escreveu um decorador simples de Python, mas está querendo ver se há algo que pode ser melhorado. Ele aprende a usar o functool.wrap de um exemplo fornecido.

• Moana é uma desenvolvedora experiente em Python, mas tende a esquecer coisas como Strings de Doc em suas funções. Ela aprende uma abordagem padrão e começa a usá -la com mais frequência. Moana também acha útil o revestimento resumido.

• Paul quer verificar a qualidade de algum código antes de incluí -lo em seu projeto. Ele aprende sobre alguns problemas e faz melhorias antes de integrá -las.

Exemplo de uso

Captura de tela da saída HTML

Captura de tela da saída do terminal

Temas do terminal disponíveis ('Dark' e 'Light')

Captura de tela da saída de Markdown

Usando o Superhelp no caderno

Adicione nova célula no final com conteúdo como:

 %%shelp

def sorted(my_list):
    sorted_list = my_list.sort()
    return sorted_list

e execute -o para obter conselhos.

O notebook possui instruções mais detalhadas no topo.

Usando o Superhelp em uma instalação local

Dentro do seu script

Coloque o seguinte na parte superior do seu script e execute o script (nota - existem dois sublinhados em ambos os lados do arquivo):

 import superhelp
superhelp.this()

Se você não deseja a saída da web padrão, pode especificar outra saída como 'CLI' (interface da linha de comando) ou 'MD' (Markdown):

 import superhelp
superhelp.this(output='md')

Se você não deseja o nível padrão 'extra' de mensagens, você pode especificar um nível de detalhe diferente ('breve' ou 'main'), por exemplo,

 import superhelp
superhelp.this(detail_level='Brief')

ou:

 import superhelp
superhelp.this(detail_level='Main')

Se você quiser ver apenas avisos, pode especificar avisos apenas por exemplo

 import superhelp
superhelp.this(warnings_only=True)

A execução do seu código permite que o Superhelp compreenda melhor seu código.

Se você deseja que seu código seja executado enquanto o Superhelp está avaliando

 import superhelp
superhelp.this(execute_code=True)

Você pode usar quantas opções quiser, por exemplo

 import superhelp
superhelp.this(output='md', execute_code=True, warnings_only=True)

Da linha de comando (terminal / console)

 $ shelp -h  ## get extended help on usage (purpose, defaults, etc)

$ shelp --code "people = ['Tomas', 'Sal', 'Raj']" --output html --detail-level Main
$ shelp -c "people = ['Tomas', 'Sal', 'Raj']" -o html -d Main

$ shelp --file-path my_script.py --output cli --theme light --detail-level Extra
$ shelp -f my_snippet.py -o cli -t light -d Extra

$ shelp --project-path /home/g/proj --exclude-folders env
$ shelp -p /home/g/proj -e env

$ shelp --file-path my_script.py --warnings-only
$ shelp -f my_snippet.py -w

$ shelp --file-path my_script.py --execute-code
$ shelp -f my_snippet.py -x

$ shelp  ## to see advice on an example snippet displayed (detail level 'Extra')

$ shelp --advice-list  ## to see all types of help listed
$ shelp -a

Idéias de alongamento

• Estenda além da biblioteca padrão em bibliotecas populares, como solicitações, garrafa, frasco etc.

Outros pacotes

https://github.com/aroberge/friendly-traceback