René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Script Python para criar/atualizar arquivo TRANSLATORS","articleBody":"## Introdução\r\n\r\nSeria interessante termos um script que extraísse a relação de tradutores que contribuíram para a documentação do Python, para fins de registro centralizado de crédito. Armazenar em um arquivo chamado TRANSLATORS parece ser o mais adequado, já que isso já é mencionado pelo Documentation Contribution Agreement no README.\r\n\r\nPor que script Python? Primeiramente porque se trata de documentação do Python ;-) Mas o mais importante é que o Python é uma linguagem muito poderosa e multiplataforma, de forma que seria possível fazer um script de alto nível que funciona não apenas no Linux.\r\n\r\nIdealmente, tal script Python seria utilizado em um ambiente de CI (integração contínua) para automatizar a atualização do arquivo TRANSLATORS, talvez iniciando uma pull request no caso de se achar alguma diferença para o script atual. Porém, o foco desta sugestão é apenas o script.\r\n\r\n## Sugestão de funcionamento do script\r\n\r\nSugere-se um script, digamos \"get_translators.py\", que a simples execução sem argumentos de linha de comando resulte em criar/atualizar um arquivo chamado \"TRANSLATORS\". Alternativamente, enviar o resultado para a saída padrão porém aceitando que se informe o arquivo de saída como parâmetro de linha de comando.\r\n\r\nO script deve encontrar todos os arquivos PO no repositório. Isso poderia ser feito usando PathLib para encontrar os arquivos PO a partir da raiz do repositório, ou usando a biblioteca [GitPython](https://gitpython.readthedocs.io) para obter os arquivos rastreados no repositório git. A primeira opção parece ser mais simples e fácil de implementar.\r\n\r\n## Detalhes técnicos dos créditos nos arquivos PO\r\n\r\n- Transifex sempre insere os créditos de tradução no início dos arquivos PO, como um comentário (iniciando com \\#) antes do primeiro msgid que serve de cabeçalho. As linhas com a relação de tradutores aparece entre uma linha `# Translators:` e `#`, algo que facilita determinar o início e o fim da área de créditos de tradução.\u003cbr\u003e\u003cbr\u003ePor exemplo, o arquivo sphinx.po tem os seguintes créditos:\u003cbr\u003e\r\n```\r\n# Translators:\r\n# Marco Rougeth \u003cmarco@rougeth.com\u003e, 2021\r\n# Welington Carlos \u003cwcarlos3@gmail.com\u003e, 2021\r\n# Claudio Rogerio Carvalho Filho \u003cexcriptbrasil@gmail.com\u003e, 2021\r\n# And Past \u003candrepgs@gmail.com\u003e, 2021\r\n# Adorilson Bezerra \u003cadorilson@gmail.com\u003e, 2021\r\n# Rafael Fontenelle \u003crffontenelle@gmail.com\u003e, 2021\r\n#\r\n```\r\n- Nem sempre e-mail está presente no arquivo PO. Neste caso, aparece somente o nome e ano de contribuição. Por exemplo:\r\n```\r\n# Foo \u003cfoo@example.com\u003e, 2021\r\n# Bar, 2021\r\n```\r\n- Contas Transifex excluídas aparecem como hashes no nome e no e-mail (se estiver presente). Por exemplo:\r\n```\r\n01419cbcade949a3bc5433893a160e74, 2021\r\n2c4b5a73177ea5ea1d3324f10df471a7_b8aeba7 \u003c7df8a60bac356f3b148ac94f3c2796f6_834576\u003e, 2021\r\n```\r\n- Um(a) contribuidor(a) pode aparecer mais de uma vez com diferenças no nome ou no e-mail, sendo interessante filtrar essas ocorrências para evitar adição duplicada. Por sorte, devem ser raros os casos. Exemplo de duplicidade:\r\n```\r\nWillian C Lopes \u003cwillclbr@gmail.com\u003e\r\nWillian Lopes\r\n```\r\n- Excluir da saída do script o \"tradutor\" `i17obot \u003ci17obot@rougeth.com\u003e`, visto se tratar de uma conta de bot e não uma pessoa.\r\n- Um combinação de comandos Shell do Linux para obter a lista de contribuidores de todos os arquivos PO, executado da raiz do repositório, seria:\r\n```shell\r\nfor pofile in $(find -name '*.po')\r\ndo\r\n    sed -n '/# Translators:/,/^#$/p' $pofile | sed 's|^# ||;s|, [0-9][0-9][0-9][0-9]$||'\r\ndone | sort -u | sed '/# Translators:/d;/^#$/d;/i17obot \u003ci17obot@rougeth.com\u003e/d'\r\n```","author":{"url":"https://github.com/rffontenelle","@type":"Person","name":"rffontenelle"},"datePublished":"2021-12-15T11:30:30.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":1},"url":"https://github.com/51/python-docs-pt-br/issues/51"}