Compartilhar via

Formatar código nos notebooks do Microsoft Fabric

Existem muitos benefícios em adotar um bom estilo e convenções ao gravar um Notebook em Python ou uma definição de trabalho do Apache Spark. Ao formatar seu código de forma consistente, você pode:

  • Facilitar a leitura do código.
  • Aumenta a capacidade de manutenção do código.
  • Conduzir revisões de código mais rápidas.
  • Execute diferenças mais precisas, que detectam alterações entre as versões.

Especificamente, este artigo descreve como você pode estender um notebook do Fabric para usar um formatador de código em conformidade com PEP 8.

Observação

PEP é o acrônimo de Propostas de Aprimoramento do Python. PEP 8 é um guia de estilo que descreve as convenções de codificação para o código Python.

Ampliar os notebooks do Fabric

Você pode estender um notebook do Fabric usando uma extensão de notebook. Uma extensão de notebook é um componente de software que adiciona novas funcionalidades à interface do notebook. Você instala uma extensão como uma biblioteca e, em seguida, a configura para atender às suas necessidades específicas.

Este artigo considera duas extensões que você pode usar para formatar o código Python em um notebook do Fabric. Ambas as extensões estão disponíveis gratuitamente no GitHub.

  • A extensão black do formatador de código Python.
  • A extensão do formatador jupyter-black, que você também pode usar para formatar automaticamente o código em um Jupyter Notebook ou Jupyter Lab.

Configurar uma extensão de formatador de código

Existem dois métodos para configurar uma extensão de formatador de código em um notebook do Fabric. O primeiro método envolve configurações do espaço de trabalho, enquanto o segundo método envolve a instalação em linha. Habilite a formatação de código após instalar a extensão.

Configurações do workspace

Use as configurações do espaço de trabalho para configurar o ambiente de trabalho para um Workspace do Fabric. Para disponibilizar suas bibliotecas para uso em quaisquer notebooks e definições de trabalho do Spark no espaço de trabalho, você pode criar o ambiente, instalar as bibliotecas nele e, em seguida, o administrador do espaço de trabalho pode anexar o ambiente como padrão para o espaço de trabalho. Portanto, quando uma extensão de formatador de código é instalada no ambiente padrão do espaço de trabalho, todos os notebooks dentro do espaço de trabalho podem se beneficiar dela.

Para obter mais informações sobre ambientes, confira Criar, configurar e usar um ambiente no Microsoft Fabric.

Instalação em linha

Use o método de instalação em linha quando desejar instalar uma biblioteca para um notebook específico, ao invés de todos os notebooks em um espaço de trabalho. Essa abordagem é conveniente quando você deseja uma solução temporária ou rápida que não deve afetar outros notebooks no espaço de trabalho.

Para saber como realizar uma instalação em linha, confira Instalação em linha.

No exemplo a seguir, o comando %pip é usado para instalar a versão mais recente da extensão Jupyter-black nos nós do driver e do executor.

# Install the latest version by using %pip command
# It will be available on both driver and executor nodes
%pip install jupyter-black

Habilitar a formatação de código

Após instalar a extensão de formatação de código, você deve habilitar a formatação de código para o notebook. Você faz isso carregando a extensão, o que pode ser feito de duas maneiras.

Use o comando magic %load_ext.

# Load the jupyter-black extension
%load_ext jupyter_black

Ou use a extensão de carga usando a API de programação.

import jupyter_black
jupyter_black.load()

Dica

Para garantir que todos os notebooks habilitem a formatação de código, o que pode ser útil em cenários de desenvolvimento empresarial, habilite a formatação em um notebook modelo.

Código de formatação

Para formatar o código, selecione as linhas de código que deseja formatar e pressione Shift+Enter.

As 11 linhas de código a seguir ainda não estão formatadas corretamente.

def unique(list_input):
    list_set = set(list_input
    )
    unique_list = (list(
        list_set
        )
    )
    for x in unique_list:
        print(
            x
        )

Após a formatação ter sido aplicada, a extensão reduziu o script para apenas cinco linhas. O código agora adota um bom estilo e convenções.

def unique(list_input):
    list_set = set(list_input)
    unique_list = list(list_set)
    for x in unique_list:
        print(x)

Conteúdo relacionado

Para obter mais informações sobre os notebooks do Fabric, confira os artigos a seguir.