Gerenciamento de arquivos em diretórios locais a partir de funcionalidades encapsuladas
Project description
Biblioteca Python criada para facilitar o gerenciamento e a análise de arquivos armazenados em diretórios locais do sistema operacional. Com o pacote filescope
, é possível validar a presença de arquivos em diretórios específicos, realizar cópias entre arquivos de diferentes diretórios ou até mesmo gerar um report analítico e visual completo contendo informações relevantes a respeito dos arquivos presentes em um diretório específico, como tamanho, dias desde a criação, dias sem utilização, modificação ou acesso e um score específico (denominado filescope_score) que penaliza arquivos de alto tamanho e que estão há muito tempo sem acesso.
Table of content
Features
Em sua versão atual, o pacote filescope
conta com o módulo manager
, sendo este responsável por alocar as principais funcionalidades relacionadas ao gerenciamento e a análise de arquivos em diretórios. Entre o detalhamento aqui proposto, as ferramentas deste pacote serão divididas em dois principais grupos: manuseio de arquivos e gerenciamento de diretórios.
Manuseio de Arquivos
Uma das grandes vantagens do pacote filescope é a de proporcionar aos usuários blocos de código previamente gerenciados para algumas operações envolvendo arquivos, como a validação e a cópia. A função valida_arquivo_origem()
, por exemplo, é capaz de retornar uma resposta booleana relacionada a presença de um determinado arquivo em um determinado diretório. Já a função valida_dt_mod_arquivo()
, por sua vez, além de validar a presença de um arquivo em um diretório, também analisa se o dado arquivo está devidamente atualizado seguindo critérios fornecidos pelo usuário, permitindo assim, verificar se dado arquivo neste diretório alvo foi modificado pela última vez no mês atual. Ainda neste bloco, a função copia_arquivo()
, realiza a cópia de arquivos baseada em uma origem e um destino fornecidos pelo usuário.
Em examples/valida_e_copia_arquivo.py
, será possível encontrar um exemplo detalhado de utilização deste grupo de funcionalidades do pacote filescope.
Gerenciamento de Diretórios
Talvez a funcionalidade mais impactante deste pacote tenha raízes no gerenciamento de arquivos em um diretório específico. Considerando uma utilização corporativa como motivação, a função controle_de_diretorio()
recebe simplesmente um parâmetro de diretório alvo como argumento para realizar uma varredura completa em todos os arquivos presentes neste caminho, extraindo informações extremamente relevantes a serem analisadas posteriormente pelos usuários como insumo básico para tomada de decisões. O resultado da execução desta função é um report gerencial representando uma linha por arquivo e contendo as seguintes informações:
- diretorio: informação do diretório (incluindo subpastas) do referido arquivo;
- arquivo: nome do arquivo analisado pela função;
- tamanho_kb: tamanho total do arquivo em KB;
- usuario_owner: usuário owner vinculado ao arquivo;
- dt_criacao: data de criação do referido arquivo;
- dias_desde_criacao: quantidade de dias contados a partir da criação do arquivo até a data de execução do report;
- dt_ult_mod: data de última modificação do referido arquivo;
- dias_desde_ult_mod: quantidade de dias contados a partir da última modificação do arquivo até a data de execução do report;
- dt_ult_acesso: data de último acesso do referido arquivo;
- dias_desde_ult_acesso: quantidade de dias contados a partir do último acesso do arquivo até a data de execução do report;
- filescope_score: score
filescope
calculado a partir de fórmula que penaliza arquivos pesados e sem acesso (a ser detalhada); - dt_relatorio: data de execução e extração do relatório.
Como visto na lista acima, além de retornar informações extremamente relevantes para o controle de um diretório, a função é capaz de realizar um cálculo próprio consolidado na variável filescope_score
, sendo esta definida por:
Onde:
- tkb = tamanho_kb
- ddc = dias_desde_criacao
- dda = dias_desde_ult_acesso
- ddm = dias_desde_ult_mod
Instalação
A última versão do pacote filescope
encontra-se publicada no repositório PyPI.
:pushpin: Nota: como boa prática de utilização em qualquer projeto Python, a construção de um ambiente virtual se faz necessária para um maior controle das funcionalidades e das dependências atreladas ao código. Para tal, o bloco abaixo considera os códigos necessários a serem executados no cmd para a criação de ambientes virtuais Python nos sistemas Linux e Windows.
# Criação e ativação de venv no linux
$ python -m venv <path_venv>/<nome_venv>
$ source <path_venv>/<nome_venv>/bin/activate
# Criação e ativação de venv no windows
$ python -m venv <path_venv>/<nome_venv>
$ <path_venv>/<nome_venv>/Scripts/activate
Com o ambiente virtual ativo, basta realizar a atualização do pip
(opcional) seguida da instalação do pacote:
$ pip install --upgrade pip
$ pip install filescope
A construção do pacote filescope
é feita utilizando, como pilar, bibliotecas de modelagem fundamental em Python. Dessa forma, ao realizar a instação no ambiente virtual, é esperado que outras bibliteocas dependentes também sejam instaladas. O output esperado no prompt de comando após a instalação deve ser semelhante ao ilustrado abaixo:
Collecting filescope
Downloading filescope-0.0.3-py3-none-any.whl (2.6 kB)
Collecting pandas==1.1.5
Downloading pandas-1.1.5-cp38-cp38-manylinux1_x86_64.whl (9.3 MB)
|████████████████████████████████| 9.3 MB 8.1 MB/s
Collecting filescope
Downloading filescope-0.0.2-py3-none-any.whl (2.5 kB)
Collecting numpy>=1.15.4
Downloading numpy-1.20.2-cp38-cp38-manylinux2010_x86_64.whl (15.4 MB)
|████████████████████████████████| 15.4 MB 9.6 MB/s
Collecting pytz>=2017.2
Downloading pytz-2021.1-py2.py3-none-any.whl (510 kB)
|████████████████████████████████| 510 kB 10.3 MB/s
Collecting python-dateutil>=2.7.3
Downloading python_dateutil-2.8.1-py2.py3-none-any.whl (227 kB)
|████████████████████████████████| 227 kB 10.4 MB/s
Collecting six>=1.5
Downloading six-1.15.0-py2.py3-none-any.whl (10 kB)
Installing collected packages: six, pytz, python-dateutil, numpy, pandas, filescope
Successfully installed filescope-0.0.2 numpy-1.20.2 pandas-1.1.5 python-dateutil-2.8.1 pytz-2021.1 six-1.15.0
Utilização
A partir desse ponto, a biblioteca filescope
pode ser importada em scripts Phyton. Exemplos práticos podem ser encontrados neste repositório no diretório examples/
. Ilustrando uma aplicação relacionada a criação de um report gerencial e visual de um diretório, o código abaixo ilustra a utilização de algumas funções do pacote que encapsulam tais ações:
# Importando bibliotecas
from filescope.manager imoport controle_de_diretorio, generate_visual_report
# Extraindo report analítico de arquivos
df_root = controle_de_diretorio(root=SRC_PATH, output_filepath=ROOT_FILE)
# Gerando e salvando report visual
generate_visual_report(df=df_root, output_path=OUTPUT_PATH)
Ao executar o código acima com as devidas configurações de caminhos especificadas pelas variáveis de caminhos passadas como argumentos, espera-se obter um resultado em uma pasta de saída contendo um arquivo csv analítico com informações dos arquivos em um diretório, além de imagens com explorações e insights visuais sobre o consumo deste diretório.
examples/output
├── root_control.csv
├── visao_geral_arquivos.png
├── visao_geral_diretorio.png
└── visao_geral_usuarios.png
A função generate_visual_report()
é extremamente valiosa para a coleta de insights visuais sobre o conteúdo do diretório analisado. Como exemplo, a imagem abaixo ilustra o conteúdo presente, por padrão, em visao_geral_diretorio.png
:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file filescope-0.0.9.tar.gz
.
File metadata
- Download URL: filescope-0.0.9.tar.gz
- Upload date:
- Size: 17.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 372805e04da9d4d87cc55765f53f3274cb231bdbe025c5e2d3b0b41233b23bbb |
|
MD5 | c726ef233727d6c950b918edafc1e58d |
|
BLAKE2b-256 | 0a72edb732b18ab36a3685f4b9e268d97c1a1f41b0a5324f9b949baf0b5db968 |
File details
Details for the file filescope-0.0.9-py3-none-any.whl
.
File metadata
- Download URL: filescope-0.0.9-py3-none-any.whl
- Upload date:
- Size: 14.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa29d1bf10020e0629665a66abbec6dd9bb2b62ae93e6ba0a80ba896687c5e9d |
|
MD5 | e56e2349d9bafe7cdebb5806e38152c6 |
|
BLAKE2b-256 | 6852d4e8cd78833a58f6c52a5f907dbc9388df09f458ab68b5127cfa3d13659e |