Este projeto é uma API escrita em Python para comunicação com o ReBase, um banco de dados de sessões de reabilitação física.
O pacote Python ReBase contém classes-modelo para Sessões e Movimentos. A classe api_response modela de forma generalizada as respostas enviadas pelo ReBaseRS. O módulo rebase_client é responsável pelo envio de requisições ao ReBaseRS. Estão inclusas também algumas exceções personalizadas e funções utilitárias. Todos os módulos se encontram na pasta src/python_rebase.
O ReBase, do inglês Rehabilitation Database, é um baco de dados dedicado ao armazenamento de movimentos corporais, com foco em reabilitação neurofuncional e neuromotora. Apesar do enfoque, o ReBase é capaz de armazenar qualquer tipo de movimento corporal gravado por qualquer técnica de captura de movimentos, desde que siga o padrão definido. Para isto serve a API Python ReBase!
Os Movimentos do ReBase representam os movimentos corporais capturados e são compostos por metadados, uma lista de Articulações e uma lista de Registros, que representam as rotações em X, y e z da Articulação a cada instante do Movimento. Os Movimentos podem pertencer a Sessões. Cada Sessão também contem metadados e pode conter múltiplos movimentos.
Todos os usuários que desejarem acessar o ReBase precisam ter um token de autenticação cadastrados no sistema. Para receber um token, o usuário deve entrar em contato com o time de desenvolvimento através dos emails mrtrotta2010@gmail.com ou diegocolombodias@gmail.com e enviar o endereço de email que deseja cadastrar.
O Python ReBase pode ser instalado pelo terminal através do PyPi com os comandos:
pip3 install python-rebase
ou
python3 -m pip install python-rebase
requests, utilizada para enviar requisições HTTP;Para utilizar a API, basta importar a biblioteca no começo do seu arquivo .py
from python_rebase.rebase_client import ReBaseClient
# Inicialize o cliente do ReBase com seu email e token previamente cadastrados
rebase_client = ReBaseClient('exemplo@gmail.com', 'tokenExemplo')
from python_rebase.movement import Movement
# Crie um objeto Movement
movement = Movement({
'label': 'MyMovement',
'fps': 30, # Varia conforme sua aplicação
'professionalId': 'Prof',
'articulations': ['1', '2']
})
# Adicione os Registros ao Movimento
# Cada registro representa um "frame" do movimento
# Os registros contêm as rotações de cada articulação em um dado momento
# Apesar de o Python ReBase incluir classes-modelo para os Registros e para Rotações, os métodos também aceitam dicionários e listas como parâmetros
movement.add_register(Register(
{
'1': Rotation(1.0, 1.0, 1.0), # Rotações da articulação "1"
'2': [2.0, 2.0, 2.0] # Rotações da articulação "2"
}
))
# Utilize o módulo rebase_client para inserir o movimento
response = rebase_client.insert_movement(movement)
print(f'Inserted: {response}')
from python_rebase.session import Session
# Crie um objeto Sessão.
# A Sessão pode ser criada vazia ou com Movimentos, sejam eles da classe Movement ou dicionários simples
session = Session({
'title': 'Teste de Sessão',
'professionalId': 'Prof',
'patientId': 'Pat',
'movements': [
# Da mesma forma, os Movimentos podem ser criados já com Registros
Movement({
'label': 'MyMovement',
'fps': 30,
'articulations': ['1', '2'],
'registers': [
Register({
'1': Rotation(1.0, 1.0, 1.0),
'2': Rotation(2.0, 2.0, 2.0)
})
]
}),
{
'label': 'MyMovement',
'fps': 30,
'articulations': ['1', '2'],
'registers': [
{
'1': [1.0, 1.0, 1.0],
'2': [2.0, 2.0, 2.0]
}
]
}
]
})
response = rebase_client.insert_session(session)
# É possível encontrar um único Movimento ou listar vários
response = rebase_client.find_movement(id)
print(f'Movimento: {response.movement}')
# A listagem permite filtros e suporta paginação
# Os filtros possíveis são: professional_id (id do profissional de saúde), patient_id (id do paciente),
# movement_label (identificação do movimento), articulations (articulações incluídas no movimento)
response = rebase_client.fetch_movements(professional_id='professional', patient_id='patient', page=1, per=10)
print(f'Movimentos: {response.movements}')
# Da mesma forma, as Sessões podem ser buscadas individualmente ou listadas
response = rebase_client.find_session(id)
print(f'Sessão: {response.session}')
# Os filtros suportados pela listagem de Sessão são: professional_id e patient_id.
# Também são aceitos os filtros movement_label e articulations, mas estes filtram os movimentos das Sessões
response = rebase_client.fetch_sessions(professional_id='professional', patient_id='patient', page=1, per=10)
print(f'Sessões: {response.sessions}')
# São disponibilizados métodos para deletar e excluir Movimentos e Sessões
response = rebase_client.update_movement(updatedMovement)
response = rebase_client.delete_movement(id)
response = rebase_client.update_session(updatedSession)
response = rebase_client.delete_session(id)
A seguir, serão abordados dois assuntos relevantes para as requisições de listagem: filtragem e paginação.
As requisições de listagem do ReBase, de Movimentos ou de Sessões, suportam alguns filtros, listados e explicados a seguir.
Listagem de Movimentos:
string que representa o ID do profissional de saúde responsável pelo Movimento;string que representa o ID do paciente que executou o Movimento;string que representa a propriedade label do Movimento;strings que representam as articulações trabalhadas no Movimento.Listagem de Sessões:
string que representa o ID do profissional de saúde responsável pela Sessão;string que representa o ID do paciente que avaliado durante a Sessão.A listagem de Sessões pode recebe ainda dois filtros adicionais. Estes, no entanto, não filtrarão a lista de Sessões em si, mas sim as listas de Movimentos das Sessões. São eles:
string que representa a propriedade label do Movimento;strings que representam as articulações trabalhadas no Movimento.Estes filtros podem ser úteis em alguns casos específicos. Um exemplo de uso: listar as Sessões de um paciente específico, mas incluir apenas os Movimentos que trabalharam um grupo específico de articulações.
Vale notar, por fim, que todos os filtros são aditivos, ou seja, ao utilizar n múltiplos filtros, serão retornados os documentos que satisfaçam todos os filtros, ou seja, os documentos que satisfaçam o filtro 1 E o filtro 2 E ... E o filtro n.
As requisições de listagem, tanto de Movimentos quanto de Sessões, também suportam paginação. Utilizando paginação, elimina-se a necessidade de carregar todos os items de uma listagem de uma só vez, o que pode significar um ganho de velocidade e desempenho para uma aplicação. O ReBaseRS suporta dois tipos de paginação: baseada em per e page e baseada em IDs.
O primeiro tipo utiliza dois parâmetros: per, que representa a quantidade de itens presentes em cada página, e page, que representa qual página deve ser carregada. Desta forma, supondo que quiséssemos carregar 10 elementos por página, para carregar a primeira página usaríamos { per: 10, page: 1 } e receberíamos os primeiros 10 itens da lista. Para carregar a segunda página usaríamos { per: 10, page: 2 } e receberíamos os 10 itens seguintes e assim por diante. Este método é simples de se utilizar e de se entender e permite o carregamento de qualquer página, porém possui uma desvantagem: para recuperar uma página n, é necessário recuperar todas as páginas anteriores, o que faz com que as requisições fiquem mais lentas conforme o número n da página cresce. Para mitigar este problema, é possível utilizar a paginação baseada em IDs.
A paginação baseada em IDs também depende de dois parâmetros: per, a quantidade de itens por página, e previous_id, o ID do último item da página anterior. Pela forma como o banco de dados do ReBase é modelado, as listas de Movimentos e de Sessões são ordenadas pelos IDs dos documentos, que são sequenciais. Ou seja, se quisermos recuperar os 10 itens seguintes a um item i, basta recuperar os primeiros 10 itens cujo ID seja maior do que o ID de i. Explorando essa característica, é possível implementar um método de paginação que permite que todas as páginas sejam recuperadas em tempos equivalentes. Desta forma, para recuperar a primeira página usaríamos { per: 10, previous_id: null }, já que não existe uma página anterior. Supondo que o ID do último item da primeira página seja "ABC", para recuperar a segunda página usaríamos { per: 10, previous_id: "ABC" }. Apesar de tudo, este método de paginação também tem uma desvantagem: para recuperar uma página específica, é necessário ter recuperado todas as páginas anteriores a ela, já que é preciso saber os IDs dos documentos que estão contidos nelas.
Assim, cabe ao desenvolvedor analisar sua aplicação e decidir qual método de paginação deverá ser utilizado (ou se a paginação é mesmo necessária). Aplicações que devem permitir a qualquer momento o acesso a qualquer página, deverão usar a paginação baseada em per e page. Por outro lado, para uma aplicação que precisa exibir uma lista com scroll infinito, por exemplo, na qual os itens são carregados sequencialmente, se beneficiará mais do método baseado em IDs. Para mais informações, este artigo pode ser útil.
Esta biblioteca inclui a pasta examples, que inclui alguns códigos-exemplo básicos de utilização da API.
A seguir, estão incluídas tabelas e descrições detalhando todas as classes e módulos da API Python ReBase.
Esta classe é responsável por toda a comunicação com o ReBaseRS. Seus métodos retornam objetos da classe APIResponse. Exemplos de uso podem ser encontrados na seção Quick Start:. O ReBaseClient deve ser inicializado com o email e o token do usuários previamente cadastrados.
Atributos:
| Atributo | Tipo |
|---|---|
| user_email | str |
| Email do usuário | |
| user_token | str |
| Token de autenticação do usuário |
Métodos:
| Método | Retorno | Parâmetros |
|---|---|---|
| __init__ | None | user_email: str, user_token: str, try_authenticate: bool = False |
Método de inicialização da classe. Recebe o endereço de email e o token de acesso do usuário. É possível tentar autenticar o usuário no momento da inicialização, passando o argumento try_authenticate=True, porém, caso a autenticação falhe neste ponto, será lançado um erro UnauthorizedUserError | ||
| authenticate | APIResponse | |
| Envia uma requisição de autenticação que não executa nenhum operação sobre o banco de dados. O envio desta requisição não é obrigatório, visto que todas as outras requisições também realizam autenticação | ||
| fetch_movements | APIResponse | professional_id: str = "", patient_id: str = "", movementLabel: str = "", articulations: list = None, legacy: bool = False, page: int = 0, per: int = 0, previous_id: str = "" |
| Recupera uma lista de Movimentos armazenados no ReBaseRS. Suporta diversos filtros e paginação | ||
| find_movement | APIResponse | id: str, legacy: bool = False |
Recupera um Movimento específico a partir do ID. O parâmetro legacy, se True, retorna o Movimento no formato antigo do ReBase | ||
| insert_movement | APIResponse | movement: Movement |
| Insere um Movimento no ReBase | ||
| update_movement | APIResponse | movement: Movement |
| Atualiza um Movimento já existente no ReBase | ||
| delete_movement | APIResponse | id: str |
| Exclui um Movimento do ReBase | ||
| fetch_sessions | APIResponse | professional_id: str = "", patient_id: str = "", movement_label: str = "", articulations: list = None, legacy: bool = False, deep: bool = False, page: int = 0, per: int = 0, previous_id: str = "" |
Recupera uma lista de Sessões armazenadas no ReBaseRS. Suporta diversos filtros e paginação. O parâmetro legacy, se True, retorna as Sessões no formato antigo do ReBase. Caso o parâmetro deep seja True, retorna também os Movimentos das Sessões, caso contrário, retorna apenas os IDs dos Movimentos | ||
| find_session | APIResponse | id: str, legacy: bool = False, deep: bool = False |
Recupera uma Sessão específica a partir do ID. O parâmetro legacy, se True, retorna a Sessão no formato antigo do ReBase. Caso o parâmetro deep seja True, retorna também os Movimentos da Sessão, caso contrário, retorna apenas os IDs dos Movimentos | ||
| insert_session | APIResponse | session: Session |
| Insere uma Sessão no ReBase | ||
| update_session | APIResponse | session: Session |
| Atualiza uma Sessão já existente no ReBase | ||
| delete_session | APIResponse | id: str, deep: bool = False |
Exclui uma Sessão do ReBase. Caso o parâmetro deep seja True, deleta também seus Movimentos |
O módulo util contém diversos métodos utilitários.
Métodos:
| Método | Retorno | Parâmetros |
|---|---|---|
| is_valid_str | bool | value: any |
Retorna True se value for uma string válida (uma instância da classe str). Caso contrário, retorna False | ||
| is_valid_number | bool | value: any |
Retorna True se value for um número válido (uma instância da classe int ou da classe float). Caso contrário, retorna False | ||
| is_valid_id | bool | value: any |
Retorna True se value for considerado um id válido para o ReBase (uma string válida não vazia ou um inteiro maior que 0). Caso contrário, retorna False | ||
| is_valid_movement_field | bool | field: str, value: any |
Retorna True se field for um campo válido para um Movimento do ReBase e se value for um valor válido para esse campo. Retorna False caso contrário | ||
| is_valid_session_field | bool | field: str, value: any |
Retorna True se field for um campo válido para um Movimento do ReBase e se value for um valor válido para esse campo. Retorna False caso contrário | ||
| exclude_keys_from_dict | None | dictionary: dict, keys: list |
| Remove uma dada lista de chaves de um dado dicionário | ||
| validate_initialization_dict | None | validation_function: Callable[[str, any], bool], resource_name: str, field_rules: dict, dictionary: dict |
Valida um dicionário de inicialização dictionary com base nos campos definidos em field_rules utilizando a função de validação validation_function. Caso encontre algum campo inválido, lança um ValueError cuja mensagem contém o nome apropriado do recurso resource_name |
A classe APIResponse modela uma resposta generalizada do servidor ReBaseRS.
Atributos:
| Atributo | Tipo |
|---|---|
| response_type | ResponseType(Enum) |
| Tipo da requisição enviada. Valores possíveis: { 0: FetchMovements, 1: FindMovement, 3: InsertMovement, 4: UpdateMovement, 5: DeleteMovement, 6: FetchSessions, 7: FindSession, 8: InsertSession, 9: UpdateSession, 10: DeleteSession, 11: APIError } | |
| status | int |
| Status da resposta. 0 representa sucesso e qualquer outro valor representa um erro | |
| code | int |
| Código HTTP da resposta (E.g. 200, 201, 404, etc. ) | |
| success | bool |
| Diz se a requisição foi bem sucedida ou não. Em outras palavras, diz se status == 0 |
Métodos:
| Método | Retorno | Parâmetros |
|---|---|---|
| has_data | bool | key: str |
Retorna True se o atributo key estiver presente nos dados da resposta e False caso contrário | ||
| get_data | bool | key: str |
Retorna o valor do atributo key nos dados da resposta. Os possíveis atributos são: 'message', 'HTMLError', 'error', 'warning', 'movements', 'movement', 'sessions', 'session', 'deletedId', 'deletedCount' | ||
| has_meta_data | bool | key: str |
Retorna True se o atributo key estiver presente nos metadados da resposta e False caso contrário | ||
| get_meta_data | bool | key: str |
Retorna o valor do atributo key nos metadados da resposta. Os possíveis atributos são: 'current_page', 'next_page', 'total_count', 'total_page_count' |
Modela um Movimento do ReBase.
Atributos:
| Atributo | Tipo |
|---|---|
| id | str |
| ID do Movimento | |
| label | str |
| Label, ou etiqueta, de identificação do Movimento. Normalmente representa uma categoria ou grupo de Movimentos | |
| description | str |
| Descrição do Movimento | |
| device | str |
| Dispositivo responsável pela captura do Movimento (E.g. Kinect, MediaPipe, etc.) | |
| fps | float |
| Quantidade de quadros por segundo do Movimento | |
| duration | float |
| Duração do Movimento | |
| number_of_registers | int |
| Quantidade de Registros presentes no Movimento (os Registros serão descritos a seguir) | |
| articulations | list |
| Articulações utilizadas pelo Movimento. As Articulações são identificadas por strings arbitrárias definidas pelo usuário da API. Cabe a cada desenvolvedor definir e seguir seu padrão. Desta maneira, o ReBase pode armazenar movimentos com um conjunto variável de Articulações | |
| insertion_date | str |
| Data de inserção do Movimento | |
| update_date | str |
| Data da última atualização do Movimento | |
| session_id | str |
| ID da Sessão à qual o Movimento pertence | |
| professional_id | str |
| Identificação do profissional da saúde responsável pela captura do Movimento | |
| app_code | int |
| Código da aplicação que gerou o Movimento. Um inteiro positivo, maior que zero, arbitrário definido pelos desenvolvedores da aplicação | |
| app_data | str |
| Dados arbitrários utilizados pela aplicação que gerou o Movimento. Pode ser utilizado pelos usuários da API para armazenar dados no formato que quiserem, como um json ou uma string | |
| patient_id | str |
| Identificação anônima do paciente que realizou o Movimento | |
| registers | [Register] |
| Lista de Registros que representam o Movimento em si. Ao adicionar um registro a um Movimento, mesmo que ele seja um dicionário, será automaticamente convertido à classe Register |
Métodos:
| Método | Retorno | Parâmetros |
|---|---|---|
| add_register | None | register: Register |
| Adiciona um novo Registro ao Movimento | ||
| to_dict | dict | exclude: list |
| Converte o Movimento para um dicionário. Recebe uma lista de propriedades a serem ignoradas | ||
| to_json | str | update: bool = False |
Converte o Movimento para json. O parâmetro update modifica o json gerado: para requisições de criação use update como False e para requisições de atualização use update como True |
Modela um Registro do ReBase, essencialmente um quadro, ou um frame, de um Movimento. Um Registro contém as rotações nos eixos x, y e z de cada Articulação do Movimento em um determinado instante. A classe Register se comporta como um dicionário, ou seja, cada articulação deve ser acessada através do operador [] (ex: register['articulation1'] = Rotation(1.0, 2.0, 3.0))
Atributos:
| Atributo | Tipo |
|---|---|
| articulation_count | int |
| A quantidade de Articulações presentes no Registro | |
| articulations | readonly list |
| A lista das Articulações presentes no Registro | |
| is_empty | bool |
| Indica se o registro está vazio, ou seja, não contem nenhuma Articulação |
Métodos:
| Método | Retorno | Parâmetros |
|---|---|---|
| to_dict | dict | |
| Converte o Registro em um dicionário |
Representa um conjunto de rotações de uma Articulação.
Atributos:
| Atributo | Tipo |
|---|---|
| x | number |
| A rotação no eixo X | |
| y | number |
| A rotação no eixo Y | |
| z | number |
| A rotação no eixo Z |
Métodos:
| Método | Tipo | Parâmetros |
|---|---|---|
| to_list | list | |
| Converte a Rotação para uma lista | ||
| to_tuple | dict | |
| Converte a Rotação para uma tupla |
Modela uma Sessão do ReBase.
Atributos:
| Atributo | Tipo |
|---|---|
| id | str |
| ID da Sessão | |
| title | str |
| Título da Sessão | |
| description | str |
| Descrição da Sessão | |
| professional_id | str |
| Identificação do profissional de saúde responsável pela captura da Sessão | |
| patient_session_number | int |
| Número da Sessão do paciente (Ex.: 1 para a primeira Sessão, 2 para a segunda, etc.) | |
| insertion_date | str |
| Data de criação da Sessão | |
| update_date | str |
| Data de atualização da Sessão | |
| patient_id | str |
| Identificação anônima do paciente que realizou a Sessão | |
| patient_age | int |
| Idade do paciente | |
| patient_height | float |
| Altura do paciente | |
| patient_weight | float |
| Peso do paciente | |
| main_complaint | str |
| Queixa principal do paciente | |
| history_of_current_disease | str |
| Histórico da condição atual do paciente | |
| history_of_past_disease | str |
| Histórico de condições anteriores do paciente | |
| diagnosis | str |
| Diagnóstico dado ao paciente pelo profissional de saúde | |
| related_diseases | str |
| Condições relacionadas à do paciente | |
| medications | str |
| Medicações das quais o paciente faz uso | |
| physical_evaluation | str |
| Avaliação física do paciente realizada pelo profissional | |
| number_of_movements | int |
| Número de Movimentos pertencentes à Sessão | |
| duration | float |
| Duração total da Sessão. Equivale à soma das durações dos seus Movimentos | |
| movements | [Movement] |
| Lista dos Movimentos pertencentes à Sessão |
Métodos:
| Método | Tipo | Parâmetros |
|---|---|---|
| to_dict | dict | exclude: list, movement_exclude: list |
| Converte a Sessão para um dicionário. Recebe duas listas: uma lista de propriedades a serem ignoradas e uma outra lista de propriedades a serem ignoradas na conversão dos seus Movimentos | ||
| to_json | str | update: bool = False |
Converte a Sessão para json. O parâmetro update modifica o json gerado: para requisições de criação use update como False e para requisições de atualização use update como True |
A biblioteca Python ReBase define alguns erros personalizados para os modelos de dados e casos de uso do ReBase. São eles:
try_authenticate=True e a autenticação falha.FAQs
Python implementation of the ReBase API
We found that python-rebase demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.