Relacionamento/Fluxo entre Package e Group

[alvarofpp]

Definir um tipo de relacionamento/fluxo entre Package e Group

Criar um fluxo entre as classes Package e Group, que facilite o fluxo do desenvolvedor durante a etapa de exploração.

• Tipo: Nova implementação.
• Depende da issue: Package e File #81 e Group #82.
  • Status:
    • Package e File #81 Totalmente.
    • Group #82 Totalmente.
• Branch: no final, deverá ser feito um merge para a branch version-2.

Checklist:

• Implementar feature;
• Adicionar testes;
• Atualizar docstring;
• Atualizar documentação.

Para entender melhor

Tomemos como exemplo a requisição http://dados.ufrn.br/api/rest/dataset/discentes. Existem um atributo que podemos usar na requisição de package: groups (um array com os grupos a qual o pacote pertence). Por exemplo, poderia ser criado algum método que permitisse eu sair do pacote discentes e chegar ao grupo ensino, visto que o pacote discentes pertence a esse grupo.

Exemplo

# Package de discentes
package_discentes

# Lista dos grupos ao qual pertence
discentes_groups = package_discentes.groups  # ['ensino', 'pessoas']

# Quantidade de grupos que pertence
len(package_discentes.groups)  # 2

# Chegar ao grupo de ensino MODO 1
group_ensino = package_discentes.get_group(0)

# Chegar ao grupo de ensino MODO 2
group_ensino = package_discentes.get_group('ensino')
group_ensino = package_discentes.get_group(discentes_groups[0])

Observações: verificar se o pacote pertence ao grupo desejado.

[alvarofpp]

Pensando bem, como group_ensino = package_discentes.get_group(0) pode gerar confusão, pois alguns podem pensar que começa do 1 e não do 0, creio que seria melhor apenas passando uma string, como é o caso do segundo modo.