Como criar e utilizar o arquivo .gitignore no Python
O arquivo .
Publicado em 8 de agosto de 2023
Glossário
Como criar e utilizar o arquivo .gitignore no Python
Introdução
O arquivo .gitignore é uma parte essencial de qualquer projeto Python versionado com o Git. Ele permite que você especifique quais arquivos e diretórios devem ser ignorados pelo Git durante o versionamento. Isso é especialmente útil para evitar o rastreamento acidental de arquivos sensíveis, como chaves de API, senhas e arquivos gerados automaticamente.
Criando o arquivo .gitignore
Para começar a criar e utilizar o arquivo .gitignore no Python, siga os seguintes passos:
Passo 1
Crie um arquivo chamado “.gitignore” no diretório raiz do seu projeto. Você pode fazer isso usando o terminal ou um editor de texto.
Passo 2
Abra o arquivo .gitignore com o seu editor de texto preferido e comece a especificar quais arquivos e diretórios você deseja ignorar. Cada item deve ser adicionado em uma nova linha. Você pode usar curingas (wildcards) para especificar padrões de nomes de arquivos ou diretórios.
# Arquivos a serem ignorados arquivo_secreto.txt pasta_temp/ *.log # Diretório que deve ser ignorado recursivamente images/
Nesse exemplo, o arquivo “arquivo_secreto.txt” e a pasta “pasta_temp” serão ignorados pelo Git, assim como todos os arquivos com a extensão “.log”. Além disso, o diretório “images” e todos os seus arquivos e subdiretórios também serão ignorados.
Lembre-se de que você pode personalizar o arquivo .gitignore de acordo com as necessidades do seu projeto. Adicione ou remova itens conforme necessário.
Passo 3
Salve o arquivo .gitignore e adicione-o ao Git. Você pode fazer isso executando o seguinte comando no terminal, na raiz do seu projeto: git add .gitignore.
Isso garantirá que o arquivo .gitignore seja rastreado pelo Git e incluído no seu repositório.
Passo 4
Agora que você criou e adicionou o arquivo .gitignore, o Git irá ignorar automaticamente os itens listados nele durante o versionamento do seu projeto. Isso significa que eles não serão incluídos em commits, nem serão rastreados por alterações.
É importante ressaltar que o arquivo .gitignore não é retroativo. Ou seja, se você já tiver arquivos e diretórios rastreados pelo Git e desejar ignorá-los, será necessário removê-los do histórico de commits. Para isso, consulte a documentação do Git sobre como reescrever o histórico.
Como usar o arquivo .gitignore no Python
Agora que você criou o arquivo .gitignore no seu projeto Python, é importante saber como utilizá-lo corretamente. Aqui estão algumas dicas para usar o arquivo .gitignore de forma eficaz:
Dica 1
Mantenha o arquivo .gitignore atualizado: À medida que o seu projeto evolui, é possível que novos arquivos e diretórios surjam. Verifique regularmente se o seu arquivo .gitignore está atualizado e inclua todas as exclusões necessárias.
Dica 2
Evite incluir arquivos sensíveis: O arquivo .gitignore é uma forma de evitar o rastreamento de arquivos sensíveis, como senhas, chaves de API e arquivos de configuração local. Certifique-se de adicionar esses arquivos ao seu arquivo .gitignore para garantir que eles não sejam compartilhados publicamente.
Dica 3
Utilize curingas para incluir/excluir padrões de nomes de arquivos: O uso de curingas (wildcards) no arquivo .gitignore pode ser útil quando você deseja incluir ou excluir determinados padrões de nomes de arquivos.
# Inclui todos os arquivos de texto *.txt # Inclui o diretório chamado venv e todos os seus arquivos e subdiretórios venv/ # Inclui um arquivo específico chamado secret.json secret.json
Dica 4
Teste seu arquivo .gitignore: Verifique se o arquivo .gitignore está funcionando corretamente realizando commits e observando quais arquivos estão sendo rastreados e quais estão sendo ignorados. Se você perceber que alguns arquivos estão sendo rastreados indevidamente, verifique as regras no arquivo .gitignore.
Melhores práticas para o uso do arquivo .gitignore no Python
Aqui estão algumas melhores práticas para utilizar o arquivo .gitignore no Python:
Prática 1
Seja específico: Ao adicionar regras no arquivo .gitignore, seja o mais específico possível.
Prática 2
Comente o seu arquivo .gitignore: Adicionar comentários no arquivo .gitignore pode ajudar você e outros colaboradores do projeto a entender as regras definidas.
Prática 3
Exclua arquivos já rastreados pelo Git: Se você já rastreou um arquivo que agora deseja ignorar, será necessário removê-lo do repositório Git antes de adicionar a regra no arquivo .gitignore.
Prática 4
Seja consistente: Certifique-se de que todos os colaboradores do projeto estejam utilizando o mesmo arquivo .gitignore.
Seguindo essas melhores práticas, você poderá aproveitar ao máximo o arquivo .gitignore no seu projeto Python. Isso garantirá um versionamento mais limpo e seguro, sem incluir arquivos desnecessários e sensíveis no seu repositório Git.
A Awari é a melhor plataforma para aprender sobre programação no Brasil.
Aqui você encontra cursos com aulas ao vivo, mentorias individuais com os melhores profissionais do mercado e suporte de carreira personalizado para dar seu próximo passo profissional e aprender habilidades como Data Science, Data Analytics, Machine Learning e mais.
Já pensou em aprender de maneira individualizada com profissionais que atuam em empresas como Nubank, Amazon e Google? Clique aqui para se inscrever na Awari e começar a construir agora mesmo o próximo capítulo da sua carreira em dados.
Aprenda uma nova língua na maior escola de idioma do mundo!
Conquiste a fluência no idioma que sempre sonhou com uma solução de ensino completa.
+ 400 mil alunos
Método validado
Aulas
Ao vivo e gravadas
+ 1000 horas
Duração dos cursos
Certificados
Reconhecido pelo mercado
Artigos Relacionados
Confira abaixo mais conteúdos sobre o tema
Curso Técnico Desenvolvedor de Sistemas: Aprenda a criar soluções tecnológicas
Um curso técnico desenvolvedor de sistemas é uma formação...
Curso Desenvolvedor Web em Curitiba: Aprenda a Programar e Construa sua Carreira
Curso Desenvolvedor Web Curitiba: Aprenda a programar, construa uma...
Curso Técnico de Desenvolvedor de Software: Aprenda as habilidades necessárias para se tornar um profissional de sucesso na área de desenvolvimento de software.
Resumo: Descubra os benefícios de fazer um curso técnico...
