Feat: build xml elements #720

Rossi-Luciano · 2024-10-15T18:14:25Z

O que esse PR faz?

Este PR introduz três funções que geram estruturas XML usando a biblioteca xml.etree.ElementTree. Ele visa resolver a necessidade de criação dinâmica de elementos XML, tais como <article>, <contrib>, e <journal-meta>, com base em dados de entrada.

Onde a revisão poderia começar?

A revisão pode começar pelos arquivos que contêm as seguintes funções:

build_article_node() no arquivo article.py
build_contrib_author() no arquivo contrib.py
build_journal_meta() no arquivo journal_meta.py

Como este poderia ser testado manualmente?

Crie um script Python para importar as funções dos arquivos relevantes.
Forneça dados de entrada similares aos exemplos abaixo e execute as funções para gerar o XML.

Exemplo de dados para build_article_node:

article_data = {
    "dtd-version": "1.1",
    "specific-use": "research",
    "article-type": "original",
    "xml:lang": "en"
}

Exemplo de dados para build_contrib_author:

data = {
    "contrib_type": "author",
    "contrib_ids": {
        "orcid": "0000-0001-8528-2091",
        "scopus": "24771926600"
    },
    "surname": "Einstein",
    "given_names": "Albert",
    "affiliations": [
        {"rid": "aff1", "text": "1"}
    ]
}

Exemplo de dados para build_journal_meta:

data = {
    "journal_ids": {
        "nlm-ta": "Braz J Med Biol Res",
        "publisher-id": "bjmbr"
    },
    "journal_title": "Brazilian Journal of Medical and Biological Research",
    "abbrev_journal_title": "Braz. J. Med. Biol. Res.",
    "issn": {
        "epub": "1414-431X",
        "ppub": "0100-879X"
    },
    "publisher_name": "Associação Brasileira de Divulgação Científica"
}

Verifique a saída XML gerada pelas funções, certificando-se de que todos os elementos foram corretamente criados e formatados.

Algum cenário de contexto que queira dar?

NA

Screenshots

NA

Quais são tickets relevantes?

NA

Referências

NA

This reverts commit 1d0129c.

robertatakenaka · 2024-10-15T18:26:41Z

tests/sps/formats/sps_xml/test_journal_meta.py

+        journal_ids = journal_meta_elem.findall("journal-id")
+        self.assertEqual(len(journal_ids), 2)
+        self.assertEqual(journal_ids[0].get("journal-id-type"), "nlm-ta")
+        self.assertEqual(journal_ids[0].text, "Braz J Med Biol Res")
+        self.assertEqual(journal_ids[1].get("journal-id-type"), "publisher-id")
+        self.assertEqual(journal_ids[1].text, "bjmbr")
+
+        # Verifica o grupo de títulos <journal-title-group>
+        journal_title_group = journal_meta_elem.find("journal-title-group")
+        self.assertIsNotNone(journal_title_group)
+
+        # Verifica se <journal-title> foi criado corretamente


@Rossi-Luciano o ideal é que cada método de teste tenha 1 assert. O motivo disto é que se houver failure, o teste vai parar no primeiro failure.

@Rossi-Luciano adicione casos de usos mais diversos que seriam o que acontece na ausência de alguns valores ou chaves do dicionário, ou o que ocorre se o usuário fornece chaves diferentes das esperadas?

robertatakenaka

@Rossi-Luciano ficou muito bom. Mas veja as melhorias nos testes, principalmente a questão de tratar a ausência de chaves esperadas e inesperadas no dicionário.

robertatakenaka · 2024-10-17T16:36:26Z

packtools/sps/formats/sps_xml/contrib.py

-    name_elem.append(surname_elem)  # Adiciona <surname> ao <name>
+        if "surname" in data:  # Adiciona <surname> somente se estiver presente no dicionário
+            surname_elem = ET.Element("surname")
+            surname_elem.text = data.get("surname", "")  # Mesmo se for vazio, cria o elemento


@Rossi-Luciano

surname_elem.text = data.get("surname", "")

Este código não atribui "" para {"surname": None}

In [1]: d = {"a": None} In [2]: d.get("a", "") In [3]: print(d.get("a", "")) None

No lugar disso, use:

surname_elem.text = data["surname"] or ""

@Rossi-Luciano mas me parece, vendo os testes, que se você colocar apenas surname_elem.text = data["surname"] é o suficiente

robertatakenaka · 2024-10-17T16:38:26Z

packtools/sps/formats/sps_xml/contrib.py

+            if rid is not None:
+                xref_elem.set("rid", rid)
+            if text is not None:
+                xref_elem.text = text


@Rossi-Luciano combinamos que se o valor do atributo é None, o atributo aparece com valor de "". Neste trecho você está condicionando a inserção do atributo rid ao valor. Além disso, como rid é obrigarório, use o acesso direto à chave e não .get(key)
Por que não fez:

xref_elem = ET.Element("xref", attrib={"ref-type": "aff", "rid": rid or ""})

ou melhor ainda:

# rid é obrigatório, a ausência da chave deveria levantar exceção xref_elem = ET.Element("xref", attrib={"ref-type": "aff", "rid": xref_data["rid"]})

robertatakenaka · 2024-10-17T16:41:53Z

packtools/sps/formats/sps_xml/journal_meta.py

    journal_title_elem = ET.Element("journal-title")
-    journal_title_elem.text = data.get('journal_title', '')
-    journal_title_group.append(journal_title_elem)  # Adiciona <journal-title> ao <journal-title-group>
+    journal_title_elem.text = data.get('journal_title', '') or ''


@Rossi-Luciano use: journal_title_elem.text = data.get('journal_title') or ''
Isso resolve tanto a ausência de chave quanto de valor da chave. Faça uma busca por ', '') or '' e corrija

robertatakenaka · 2024-10-17T16:45:08Z

tests/sps/formats/sps_xml/test_journal_meta.py

+        """Método auxiliar para construção e comparação do XML gerado"""
+        journal_meta_elem = build_journal_meta(self.empty_data)
+        generated_xml_str = ET.tostring(journal_meta_elem, encoding="unicode", method="xml")
+        self.assertEqual(generated_xml_str.strip(), expected_xml_str.strip())


@Rossi-Luciano uma dúvida minha: se der falha, você conseguirá facilmente identificar onde, sendo que este método é chamado em todos os métodos de teste?

robertatakenaka · 2024-10-17T17:03:12Z

packtools/sps/formats/sps_xml/contrib.py

-    # Cria e adiciona o <name> com <surname> e <given-names>
-    name_elem = ET.Element("name")
+    # Cria e adiciona o <name> com <surname> e <given-names> somente se existirem no dicionário
+    if "surname" in data or "given_names" in data:


@Rossi-Luciano adicione prefix e suffix. Consulte a documentação para conferir se já exigência de ordem

@Rossi-Luciano considerar também o contrib com collab

robertatakenaka · 2024-10-21T11:48:20Z

packtools/sps/formats/sps_xml/journal_meta.py

-    journal_title_elem = ET.Element("journal-title")
-    journal_title_elem.text = data.get('journal_title', '') or ''
-    journal_title_group.append(journal_title_elem)
+        if 'journal_title' in data:


@Rossi-Luciano aqui vc já testou que a chave existe, então na linha 44, use data['journal_title']

robertatakenaka · 2024-10-21T11:56:05Z

packtools/sps/formats/sps_xml/contrib.py


    # Cria e adiciona o <name> com <surname> e <given-names> somente se existirem no dicionário
-    if "surname" in data or "given_names" in data:
+    if any(key in data for key in ("surname", "given_names", "prefix", "suffix")):


@Rossi-Luciano
Pode usar o seguinte:

if any(data.get(key) for key in ("surname", "given_names", "prefix", "suffix")):

Rossi-Luciano added 7 commits October 1, 2024 11:38

Adiciona 'full_tag'

1d0129c

Adiciona 'build_article_node'

ef20bc3

Adiciona 'build_contrib_author'

f0d779b

Adiciona 'build_journal_meta'

bfcc46d

Adiciona 'test_build_article_node'

af32e44

Adiciona testes para 'build_contrib_author'

ef2ee55

Adiciona testes para 'build_journal_meta'

3fd5da0

Rossi-Luciano requested a review from robertatakenaka October 15, 2024 18:14

Revert "Adiciona 'full_tag'"

746ea55

This reverts commit 1d0129c.

robertatakenaka reviewed Oct 15, 2024

View reviewed changes

Rossi-Luciano added 3 commits October 17, 2024 11:20

Adiciona tratamento de exceção

7e53e54

Refatora 'contrib'

89006dd

Refatora 'journal-meta'

1579e95

Rossi-Luciano requested a review from robertatakenaka October 17, 2024 14:23

robertatakenaka reviewed Oct 17, 2024

View reviewed changes

Rossi-Luciano added 2 commits October 20, 2024 22:54

Refatora 'JournalMeta'

4281b31

Refatora 'ContribAuthor'

f8eb111

robertatakenaka reviewed Oct 21, 2024

View reviewed changes

Rossi-Luciano added 4 commits October 21, 2024 12:08

Refatora 'build_contrib_author'

39c382e

Adapta os testes

2da6241

Refatora 'build_journal_meta'

4e8af30

Adapta testes

9cc8801

Rossi-Luciano requested a review from robertatakenaka October 21, 2024 15:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat: build xml elements #720

Feat: build xml elements #720

Rossi-Luciano commented Oct 15, 2024

robertatakenaka Oct 15, 2024

robertatakenaka Oct 15, 2024

robertatakenaka left a comment

robertatakenaka Oct 17, 2024

robertatakenaka Oct 17, 2024

robertatakenaka Oct 17, 2024 •

edited

Loading

robertatakenaka Oct 17, 2024

robertatakenaka Oct 17, 2024 •

edited

Loading

robertatakenaka Oct 17, 2024

robertatakenaka Oct 17, 2024

robertatakenaka Oct 17, 2024

robertatakenaka Oct 21, 2024

robertatakenaka Oct 21, 2024 •

edited

Loading

Feat: build xml elements #720

Are you sure you want to change the base?

Feat: build xml elements #720

Conversation

Rossi-Luciano commented Oct 15, 2024

O que esse PR faz?

Onde a revisão poderia começar?

Como este poderia ser testado manualmente?

Algum cenário de contexto que queira dar?

Screenshots

Quais são tickets relevantes?

Referências

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robertatakenaka left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robertatakenaka Oct 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robertatakenaka Oct 17, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

robertatakenaka Oct 21, 2024 • edited Loading

Choose a reason for hiding this comment

robertatakenaka Oct 17, 2024 •

edited

Loading

robertatakenaka Oct 17, 2024 •

edited

Loading

robertatakenaka Oct 21, 2024 •

edited

Loading