Configurando seu projeto em Python para Codespaces

Dê os primeiros passos com seu projeto Python em Codespaces criando um contêiner de desenvolvimento personalizado.

Codespaces is available for organizations using GitHub Team or GitHub Enterprise Cloud. Para obter mais informações, consulte os "produtos do GitHub".

Introdução

Este guia mostra como configurar seu projeto Python em Codespaces. Ele irá apresentar a você um exemplo de abertura de seu projeto em um codespace e adicionar e modificar uma configuração de contêiner de desenvolvimento a partir de um modelo.

Pré-requisitos

  • Você deve ter um projeto Python existente em um repositório em GitHub.com. Se você não tiver um projeto, você poderá tentar este tutorial com o seguinte exemplo: https://github.com/2percentsilk/python-quickstart.
  • Você precisa ter Codespaces habilitado para a sua organização.

Etapa 1: Abra o seu projeto em um codespace

  1. No nome do repositório, use o menu suspenso Código de e na aba Codespaces de código, clique em Novo codespace.

    Botão de codespace novo

    Se você não vir esta opção, significa que Codespaces não está disponível para o seu projeto. Consulte Acesso a Codespaces para mais informações.

Ao criar um código, seu projeto será criado em uma VM remota dedicada a você. Por padrão, o contêiner para o seu código possui muitas linguagens e tempos de execução, incluindo Node.js, JavaScript, Typescript, nvm, npm e yarn. Ele também inclui um conjunto comum de ferramentas, como git, wget, rsync, openssh e nano.

Você pode personalizar o seu codespace ajustando a quantidade de vCPUs e RAM, adicionando dotfiles para personalizar seu ambienteou modificando as ferramentas e scripts instalados.

Codespaces usa um arquivo denominado devcontainer.json para armazenar configurações. Ao iniciar, Codespaces usa o arquivo para instalar quaisquer ferramentas, dependências ou outro conjunto que possa ser necessário para o projeto. Para obter mais informações, consulte "Introdução a contêineres de desenvolvimento".

Etapa 2: Adicione um contêiner de desenvolvimento ao seu codespace a partir de um modelo

O contêiner de códigos padrão vem com a versão mais recente do Python, gerenciadores de pacotes (pip, Miniconda) e outras ferramentas comuns pré-instaladas. No entanto, recomendamos que você configure um contêiner personalizado para definir as ferramentas e scripts de que seu projeto precisa. Isso garantirá um ambiente reprodutível para todos os usuários de Codespaces do seu repositório.

Para configurar seu projeto com um contêiner personalizado, você deverá usar um arquivo devcontainer.json para definir o ambiente. Em Codespaces, você pode adicionar isto a partir de um modelo ou você pode criar o seu próprio. Para obter mais informações sobre contêineres de desenvolvimento, consulte "Introdução a contêineres de desenvolvimento".

  1. Access the Paleta de Comando do VS Code (Shift + Command + P / Ctrl + Shift + P), then start typing "dev container". Selecione Codespaces: Adicionar arquivos de configuração de Contêiner do Desenvolvimento....

    "Codespaces: Add Development Container Configuration Files..." in the Paleta de Comando do VS Code

  2. Para este exemplo, clique em Python 3. Se precisar de funcionalidades adicionais, você poderá selecionar qualquer contêiner específico para Python ou uma combinação de ferramentas como Python 3 e PostgreSQL. Selecione a opção Python na lista

  3. Clique na versão recomendada do Python. Seleção de versão Python

  4. Aceite a opção padrão para adicionar Node.js à sua personalização. Adicionar seleção de Node.js

  5. Access the Paleta de Comando do VS Code (Shift + Command + P/ Ctrl + Shift + P), then start typing "rebuild". Selecione Codespaces: Reconstruir Contêiner.

    Opção de reconstruir contêiner

Anatomia do seu contêiner de desenvolvimento

A adição do modelo de contêiner de desenvolvimento do Python adiciona uma pasta .devcontainer à raiz do repositório do seu projeto com os seguintes arquivos:

  • devcontainer.json
  • arquivo Docker

O arquivo recém-adicionado devcontainer.json define algumas propriedades que são descritas após a amostra.

devcontainer.json

{
    "name": "Python 3",
    "build": {
        "dockerfile": "Dockerfile",
        "context": "..",
        "args": {
            // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9
            "VARIANT": "3",
            // Options
            "INSTALL_NODE": "true",
            "NODE_VERSION": "lts/*"
        }
    },

    // Set *default* container specific settings.json values on container create.
    "settings": {
        "terminal.integrated.shell.linux": "/bin/bash",
        "python.pythonPath": "/usr/local/bin/python",
        "python.linting.enabled": true,
        "python.linting.pylintEnabled": true,
        "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
        "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
        "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
        "python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
        "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
        "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
        "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
        "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
        "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint"
    },

    // Add the IDs of extensions you want installed when the container is created.
    "extensions": [
        "ms-python.python",
    ],

    // Use 'forwardPorts' to make a list of ports inside the container available locally.
    // "forwardPorts": [],

    // Use 'postCreateCommand' to run commands after the container is created.
    // "postCreateCommand": "pip3 install --user -r requirements.txt",

    // Comment out connect as root instead. Mais informações: https://aka.ms/vscode-remote/containers/non-root.
    "remoteUser": "vscode"
}
  • Nome - Você pode dar qualquer nome ao nosso contêiner de desenvolvimento. Este é apenas o padrão.
  • Build - As propriedades de compilação.
    • Arquivo Docker - No objeto de compilação, arquivo Docker é uma referência ao arquivo arquivo Docker que também foi adicionado a partir do template.
    • Args
      • Variante: Este arquivo contém apenas um argumento de compilação, que é a variante de nó que queremos usar e que é passada para o arquivo Docker.
  • Configurações - Estas são as configurações de Visual Studio Code.
    • Terminal.integrated.shell.linux - Embora o bash seja o padrão, você pode usar outros shells do terminal, fazendo a modificação.
  • Extensões - Estas são extensões incluídas por padrão.
    • ms-python. ython - A extensão Microsoft Python fornece um amplo suporte para a linguagem do Python (para todas as versões ativamente compatíveis da linguagem: >=3.), incluindo recursos como IntelliSense, linting, depuração, navegação de código, formatação de código, refatoração, explorador de variáveis, explorador de teste e muito mais.
  • forwardPorts - Todas as portas listadas aqui serão encaminhadas automaticamente. Para obter mais informações, consulte "Encaminhando portas no seu codespace".
  • postCreateCommand - Se você quiser executar qualquer coisa depois de pousar no seu codespace, isso não está definido no arquivo Docker como pip3 install -r requirements. Você pode fazer isso aqui.
  • remoteUser - Por padrão, você está executando como usuário do vscode, mas, opcionalmente, você pode definir isso como root.

arquivo Docker

# [Choice] Python version: 3, 3.9, 3.8, 3.7, 3.6
ARG VARIANT="3"
FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}

# [Option] Install Node.js
ARG INSTALL_NODE="true"
ARG NODE_VERSION="lts/*"
RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi

# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image.
# COPY requirements.txt /tmp/pip-tmp/
# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \
#    && rm -rf /tmp/pip-tmp

# [Optional] Uncomment this section to install additional OS packages.
# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
#     && apt-get -y install --no-install-recommends <your-package-list-here>

# [Optional] Uncomment this line to install global node packages.
# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

Você pode usar o arquivo Docker para adicionar camadas adicionais de contêiner para especificar os pacotes do OS, versões de nó ou pacotes globais que queremos que sejam incluídos no nosso contêiner.

Etapa 3: Modifique seu arquivo devcontainer.json

Com o seu contêiner de desenvolvimento adicionado e um entendimento básico do que tudo faz, agora você pode fazer alterações para configurá-lo para o seu ambiente. Neste exemplo, você irá adicionar propriedades para instalar extensões e dependências do seu projeto quando seu codespace for iniciado.

  1. No Explorador, expanda a pasta .devcontainer e selecione o arquivo devcontainer.json a partir da árvore para abri-lo.

    Arquivo devcontainer.json no Explorador

  2. Atualize a lista de extensões `no seu arquivodevcontainer.json` para adicionar algumas extensões que são úteis ao trabalhar com seu projeto.

    JSON
    "extensions": [
            "ms-python.python",
            "cstrap.flask-snippets",
            "streetsidesoftware.code-spell-checker",
        ],
  3. Remova o comentário o postCreateCommand para instalar automaticamente os requisitos como parte do processo de configuração dos codespaces.

    JSON
    // Use 'postCreateCommand' para executar os comandos após a criação do contêiner.
    "postCreateCommand": "pip3 install --user -r requirements.txt",
  4. Access the Paleta de Comando do VS Code (Shift + Command + P/ Ctrl + Shift + P), then start typing "rebuild". Selecione Codespaces: Reconstruir Contêiner.

    Opção de reconstruir contêiner

    A reconstrução dentro do seu codespace garante que as suas alterações funcionem conforme o esperado antes de realizar o commit das alterações no repositório. Se algo falhar, você será colocado em um codespace com um contêiner de recuperação que você pode reconstruir para continuar ajustando o seu contêiner.

  5. Verifique se suas alterações foram aplicadas com sucesso verificando se as extensões Code Spell Checker e Flask Snippet foram instaladas.

    Lista de extensões

Etapa 4: Execute o seu aplicativo

Na seção anterior, você usou o postCreateCommand para instalar um conjunto de pacotes via pip3. Com suas dependências agora instaladas, você pode executar seu aplicativo.

  1. Execute seu aplicativo pressionando F5 ou digitando python -m Flask run no terminal do codespace.

  2. Quando o seu projeto for iniciado, você deverá ver um alerta no canto inferior direito com uma instrução para conectar-se à porta que seu projeto usa.

    Notificação de encaminhamento de porta

Etapa 5: Faça commit das suas alterações

Depois de realizar alterações no seu código, tanto novo código como de configuração, você deverá fazer commit das suas alterações. O commit das alterações no seu repositório garante que qualquer pessoa que crie um codespace deste repositório tenha a mesma configuração. Isto também significa que qualquer personalização que você faça, como adicionar extensões deVisual Studio Code, aparecerá para todos os usuários.

Para obter informações, consulte "Usando o controle de fonte no seu codespace".

Próximas etapas

Agora você deve estar pronto para começar a desenvolver seu projeto Python em Codespaces. Aqui estão alguns recursos adicionais para cenários mais avançados.

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.