Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PR com único propósito de realizar a revisão do código atual da main #9

Open
wants to merge 120 commits into
base: review
Choose a base branch
from

Conversation

ogecece
Copy link
Member

@ogecece ogecece commented Apr 12, 2023

No description provided.

ogecece and others added 30 commits February 18, 2022 00:46
…o script inicial para extração dos arquivos .zip e carga dos .csv para o banco de dados.
…d". Needs performance improvement as only single thread works.
…do as mensagens de log com detalhe de contagem total de registros
… antes de iniciar de fato a carga. Reconfigurando tamanho das fatias de escrita.
…opy_from para testar melhoria de velocidade de escrita
…lacionamento dos dados do Cadastro Nacional de Pessoa Jurídica da Receita Federal
…as informações de estabelecimento e socios, com adição de fluxos de exceção com mensagens de erro.
…ão black e logging para o arquivo de download. Correção do processamento das informações de motivo situação cadastral.
…tratégia para evitar recarga de dados de empresa e sócios
…s para empresa e estabelecimentos das informações de sócios. Adicionando objetos ORM SQLAlchemy para permitir o acesso ao banco postgres e aos dados via objetos instanciados em memória, para facilitar o acesso às informações das tabelas auxiliares de informação, com dados do tipo codigo/descricao
…s para empresa e estabelecimentos das informações de sócios. Adicionando objetos ORM SQLAlchemy para permitir o acesso ao banco postgres e aos dados via objetos instanciados em memória, para facilitar o acesso às informações das tabelas auxiliares de informação, com dados do tipo codigo/descricao
Todo trecho já revisado e aprovado para junção com o tronco principal do código.
Signed-off-by: Pedro Guimarães <[email protected]>
Atualizando o arquivo de entidade relação das tabelas.

Signed-off-by: Pedro Guimarães <[email protected]>
Pequenas correções de formatação do texto

Signed-off-by: Pedro Guimarães <[email protected]>
Correção dos links de endpoints da api.

Signed-off-by: Pedro Guimarães <[email protected]>
Correções de formatação do texto.

Signed-off-by: Pedro Guimarães <[email protected]>
Revisão upmerge com o main trazendo correções de bugs, implementação de backup e adição de documentação
Pequenas adições e correções à documentação README.

Signed-off-by: Pedro Guimarães <[email protected]>
Adicionando informações de criação do banco postgres.

Signed-off-by: Pedro Guimarães <[email protected]>
Correções e adições.

Signed-off-by: Pedro Guimarães <[email protected]>
Copy link
Member Author

@ogecece ogecece left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tigreped tá bem legal!

Sobre o código dos .py penso que numa refatoração posterior poderíamos compartimentalizar mais blocos de código em funções e reduzir o número de comentários. As mensagens de logs também atrapalham a leitura dos fluxos principais então seria muito beneficial estarem compartimentalizadas e o fluxo principal ficasse num nível de abstração acima.

Mas no momento não acho que devamos priorizar isso. Deixo apenas esses comentários aqui para sua avaliação:


Este repositório busca facilitar o acesso às informações publicadas pela Receita Federal do Brasil sobre o Cadastro Nacional de Pessoa Jurídica, na medida em que fornece uma solução para a criação de uma base de dados relacional local unificada para consultas.

Dessa forma, é possível realizar análises mais profundas com os dados que estão acessíveis através [DESTE SERVIÇO](http://200.152.38.155/CNPJ/). Caso o serviço deixe de estar online ou mude de endereço, o código deverá refletir as alterações. O serviço contém uma listagem com arquivos comprimidos tipo .ZIP que contém, cada um, um arquivo tabular do tipo .CSV (comma-separated-values), representando os dados modelados disponíveis para as seguintes entidades:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bora criar uma issue pra disponibilizar o formato raw de forma mais organizada? Imagino que seja legal poder escolher a versão dos dados e deixar o checksum fácil, por exemplo.


Assim, uma empresa pode possuir múltiplos estabelecimentos, todos compartilhando o mesmo cnpj base, entretanto cada estabelecimento com um código de ordem individual e um dígito verificador correspondente.
O estabelecimento possui informações complementares às informações de empresa, definidos pelas outras entidades a que chamaremos de **dimensões complementares**. Segue abaixo a sugestão adotada para a modelagem das tabelas no projeto:
![Modelo de tabelas do banco](https://github.com/okfn-brasil/receita/raw/revisao/docs/static/img/Entity%20Relationship%20Diagram.png)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ficou apontando pra branch revisao. Vale deixar genérico

Suggested change
![Modelo de tabelas do banco](https://github.com/okfn-brasil/receita/raw/revisao/docs/static/img/Entity%20Relationship%20Diagram.png)
![Modelo de tabelas do banco](/docs/static/img/Entity%20Relationship%20Diagram.png)

include_trailing_comma = true
use_parentheses = true
line_length = 88
known_third_party = ["aiohttp", "parsel"]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
known_third_party = ["aiohttp", "parsel"]
known_third_party = ["requests", "parsel"]

Comment on lines 1 to 10
import re
import subprocess
import os
import shutil
import requests
import time
import datetime
from parsel import Selector
import hashlib
import logging
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ficou faltando executar os formatadores de código?

Comment on lines +14 to +18
file_name = None
if url:
file_tokens = url.split("/")
file_name = file_tokens[-1]
return file_name
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Provavelmente não é o caso de mudar aqui, mas se tivermos querystrings ou qualquer outra coisa na url teríamos problemas com o file_name = file_tokens[-1].

Uma recomendação seria usar a urlparse para segmentar a url, utilizar o .path e então a partir do path fazer o .split() (os.path.basename() também poderia ser usado no lugar do .split() se estiver usando apenas o path e não a url inteira).

sql/startdb.sql Outdated
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Achei bem organizado!

Comment on lines +211 to +218
# Realiza uma regra de três para calcular a porcentagem de andamento da carga dos dados
def status_carga(parcial: int, total: int):
if total != 0:
x = (parcial * 100) / total
# Arrendondando os valores
x = round(x)
return str(x)
return None
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Acho que usar tqdm seria mais interessante para gerenciar os andamentos e aí não precisaríamos ter esse tipo de subrotina implementado aqui. O que acha?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Parece que os pass ficaram sobrando no fim dos métodos e da declaração de classe

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Parece que os pass ficaram sobrando no fim de algumas funções

f"Não foi possível carregar preventivamente os metadados do arquivo {file_name}. Baixar arquivo."
)
return get_remote_file(url, file_path, retry)
pass
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Parece ter sobrado aqui

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants