octopus oc corelibs sql helpers

Aulas de Ajuda PL/SQL

Ferramentas para processamento automático e formatação do código PL/SQL

Limitações

• Arquivos com vários objetos não são suportados. Isso significa: um arquivo - um objeto com instrução create . O resultado do processamento de arquivos com vários objetos é imprevisível; portanto, todas as ferramentas (exceto STR_Decoder ) aumentarão uma exceção.
• Os nomes dos objetos devem ser dados usando apenas caracteres ASCII .
• Usar para definições de objetos não suportadas também aumentará uma exceção. Os tipos de objetos suportados são:
  • PROCEDIMENTO
  • FUNÇÃO
  • PACOTE
  • Corpo da embalagem

Detalhes

str_decoder

A única função decode_to_str tenta detectar a codificação de linha e recodificá-la para UTF-8 . Aumenta o ValueError se a codificação for impossível.

Sinopse

decode_to_str(line, probables=None)

• Objeto line - bytes com um texto para decodificar
• probables ​​- list de str com codificações primárias para verificar. Padrão: ['cp866', 'cp1251', 'koi8-r']
• Valor de retorno - str (decodificado e recodificado para UTF-8 )

Uso da linha de comando

Decodificar o arquivo inteiro para outro arquivo. Execute isso para obter a lista de argumentos:

python -m oc_sql_helpers.str_decoder --help

invólucro

A classe PLSQLWrapper é uma ferramenta para trabalhar com fontes embrulhadas no Oracle.

Requisitos

Existem requisitos adicionais para envolver arquivos. Observe que os métodos do Unwrap estão funcionando sem ele. Isso se deve ao uso do utilitário wrap original da Oracle , que não está incluído neste pacote devido à violação da licença . Você tem que instalá -lo separadamente.

• Variável de ambiente ORACLE_HOME deve ser definida corretamente
• wrap Binário deve ser colocado sob ${ORACLE_HOME}/bin e deve ter permissão para executar o usuário eficaz

Sinopse

PLSQLWrapper() - Para instanciar um objeto para essa classe

Métodos

• wrap_path(path_in, write_to=None)
  • path_in - objeto str com caminho absoluto ou relativo para o arquivo para embrulhar.
  • write_to - um de:
    • None - o resultado de embalagem será devolvido por este método como objeto bytes
    • file - O resultado será gravado no objeto semelhante a um arquivo especificado aqui. Deve ser aberto no modo binário de leitura-gravação ( 'w+b' ) e operação seek suporte.
    • str - caminho para o arquivo de saída, absoluto ou relativo. O resultado será escrito lá. Deve ter uma extensão - este é o Oracle wrap Utility Feactue. Ele anexa o sufixo .plb por si só se uma extensão omitida. Especifique a extensão sempre
  • Valor de retorno : consulte write_to acima
• wrap_buf(fl_in, write_to=None)
  • fl_in - file ou objeto file-like para envolver dados. Deve ser aberto no modo binário e na operação seek suporte ( 'rb' ).
  • write_to - o mesmo que para wrap_path
  • Valor de retorno : o mesmo que para wrap_path
• unwrap_path(path_in, write_to=None)
  • path_in - objeto str com caminho absoluto ou relativo para o arquivo para desembrulhar.
  • write_to - um de:
    • None - o resultado do desembrulhamento será retornado por este método como objeto bytes
    • file - O resultado será gravado no objeto semelhante a um arquivo especificado aqui. Deve ser aberto no modo binário de leitura-gravação ( 'w+b' ) e operação seek suporte.
    • str - caminho para o arquivo de saída, absoluto ou relativo. O resultado será escrito lá.
  • Valor de retorno : consulte write_to acima
• unwrap_buf(fl_in, write_to=None)
  • fl_in - file ou objeto file-like para envolver dados. Deve ser aberto no modo binário e na operação seek suporte ( 'rb' ).
  • write_to - o mesmo que para unwrap_path
  • Valor de retorno : o mesmo que para unwrap_path

Uso da linha de comando

Embrulhar/desembrulhar o arquivo inteiro para outro arquivo. Execute isso para obter a lista de argumentos:

python -m oc_sql_helpers.wrapper --help

normalizador

A classe PLSQLNormalizer é ou normalização do código PL/SQL.

O termo de normalização

A normalização significa quase o mesmo que o estilo de código , mas menos estritamente. Isso significa que o resultado da normalização pode ser inutilizável, mesmo que a fonte esteja correta do ponto de vista PL/SQL .

A normalização padrão é:

• Todas as terminações de linha são substituídas para o estilo Unix
• Todo o lixo antes da primeira declaração CREATE não declarada é removida.
• CREATE a própria declaração é ordenada para a primeira linha até o token AS (ou IS , ou WRAPPED ), incluindo nome do objeto, tipo e esquema. Personagens e comentários do espaço extras são substituídos por espaço único.
• A primeira linha (com a declaração CREATE ordenada) é baseada em upprc , incluindo esquema e nome do objeto .
• Se esquema ou nome do objeto for fornecido em duas citações " , essas ditas serão removidas sempre que possível. Exemplo: "schema"."name" será SCHEMA.NAME após a normalização, enquanto "another.schema"."another.name" "ANOTHER.SCHEMA"."ANOTHER.NAME"
• parte parte do corpo da definição de objeto não será alterada

Outro sinalizador de normalização :

• uppercase : Todos os lexemes de linguagem no corpo do objeto serão montados, exceto literais
• no-comments : todos os comentários dentro do corpo, incluindo os próprios sinais de comentários, serão substituídos por um espaço único.
• no-spaces : todos os personagens de espaço repetidos (o próprio espaço, nova linha, tabulação ...) serão substituídos por espaço único geral. Exemplo: var := 'the value' será traduzido para var := 'the value' . Observe que nenhuma substituição é feita dentro de um 'the value' literal. Esta bandeira não pode ser usada com no-comments
• no-literals : Todos os valores literais de string serão substituídos para os vazios. Os próprios sinais literais não são alterados.
• comments-only : descarte todo o conteúdo do arquivo, mas comentários, incluindo os comentários. Cada comentário será iniciado com uma nova linha. Esta bandeira não é compatível com ninguém acima

Sinopse

PLSQLNormalizer() - para instanciar um objeto para esta classe

Métodos

• normalize_path(path, flags=None, lines=None, write_to=None)
  • path - str Object com caminho absoluto ou relativo para o arquivo para normalizar.
  • flags - sinalizadores de normalização, list de números inteiros da enumeração PLSQLNormalizationFlags , veja abaixo. None valor significa apenas a normalização do padrão ( CREATE definição).
  • lines - int , Limite as linhas de normalização (contadas da fonte ). Padrão : None , significa normalizar a fonte inteira
  • write_to - um de:
    • None - o resultado de embalagem será devolvido por este método como objeto bytes
    • file - O resultado será gravado no objeto semelhante a um arquivo especificado aqui. Deve ser aberto no modo binário de leitura-gravação ( 'w+b' ) e operação seek suporte.
    • str - caminho para o arquivo de saída, absoluto ou relativo. O resultado será escrito lá. Deve ter uma extensão - este é o Oracle wrap Utility Feactue. Ele anexa o sufixo .plb por si só se uma extensão omitida. Especifique a extensão sempre
  • Valor de retorno : consulte write_to acima
• normalize(fl, flags, lines=None write_to=None)
  • fl - um de:
    • Objeto file ou file-like para normalizar os dados de. Deve ser aberto no modo binário e na operação seek suporte ( 'rb' ).
    • str - Dados da string para normalizar
    • bytes - dados "binários" para normalizar
  • flags - o mesmo que para normalize_path
  • lines - o mesmo que para normalize_path
  • write_to - o mesmo que para normalize_path
  • Valor de retorno : o mesmo que normalize_path
• is_sql(fl) - Verifique se os dados fornecidos são suportados Código PL/SQL
  • fl - o mesmo que para normalize
  • Valor de Retun - bool , código PL/SQL embrulhado ou não
• is_sql_path(path) - O mesmo que is_sql , mas o argumento é tratado como um caminho para um arquivo com possível código
• is_wrapped(fl) - Verifique se os dados fornecidos são suportados Código PL/SQL embrulhado
  • fl - o mesmo que para normalize
  • Valor de Retun - bool , código PL/SQL suportado ou não
• is_wrapped_path(path) - O mesmo que is_wrapped , mas o argumento é tratado como um caminho para um arquivo com possível código
• is_wrappable(fl) - Verifique se os dados fornecidos são suportados Código PL/SQL embrulhado
  • fl - o mesmo que para normalize
  • Valor Retun - bool , objeto PL/SQL envolvente no código ou não
• is_wrappable_path(path) - O mesmo que is_wrappable , mas o argumento é tratado como um caminho para um arquivo com possível código

PLSQLNormalizationFlags - Enumeração de bandeiras:

• uppercase
• no_comments
• no_spaces
• no_literals
• comments_only

Veja a descrição detalhada acima em outro capítulo dos sinalizadores de normalização da seção de termos de normalização .

Uso da linha de comando

Normalizando o arquivo inteiro para outro arquivo. Execute isso para obter a lista de argumentos:

python -m oc_sql_helpers.normalizer --help