`sys` — Parâmetros e funções específicas do sistema¶

Este módulo fornece acesso a algumas variáveis usadas ou mantidas pelo interpretador e a funções que interagem fortemente com o interpretador. Sempre disponível.

sys.abiflags¶: Em sistemas POSIX onde Python foi construído com o script configure padrão, ele contém os sinalizadores ABI conforme especificado por PEP 3149.

Alterado na versão 3.8: Os sinalizadores padrões se tornaram uma string vazia (o sinalizador m para pymalloc foi removido).

Novo na versão 3.2.

sys.addaudithook(hook)¶

Anexa o hook chamável à lista de ganchos de auditoria ativos para o (sub)interpretador atual.

Quando um evento de auditoria é levantado através da função sys.audit(), cada gancho será chamado na ordem em que foi adicionado com o nome do evento e a tupla de argumentos. Ganchos nativos adicionados por PySys_AddAuditHook() são chamados primeiro, seguidos por ganchos adicionados no (sub)interpretador atual. Os ganchos podem registrar o evento, levantar uma exceção para cancelar a operação ou encerrar o processo completamente.

Chamar sys.addaudithook() levantará um evento de auditoria denominado sys.addaudithook sem argumentos. Se qualquer gancho existente levantar uma exceção derivada de RuntimeError, o novo gancho não será adicionado e a exceção será suprimida. Como resultado, os chamadores não podem presumir que seu gancho foi adicionado, a menos que controlem todos os ganchos existentes.

Veja tabela de eventos de auditoria para todos os eventos levantados pelo CPython, e PEP 578 para a discussão do projeto original.

Novo na versão 3.8.

Alterado na versão 3.8.1: Exceções derivadas de Exception, mas não de RuntimeError, não são mais suprimidas.

CPython implementation detail: Quando o rastreamento está ativado (consulte settrace()), os ganchos do Python são rastreados apenas se o chamável tiver um membro __cantrace__ definido como um valor verdadeiro. Caso contrário, as funções de rastreamento ignorarão o gancho.

sys.argv¶

A lista de argumentos de linha de comando passados para um script Python. argv[0] é o nome do script (depende do sistema operacional se este é um nome de caminho completo ou não). Se o comando foi executado usando a opção de linha de comando -c para o interpretador, argv[0] é definido como a string '-c'. Se nenhum nome de script foi passado para o interpretador Python, argv[0] é a string vazia.

Para percorrer a entrada padrão ou a lista de arquivos fornecida na linha de comando, consulte o módulo fileinput.

Nota

No Unix, os argumentos da linha de comando são passados por bytes do sistema operacional. O Python os decodifica com a codificação do sistema de arquivos e o tratador de erros “surrogateescape”. Quando você precisar de bytes originais, você pode obtê-los por [os.fsencode(arg) for arg in sys.argv].

sys.audit(event, *args)¶

Levanta um evento de auditoria e aciona quaisquer ganchos de auditoria ativos. event é uma string que identifica o evento e args pode conter argumentos opcionais com mais informações sobre o evento. O número e os tipos de argumentos para um determinado evento são considerados uma API pública e estável e não devem ser modificados entre as versões.

Por exemplo, um evento de auditoria é denominado os.chdir. Este evento tem um argumento chamado path que conterá o novo diretório de trabalho solicitado.

sys.audit() chamará os ganchos de auditoria existentes, passando o nome do evento e os argumentos, e levantará novamente a primeira exceção de qualquer gancho. Em geral, se uma exceção for levantada, ela não deve ser tratada e o processo deve ser encerrado o mais rápido possível. Isso permite que as implementações de gancho decidam como responder a eventos específicos: elas podem simplesmente registrar o evento ou abortar a operação levantando uma exceção.

Ganchos são adicionados usando as funções sys.addaudithook() ou PySys_AddAuditHook().

O equivalente nativo desta função é PySys_Audit(). Usar a função nativa é preferível quando possível.

Veja tabela de eventos de auditoria para todos os eventos levantados pelo CPython.

Novo na versão 3.8.

sys.base_exec_prefix¶: Definido durante a inicialização do Python, antes de site.py ser executado, para o mesmo valor que exec_prefix. Se não estiver executando em um ambiente virtual, os valores permanecerão os mesmos; se site.py descobrir que um ambiente virtual está em uso, os valores de prefix e exec_prefix serão alterados para apontar para o ambiente virtual, enquanto base_prefix e base_exec_prefix permanecerá apontando para a instalação base do Python (aquela a partir da qual o ambiente virtual foi criado).

Novo na versão 3.3.

sys.base_prefix¶: Definido durante a inicialização do Python, antes de site.py ser executado, para o mesmo valor que prefix. Se não estiver executando em um ambiente virtual, os valores permanecerão os mesmos; se site.py descobrir que um ambiente virtual está em uso, os valores de prefix e exec_prefix serão alterados para apontar para o ambiente virtual, enquanto base_prefix e base_exec_prefix permanecerá apontando para a instalação base do Python (aquela a partir da qual o ambiente virtual foi criado).

Novo na versão 3.3.

sys.byteorder¶: Um indicador da ordem nativa de bytes. Isso terá o valor 'big' em plataformas big endian (byte mais significativo primeiro) e 'little' em plataformas little endian (byte menos significativo primeiro).

sys.builtin_module_names¶: A tuple of strings giving the names of all modules that are compiled into this Python interpreter. (This information is not available in any other way — modules.keys() only lists the imported modules.)

sys.call_tracing(func, args)¶: Chama func(*args), enquanto o rastreamento está habilitado. O estado de rastreamento é salvo e restaurado posteriormente. Isso deve ser chamado de um depurador de um ponto de verificação, para depurar recursivamente algum outro código.

sys.copyright¶: Uma string contendo os direitos autorais pertencentes ao interpretador Python.

sys._clear_type_cache()¶

Limpa o cache de tipo interno. O cache de tipo é usado para acelerar pesquisas de atributos e métodos. Use a função apenas para descartar referências desnecessárias durante a depuração de vazamento de referência.

Esta função deve ser usada apenas para fins internos e especializados.

sys._current_frames()¶

Retorna um dicionário mapeando o identificador de cada encadeamento (thread) para o quadro de pilha mais alto atualmente ativo nesse encadeamento no momento em que a função é chamada. Observe que as funções no módulo traceback podem construir a pilha de chamadas dado tal quadro.

Isso é mais útil para fazer a depuração de impasses: esta função não requer a cooperação das threads em impasse e as pilhas de chamadas de tais threads são congeladas enquanto permanecerem em impasse (deadlock). O quadro retornado para uma thread sem impasse pode não ter nenhuma relação com a atividade atual da thread no momento em que o código de chamada examina o quadro.

Esta função deve ser usada apenas para fins internos e especializados.

Levanta um evento de auditoria sys._current_frames sem argumentos.

sys.breakpointhook()¶

Esta função de gancho é chamada pela função embutida breakpoint(). Por padrão, ela leva você ao depurador pdb, mas pode ser configurado para qualquer outra função para que você possa escolher qual depurador será usado.

A assinatura dessa função depende do que ela chama. Por exemplo, a ligação padrão (por exemplo, pdb.set_trace()) não espera nenhum argumento, mas você pode vinculá-la a uma função que espera argumentos adicionais (posicionais e/ou nomeados). A função embutida breakpoint() passa seus *args e **kws diretamente. O que quer que breakpointhooks() retorne é retornado de breakpoint().

A implementação padrão primeiro consulta a variável de ambiente PYTHONBREAKPOINT. Se for definido como "0", então esta função retorna imediatamente; ou seja, é um no-op. Se a variável de ambiente não for definida, ou for definida como uma string vazia, pdb.set_trace() será chamado. Caso contrário, essa variável deve nomear uma função a ser executada, usando a nomenclatura de importação pontilhada do Python, por exemplo package.subpackage.module.function. Neste caso, package.subpackage.module seria importado e o módulo resultante deve ter um chamável chamado function(). Isso é executado, passando *args e **kws, e qualquer que seja o retorno de function(), sys.breakpointhook() retorna para a função embutida breakpoint().

Observe que se algo der errado ao importar o chamável nomeado por PYTHONBREAKPOINT, uma RuntimeWarning é relatado e o ponto de interrupção é ignorado.

Observe também que se sys.breakpointhook() for sobrescrito programaticamente, PYTHONBREAKPOINT não será consultado.

Novo na versão 3.7.

sys._debugmallocstats()¶

Imprima informações de baixo nível para stderr sobre o estado do alocador de memória do CPython.

If Python is configured –with-pydebug, it also performs some expensive internal consistency checks.

Novo na versão 3.3.

CPython implementation detail: Esta função é específica para CPython. O formato de saída exato não é definido aqui e pode mudar.

sys.dllhandle¶

Número inteiro que especifica o identificador da DLL do Python.

Disponibilidade: Windows.

sys.displayhook(value)¶

Se value não for None, esta função imprime repr(value) em sys.stdout, e salva value em builtins._. Se repr(value) não for codificável para sys.stdout.encoding com o tratador de erros sys.stdout.errors (que provavelmente é 'strict'), codifica-o para sys.stdout.encoding com tratador de erros 'backslashreplace'.

sys.displayhook é chamado no resultado da avaliação de uma expressão inserida em uma sessão interativa do Python. A exibição desses valores pode ser personalizada atribuindo outra função de um argumento a sys.displayhook.

Pseudocódigo:

def displayhook(value):
    if value is None:
        return
    # Set '_' to None to avoid recursion
    builtins._ = None
    text = repr(value)
    try:
        sys.stdout.write(text)
    except UnicodeEncodeError:
        bytes = text.encode(sys.stdout.encoding, 'backslashreplace')
        if hasattr(sys.stdout, 'buffer'):
            sys.stdout.buffer.write(bytes)
        else:
            text = bytes.decode(sys.stdout.encoding, 'strict')
            sys.stdout.write(text)
    sys.stdout.write("\n")
    builtins._ = value

Alterado na versão 3.2: Usa o tratador de erros 'backslashreplace' ao ser levantada UnicodeEncodeError.

sys.dont_write_bytecode¶: Se isso for true, o Python não tentará escrever arquivos .pyc na importação de módulos fonte. Este valor é inicialmente definido como True ou False dependendo da opção de linha de comando -B e da variável de ambiente PYTHONDONTWRITEBYTECODE, mas você mesmo pode configurá-lo para controlar geração de arquivo bytecode.

sys.pycache_prefix¶

If this is set (not None), Python will write bytecode-cache .pyc files to (and read them from) a parallel directory tree rooted at this directory, rather than from __pycache__ directories in the source code tree. Any __pycache__ directories in the source code tree will be ignored and new .pyc files written within the pycache prefix. Thus if you use compileall as a pre-build step, you must ensure you run it with the same pycache prefix (if any) that you will use at runtime.

Um caminho relativo é interpretado em relação ao diretório de trabalho atual.

Este valor é definido inicialmente com base no valor da opção de linha de comando -X pycache_prefix=PATH ou na variável de ambiente PYTHONPYCACHEPREFIX (a linha de comando tem precedência). Se nenhum estiver definido, é None.

Novo na versão 3.8.

sys.excepthook(type, value, traceback)¶

Esta função imprime um determinado traceback (situação da pilha de execução) e exceção para sys.stderr.

Quando uma exceção é lançada e não capturada, o interpretador chama sys.excepthook com três argumentos, a classe de exceção, a instância de exceção e um objeto traceback. Em uma sessão interativa, isso acontece logo antes de o controle retornar ao prompt; em um programa Python, isso acontece pouco antes de o programa ser encerrado. A manipulação de tais exceções de nível superior pode ser personalizada atribuindo outra função de três argumentos a sys.excepthook.

Levanta um evento de auditoria sys.excepthook com argumentos hook, type, value, traceback.

Ver também

A função sys.unraisablehook() lida com exceções que não podem ser levantadas e a função threading.excepthook() trata exceções levantadas por threading.Thread.run().

sys.__breakpointhook__¶
sys.__displayhook__¶
sys.__excepthook__¶
sys.__unraisablehook__¶: Esses objetos contêm os valores originais de breakpointhook, displayhook, excepthook e unraisablehook no início do programa. Eles são salvos para que breakpointhook, displayhook e excepthook, unraisablehook possam ser restaurados caso sejam substituídos por objetos quebrados ou alternativos.

Novo na versão 3.7: __breakpointhook__

Novo na versão 3.8: __unraisablehook__

sys.exc_info()¶

This function returns a tuple of three values that give information about the exception that is currently being handled. The information returned is specific both to the current thread and to the current stack frame. If the current stack frame is not handling an exception, the information is taken from the calling stack frame, or its caller, and so on until a stack frame is found that is handling an exception. Here, “handling an exception” is defined as “executing an except clause.” For any stack frame, only information about the exception being currently handled is accessible.

If no exception is being handled anywhere on the stack, a tuple containing three None values is returned. Otherwise, the values returned are (type, value, traceback). Their meaning is: type gets the type of the exception being handled (a subclass of BaseException); value gets the exception instance (an instance of the exception type); traceback gets a traceback object which encapsulates the call stack at the point where the exception originally occurred.

sys.exec_prefix¶: Uma string que fornece o prefixo do diretório específico do site onde os arquivos Python dependentes da plataforma são instalados; por padrão, também é '/usr/local'. Isso pode ser definido em tempo de compilação com o argumento --exec-prefix para o script configure. Especificamente, todos os arquivos de configuração (por exemplo, o arquivo de cabeçalho pyconfig.h) são instalados no diretório exec_prefix/lib/pythonX.Y/config, e os módulos da biblioteca compartilhada são instalados em exec_prefix/lib/pythonX.Y/lib-dynload, onde X.Y é o número da versão do Python, por exemplo 3.2.

Nota

Se um ambiente virtual estiver em vigor, este valor será alterado em site.py para apontar para o ambiente virtual. O valor para a instalação do Python ainda estará disponível, via base_exec_prefix.

sys.executable¶: Uma string que fornece o caminho absoluto do binário executável para o interpretador Python, em sistemas onde isso faz sentido. Se o Python não conseguir recuperar o caminho real para seu executável, sys.executable será uma string vazia ou None.

sys.exit([arg])¶

Levanta uma exceção SystemExit, sinalizando a intenção de sair do interpretador.

O argumento opcional arg pode ser um número inteiro dando o status de saída (o padrão é zero) ou outro tipo de objeto. Se for um número inteiro, zero é considerado “terminação bem-sucedida” e qualquer valor diferente de zero é considerado “terminação anormal” por shells e similares. A maioria dos sistemas exige que ele esteja no intervalo de 0 a 127 e, caso contrário, produz resultados indefinidos. Alguns sistemas têm uma convenção para atribuir significados específicos a códigos de saída específicos, mas estes são geralmente subdesenvolvidos; Programas Unix geralmente usam 2 para erros de sintaxe de linha de comando e 1 para todos os outros tipos de erros. Se outro tipo de objeto for passado, None é equivalente a passar zero, e qualquer outro objeto é impresso em stderr e resulta em um código de saída de 1. Em particular, sys.exit( "alguma mensagem de erro") é uma maneira rápida de sair de um programa quando ocorre um erro.

Uma vez que exit() em última análise, “apenas” gera uma exceção, ele só sairá do processo quando chamado do thread principal e a exceção não é interceptada. As ações de limpeza especificadas pelas cláusulas finally de instruções try são honradas e é possível interceptar a tentativa de saída em um nível externo.

Alterado na versão 3.6: Se ocorrer um erro na limpeza após o interpretador Python ter capturado SystemExit (como um erro ao liberar dados em buffer nos fluxos padrão), o status de saída é alterado para 120.

sys.flags¶

A tupla nomeada flags expõe o status dos sinalizadores de linha de comando. Os atributos são somente leitura.

atributo	sinalizador
`debug`	`-d`
`inspect`	`-i`
`interactive`	`-i`
`isolated`	`-I`
`optimize`	`-O` ou `-OO`
`dont_write_bytecode`	`-B`
`no_user_site`	`-s`
`no_site`	`-S`
`ignore_environment`	`-E`
`verbose`	`-v`
`bytes_warning`	`-b`
`quiet`	`-q`
`hash_randomization`	`-R`
`dev_mode`	`-X dev` (Modo de Desenvolvimento do Python)
`utf8_mode`	`-X utf8`
`int_max_str_digits`	`-X int_max_str_digits` (limitação de comprimento de string na conversão para inteiro)

Alterado na versão 3.2: Adicionado o atributo quiet para o novo sinalizador -q.

Novo na versão 3.2.3: O atributo hash_randomization.

Alterado na versão 3.3: Removido o atributo obsoleto division_warning.

Alterado na versão 3.4: Adicionado o atributo isolated para o sinalizador -I isolated.

Alterado na versão 3.7: Adicionado o atributo dev_mode para o novo Modo de Desenvolvimento do Python e o atributo utf8_mode para o novo sinalizador -X utf8.

Alterado na versão 3.9.14: Adicionado o atributo int_max_str_digits.

sys.float_info¶

Uma tupla nomeada contendo informações sobre o tipo float, ponto flutuante. Ele contém informações de baixo nível sobre a precisão e a representação interna. Os valores correspondem às várias constantes de ponto flutuante definidas no arquivo de cabeçalho padrão float.h para a linguagem de programação ‘C’; consulte a seção 5.2.4.2.2 do padrão ISO/IEC C de 1999 [C99], ‘Características dos tipos flutuantes’, para obter detalhes.

atributo	macro em float.h	explicação
`epsilon`	DBL_EPSILON	diferença entre 1,0 e o menor valor maior que 1,0 que pode ser representado como ponto flutuante Veja também `math.ulp.()`
`dig`	DBL_DIG	número máximo de dígitos decimais que podem ser fielmente representados em um ponto flutuante; Veja abaixo
`mant_dig`	DBL_MANT_DIG	precisão do ponto flutuante: o número de dígitos de base `radix` no significando de um ponto flutuante
`max`	DBL_MAX	ponto flutuante finito positivo máximo representável
`max_exp`	DBL_MAX_EXP	inteiro máximo e de tal modo que `radix**(e-1)` é um ponto flutuante finito representável
`max_10_exp`	DBL_MAX_10_EXP	inteiro máximo e de tal modo que `10**e` é um intervalo de pontos flutuantes finitos representáveis
`min`	DBL_MIN	ponto flutuante normalizado positivo mínimo representável Use `math.ulp(0.0)` para obter o menor ponto flutuante representável positivo desnormalizado.
`min_exp`	DBL_MIN_EXP	inteiro mínimo e de tal modo que `radix**(e-1)` é um ponto flutuante normalizado
`min_10_exp`	DBL_MIN_10_EXP	inteiro mínimo e de tal modo que `10**e` é um ponto flutuante normalizado
`radix`	FLT_RADIX	raiz da representação do expoente
`rounds`	FLT_ROUNDS	integer constant representing the rounding mode used for arithmetic operations. This reflects the value of the system FLT_ROUNDS macro at interpreter startup time. See section 5.2.4.2.2 of the C99 standard for an explanation of the possible values and their meanings.

O atributo sys.float_info.dig precisa de mais explicações. Se s for qualquer string representando um número decimal com no máximo sys.float_info.dig dígitos significativos, então converter s para ponto flutuante e vice-versa recuperará uma string representando o mesmo decimal valor:

>>> import sys
>>> sys.float_info.dig
15
>>> s = '3.14159265358979'    # decimal string with 15 significant digits
>>> format(float(s), '.15g')  # convert to float and back -> same value
'3.14159265358979'

Mas para strings com mais de sys.float_info.dig dígitos significativos, isso nem sempre é verdade:

>>> s = '9876543211234567'    # 16 significant digits is too many!
>>> format(float(s), '.16g')  # conversion changes value
'9876543211234568'

sys.float_repr_style¶: Uma string indicando como a função repr() se comporta para floats. Se a string tem valor 'short' então para um ponto flutuante finito x, repr(x) visa produzir uma string curta com a propriedade que float(repr(x)) == x. Este é o comportamento usual no Python 3.1 e posterior. Caso contrário, float_repr_style tem valor 'legacy' e repr(x) se comporta da mesma forma que nas versões do Python anteriores a 3.1.

Novo na versão 3.1.

sys.getallocatedblocks()¶

Retorna o número de blocos de memória atualmente alocados pelo interpretador, independentemente de seu tamanho. Esta função é útil principalmente para rastrear e depurar vazamentos de memória. Devido aos caches internos do interpretador, o resultado pode variar de chamada para chamada; você pode ter que chamar _clear_type_cache() e gc.collect() para obter resultados mais previsíveis.

Se uma construção ou implementação do Python não puder computar razoavelmente essas informações, getallocatedblocks() poderá retornar 0 em seu lugar.

Novo na versão 3.4.

sys.getandroidapilevel()¶

Retorna a versão da API de tempo de compilação do Android como um número inteiro.

Disponibilidade: Android.

Novo na versão 3.7.

sys.getdefaultencoding()¶: Retorna o nome da codificação de string padrão atual usada pela implementação Unicode.

sys.getdlopenflags()¶

Retorna o valor atual dos sinalizadores que são usados para chamadas dlopen(). Nomes simbólicos para os valores dos sinalizadores podem ser encontrados no módulo os (constantes RTLD_xxx, por exemplo os.RTLD_LAZY).

Disponibilidade: Unix.

sys.getfilesystemencoding()¶

Return the name of the encoding used to convert between Unicode filenames and bytes filenames. For best compatibility, str should be used for filenames in all cases, although representing filenames as bytes is also supported. Functions accepting or returning filenames should support either str or bytes and internally convert to the system’s preferred representation.

This encoding is always ASCII-compatible.

os.fsencode() e os.fsdecode() devem ser usados para garantir que a codificação correta e o modo de erros sejam usados.

In the UTF-8 mode, the encoding is utf-8 on any platform.
On macOS, the encoding is 'utf-8'.
On Unix, the encoding is the locale encoding.
On Windows, the encoding may be 'utf-8' or 'mbcs', depending on user configuration.
On Android, the encoding is 'utf-8'.
On VxWorks, the encoding is 'utf-8'.

Alterado na versão 3.2: O resultado de getfilesystemencoding() não pode mais ser None.

Alterado na versão 3.6: O Windows não tem mais garantia de retornar 'mbcs'. Veja PEP 529 e _enablelegacywindowsfsencoding() para mais informações.

Alterado na versão 3.7: Return ‘utf-8’ in the UTF-8 mode.

sys.getfilesystemencodeerrors()¶

Return the name of the error mode used to convert between Unicode filenames and bytes filenames. The encoding name is returned from getfilesystemencoding().

os.fsencode() e os.fsdecode() devem ser usados para garantir que a codificação correta e o modo de erros sejam usados.

Novo na versão 3.6.

sys.get_int_max_str_digits()¶: Retorna o valor atual para a limitação de comprimento de string na conversão para inteiro. Veja também set_int_max_str_digits().

Novo na versão 3.9.14.

sys.getrefcount(object)¶: Retorna a contagem de referências do object. A contagem retornada é geralmente um valor maior do que o esperado, porque inclui a referência (temporária) como um argumento para getrefcount().

sys.getrecursionlimit()¶: Retorna o valor atual do limite de recursão, a profundidade máxima da pilha do interpretador Python. Esse limite evita que a recursão infinita cause um estouro da pilha C e falhe o Python. Pode ser definido por setrecursionlimit().

sys.getsizeof(object[, default])¶

Retorna o tamanho de um objeto em bytes. O objeto pode ser qualquer tipo de objeto. Todos os objetos embutidos retornarão resultados corretos, mas isso não precisa ser verdadeiro para extensões de terceiros, pois é específico da implementação.

Apenas o consumo de memória diretamente atribuído ao objeto é contabilizado, não o consumo de memória dos objetos a que ele se refere.

Se fornecido, default será retornado se o objeto não fornecer meios para recuperar o tamanho. Caso contrário, uma exceção TypeError será levantada.

getsizeof() chama o método __sizeof__ do objeto e adiciona uma sobrecarga adicional do coletor de lixo se o objeto for gerenciado pelo coletor de lixo.

Consulte receita de tamanho recursivo para obter um exemplo de uso de getsizeof() recursivamente para encontrar o tamanho dos contêineres e todo o seu conteúdo.

sys.getswitchinterval()¶: Retorna o “intervalo de troca de thread” do interpretador; veja setswitchinterval().

Novo na versão 3.2.

sys._getframe([depth])¶

Retorna um objeto quadro da pilha de chamadas. Se o inteiro opcional depth for fornecido, retorna o objeto de quadro que muitos chamam abaixo do topo da pilha. Se for mais profundo do que a pilha de chamadas, ValueError é levantada. O padrão para depth é zero, retornando o quadro no topo da pilha de chamadas.

Raises an auditing event sys._getframe with no arguments.

CPython implementation detail: Esta função deve ser usada apenas para fins internos e especializados. Não é garantido que exista em todas as implementações do Python.

sys.getprofile()¶: Obtém a função do criador de perfil conforme definido por setprofile().

sys.gettrace()¶: Obtém a função trace conforme definido por settrace().

CPython implementation detail: A função gettrace() destina-se apenas à implementação de depuradores, perfiladores, ferramentas de cobertura e similares. Seu comportamento faz parte da plataforma de implementação, e não da definição da linguagem e, portanto, pode não estar disponível em todas as implementações do Python.

sys.getwindowsversion()¶

Retorna uma tupla nomeada que descreve a versão do Windows em execução no momento. Os elementos nomeados são major, minor, build, platform, service_pack, service_pack_minor, service_pack_major, suite_mask, product_type e platform_version. service_pack contém uma string, platform_version uma tupla de 3 elementos e todos os outros valores são inteiros. Os componentes também podem ser acessados pelo nome, então sys.getwindowsversion()[0] é equivalente a sys.getwindowsversion().major. Para compatibilidade com versões anteriores, apenas os primeiros 5 elementos são recuperáveis por indexação.

platform será 2 (VER_PLATFORM_WIN32_NT).

product_type pode ser um dos seguintes valores:

Constante	Significado
`1 (VER_NT_WORKSTATION)`	O sistema é uma estação de trabalho
`2 (VER_NT_DOMAIN_CONTROLLER)`	O sistema é um controlador de domínio.
`3 (VER_NT_SERVER)`	O sistema é um servidor, mas não um controlador de domínio.

Esta função atua como um envólucro em volta da função Win32 GetVersionEx(); consulte a documentação da Microsoft em OSVERSIONINFOEX() para obter mais informações sobre esses campos.

platform_version retorna a versão principal, a versão secundária e o número de compilação do sistema operacional atual, em vez da versão que está sendo emulada para o processo. Destina-se a ser usado no registro, e não na detecção de recursos.

Nota

platform_version deriva a versão de kernel32.dll que pode ser de uma versão diferente da versão do sistema operacional. Use o módulo platform para obter a versão precisa do sistema operacional.

Disponibilidade: Windows.

Alterado na versão 3.2: Alterado para uma tupla nomeada e adicionado service_pack_minor, service_pack_major, suite_mask e product_type.

Alterado na versão 3.6: Adicionado platform_version

sys.get_asyncgen_hooks()¶: Returns an asyncgen_hooks object, which is similar to a namedtuple of the form (firstiter, finalizer), where firstiter and finalizer are expected to be either None or functions which take an asynchronous generator iterator as an argument, and are used to schedule finalization of an asynchronous generator by an event loop.

Novo na versão 3.6: Veja PEP 525 para mais detalhes.

Nota

Esta função foi adicionada provisoriamente (veja PEP 411 para detalhes.)

sys.get_coroutine_origin_tracking_depth()¶: Obtém a profundidade de rastreamento da origem da corrotina atual, conforme definido por set_coroutine_origin_tracking_depth().

Novo na versão 3.7.

Nota

Esta função foi adicionada provisoriamente (veja PEP 411 para detalhes.) Use-a apenas para propósitos de depuração.

sys.hash_info¶

Uma tupla nomeada fornecendo parâmetros da implementação de hash numérico. Para mais detalhes sobre hashing de tipos numéricos, veja Hashing de tipos numéricos.

atributo	explicação
`width`	largura em bits usada para fazer hash de valores
`modulus`	módulo primo P usado para esquema de hash numérico
`inf`	valor de hash retornado para um infinito positivo
`nan`	hash value returned for a nan
`imag`	multiplicador usado para a parte imaginária de um número complexo
`algorithm`	nome do algoritmo para hash de str, bytes e memoryview
`hash_bits`	tamanho da saída interna do algoritmo de hash
`seed_bits`	tamanho da chave semente do algoritmo hash

Novo na versão 3.2.

Alterado na versão 3.4: Adicionado algorithm, hash_bits e seed_bits

sys.hexversion¶

O número da versão codificado como um único inteiro. Isso é garantido para aumentar com cada versão, incluindo suporte adequado para lançamentos de não produção. Por exemplo, para testar se o interpretador Python é pelo menos a versão 1.5.2, use:

if sys.hexversion >= 0x010502F0:
    # use some advanced feature
    ...
else:
    # use an alternative implementation or warn the user
    ...

Isso é chamado hexversion já que só parece realmente significativo quando visto como o resultado de passá-lo para a função embutida hex(). A tupla nomeada sys.version_info pode ser usada para uma codificação mais amigável das mesmas informações.

Mais detalhes sobre hexversion podem ser encontrados em API e Versionamento de ABI.

sys.implementation¶

Um objeto que contém informações sobre a implementação do interpretador Python em execução no momento. Os atributos a seguir devem existir em todas as implementações do Python.

name é o identificador da implementação, por exemplo 'cpython'. A string real é definida pela implementação do Python, mas é garantido que seja minúscula.

version é uma tupla nomeada, no mesmo formato que sys.version_info. Ela representa a versão da implementação Python em implementation. Isso tem um significado distinto da versão específica da linguagem Python à qual o interpretador em execução no momento está em conformidade, que sys.version_info representa. Por exemplo, para PyPy 1.8 sys.implementation.version pode ser sys.version_info(1, 8, 0, 'final', 0), enquanto sys.version_info seria sys.version_info(2, 7, 2, 'final', 0). Para CPython, eles são o mesmo valor, pois é a implementação de referência.

hexversion é a versão de implementação em formato hexadecimal, como sys.hexversion.

cache_tag é a tag usada pelo mecanismo de importação nos nomes de arquivo dos módulos em cache. Por convenção, seria um composto do nome e da versão da implementação, como 'cpython-33'. No entanto, uma implementação Python pode usar algum outro valor, se apropriado. Se cache_tag for definido como None, isso indica que o cache do módulo deve ser desabilitado.

sys.implementation pode conter atributos adicionais específicos para a implementação do Python. Esses atributos não padrão devem começar com um sublinhado e não são descritos aqui. Independentemente do seu conteúdo, sys.implementation não mudará durante uma execução do interpretador, nem entre versões de implementação. (No entanto, ele pode mudar entre versões da linguagem Python.) Veja a PEP 421 para mais informações.

Novo na versão 3.3.

Nota

A adição de novos atributos obrigatórios deve passar pelo processo normal de PEPs. Veja a PEP 421 para mais informações.

sys.int_info¶

Uma tupla nomeada que contém informações sobre a representação interna de inteiros do Python. Os atributos são somente leitura.

Atributo	Explanação
`bits_per_digit`	number of bits held in each digit. Python integers are stored internally in base `2**int_info.bits_per_digit`
`sizeof_digit`	size in bytes of the C type used to represent a digit
`default_max_str_digits`	default value for `sys.get_int_max_str_digits()` when it is not otherwise explicitly configured.
`str_digits_check_threshold`	minimum non-zero value for `sys.set_int_max_str_digits()`, `PYTHONINTMAXSTRDIGITS`, or `-X int_max_str_digits`.

Novo na versão 3.1.

Alterado na versão 3.9.14: Added default_max_str_digits and str_digits_check_threshold.

sys.__interactivehook__¶

Quando esse atributo existe, seu valor é chamado automaticamente (sem argumentos) quando o interpretador é iniciado em modo interativo. Isso é feito após o arquivo PYTHONSTARTUP ser lido, para que você possa definir esse gancho lá. O módulo site define isso.

Levanta um evento de auditoria cpython.run_interactivehook com o objeto gancho como o argumento quando o gancho é chamado na inicialização.

Novo na versão 3.4.

sys.intern(string)¶

Insere string na tabela de strings “internalizadas” e retorna a string internalizada – que é a própria string ou uma cópia. Strings internalizadas são úteis para obter um pouco de desempenho na pesquisa de dicionário – se as chaves em um dicionário foram internalizadas, e a chave de pesquisa para internalizada, já que comparações de chaves (após o hash) podem ser feitas por uma comparação de ponteiros em vez de uma comparação de strings. Normalmente, os nomes usados em programas Python são internalizados automaticamente, e os dicionários usados para armazenar atributos de módulo, classe ou instância têm chaves internalizadas.

Interned strings are not immortal; you must keep a reference to the return value of intern() around to benefit from it.

sys.is_finalizing()¶: Return True if the Python interpreter is shutting down, False otherwise.

Novo na versão 3.5.

sys.last_type¶

sys.last_value¶

sys.last_traceback¶

These three variables are not always defined; they are set when an exception is not handled and the interpreter prints an error message and a stack traceback. Their intended use is to allow an interactive user to import a debugger module and engage in post-mortem debugging without having to re-execute the command that caused the error. (Typical use is import pdb; pdb.pm() to enter the post-mortem debugger; see pdb module for more information.)

The meaning of the variables is the same as that of the return values from exc_info() above.

sys.maxsize¶: Um inteiro que fornece o valor máximo que uma variável do tipo Py_ssize_t pode assumir. Geralmente é 2**31 - 1 em uma plataforma de 32 bits e 2**63 - 1 em uma plataforma de 64 bits.

sys.maxunicode¶: Um inteiro que fornece o valor do maior ponto de código Unicode, ou seja, 1114111 (0x10FFFF em hexadecimal).

Alterado na versão 3.3: Antes da PEP 393, sys.maxunicode costumava ser 0xFFFF ou 0x10FFFF, dependendo da opção de configuração que especificava se os caracteres Unicode eram armazenados como UCS-2 ou UCS-4.

sys.meta_path¶

A list of meta path finder objects that have their find_spec() methods called to see if one of the objects can find the module to be imported. The find_spec() method is called with at least the absolute name of the module being imported. If the module to be imported is contained in a package, then the parent package’s __path__ attribute is passed in as a second argument. The method returns a module spec, or None if the module cannot be found.

Ver também

importlib.abc.MetaPathFinder: A classe base abstrata que define a interface dos objetos localizadores em meta_path.
importlib.machinery.ModuleSpec: A classe concreta da qual find_spec() deve retornar instâncias.

Alterado na versão 3.4: Module specs were introduced in Python 3.4, by PEP 451. Earlier versions of Python looked for a method called find_module(). This is still called as a fallback if a meta_path entry doesn’t have a find_spec() method.

sys.modules¶: This is a dictionary that maps module names to modules which have already been loaded. This can be manipulated to force reloading of modules and other tricks. However, replacing the dictionary will not necessarily work as expected and deleting essential items from the dictionary may cause Python to fail.

sys.path¶

Uma lista de strings que especifica o caminho de pesquisa para módulos. Inicializado a partir da variável de ambiente PYTHONPATH, mais um padrão dependente da instalação.

As initialized upon program startup, the first item of this list, path[0], is the directory containing the script that was used to invoke the Python interpreter. If the script directory is not available (e.g. if the interpreter is invoked interactively or if the script is read from standard input), path[0] is the empty string, which directs Python to search modules in the current directory first. Notice that the script directory is inserted before the entries inserted as a result of PYTHONPATH.

A program is free to modify this list for its own purposes. Only strings and bytes should be added to sys.path; all other data types are ignored during import.

Ver também

Módulo site Descreve como usar arquivos .pth para estender sys.path.

sys.path_hooks¶

Uma lista de chamáveis que recebem um argumento de caminho para tentar criar um localizador para o caminho. Se um localizador puder ser criado, ele deve ser retornado pelo chamável, senão, ele levanta ImportError.

Originalmente especificado na PEP 302.

sys.path_importer_cache¶

Um dicionário atuando como um cache para objetos do localizador. As chaves são caminhos que foram passados para sys.path_hooks e os valores são os localizadores que são encontrados. Se um caminho for um caminho de sistema de arquivo válido, mas nenhum localizador for encontrado em sys.path_hooks, então None é armazenado.

Originalmente especificado na PEP 302.

Alterado na versão 3.3: None is stored instead of imp.NullImporter when no finder is found.

sys.platform¶

This string contains a platform identifier that can be used to append platform-specific components to sys.path, for instance.

For Unix systems, except on Linux and AIX, this is the lowercased OS name as returned by uname -s with the first part of the version as returned by uname -r appended, e.g. 'sunos5' or 'freebsd8', at the time when Python was built. Unless you want to test for a specific system version, it is therefore recommended to use the following idiom:

if sys.platform.startswith('freebsd'):
    # FreeBSD-specific code here...
elif sys.platform.startswith('linux'):
    # Linux-specific code here...
elif sys.platform.startswith('aix'):
    # AIX-specific code here...

For other systems, the values are:

Sistema	Valor de `platform`
AIX	`'aix'`
Linux	`'linux'`
Windows	`'win32'`
Windows/Cygwin	`'cygwin'`
macOS	`'darwin'`

Alterado na versão 3.3: On Linux, sys.platform doesn’t contain the major version anymore. It is always 'linux', instead of 'linux2' or 'linux3'. Since older Python versions include the version number, it is recommended to always use the startswith idiom presented above.

Alterado na versão 3.8: On AIX, sys.platform doesn’t contain the major version anymore. It is always 'aix', instead of 'aix5' or 'aix7'. Since older Python versions include the version number, it is recommended to always use the startswith idiom presented above.

Ver também

os.name has a coarser granularity. os.uname() gives system-dependent version information.

O módulo platform fornece verificações detalhadas sobre a identificação do sistema.

sys.platlibdir¶

Nome do diretório da biblioteca específica da plataforma. É usado para construir o caminho da biblioteca padrão e os caminhos dos módulos de extensão instalados.

É igual a "lib" na maioria das plataformas. No Fedora e SuSE, é igual a "lib64" em plataformas de 64 bits, o que fornece os seguintes caminhos sys.path (onde X.Y é a versão major.minor do Python):

/usr/lib64/pythonX.Y/: Biblioteca padrão (como os.py do módulo os)
/usr/lib64/pythonX.Y/lib-dynload/: Módulos de extensão C da biblioteca padrão (como o módulo errno, o nome exato do arquivo é específico da plataforma)
/usr/lib/pythonX.Y/site-packages/ (sempre usa lib, não sys.platlibdir): Módulos de terceiros
/usr/lib64/pythonX.Y/site-packages/: Módulos de extensão C de pacotes de terceiros

Novo na versão 3.9.

sys.prefix¶: A string giving the site-specific directory prefix where the platform independent Python files are installed; on Unix, the default is '/usr/local'. This can be set at build time with the --prefix argument to the configure script. See Caminhos de instalação for derived paths.

Nota

Se um ambiente virtual estiver em vigor, este valor será alterado em site.py para apontar para o ambiente virtual. O valor para a instalação do Python ainda estará disponível, via base_prefix.

sys.ps1¶
sys.ps2¶: Strings especificando o prompt primário e secundário do interpretador. Elas são definidas somente se o interpretador estiver no modo interativo. Seus valores iniciais neste caso são '>>> ' e '... '. Se um objeto não string for atribuído a qualquer variável, seu str() é reavaliado cada vez que o interpretador se prepara para ler um novo comando interativo; isso pode ser usado para implementar um prompt dinâmico.

sys.setdlopenflags(n)¶

Set the flags used by the interpreter for dlopen() calls, such as when the interpreter loads extension modules. Among other things, this will enable a lazy resolving of symbols when importing a module, if called as sys.setdlopenflags(0). To share symbols across extension modules, call as sys.setdlopenflags(os.RTLD_GLOBAL). Symbolic names for the flag values can be found in the os module (RTLD_xxx constants, e.g. os.RTLD_LAZY).

Disponibilidade: Unix.

sys.set_int_max_str_digits(n)¶: Define a limitação de comprimento de string na conversão para inteiro usada por este interpretador. Veja também get_int_max_str_digits().

Novo na versão 3.9.14.

sys.setprofile(profilefunc)¶

Define a função de perfil do sistema, que permite implementar um perfilador de código-fonte Python em Python. Veja o capítulo The Python Profilers para mais informações sobre o perfilador Python. A função de perfil do sistema é chamada de forma semelhante à função de rastreamento do sistema (veja settrace()), mas é chamada com eventos diferentes, por exemplo, não é chamada para cada linha de código executada (apenas na chamada e retorno, mas o evento de retorno é relatado mesmo quando uma exceção foi definida). A função é específica do thread, mas não há como o perfilador saber sobre trocas de contexto entre threads, então não faz sentido usá-la na presença de vários threads. Além disso, seu valor de retorno não é usado, então ele pode simplesmente retornar None. Um erro na função de perfil fará com que sua própria definição seja removida.

As funções de perfil devem ter três argumentos: frame, event e arg. frame é o quadro de pilha atual. event é uma string: 'call', 'return', 'c_call', 'c_return' ou 'c_exception'. arg depende do tipo de evento.

Levanta um evento de auditoria sys.setprofile sem argumentos.

Os eventos têm o seguinte significado:

'call': Uma função é chamada (ou algum outro bloco de código é inserido). A função de perfil é chamada; arg é None.
'return': Uma função (ou outro bloco de código) está prestes a retornar. A função de perfilação é chamada; arg é o valor que será retornado, ou None se o evento for causado por uma exceção sendo levantada.
'c_call': Uma função C está prestes a ser chamada. Pode ser uma função de extensão ou uma embutida. arg é o objeto da função C.
'c_return': Uma função C foi retornada. arg é o objeto da função C.
'c_exception': Uma função C levantou uma exceção. arg é o objeto da função C.

sys.setrecursionlimit(limit)¶

Define a profundidade máxima da pilha do interpretador Python para limit. Esse limite impede que a recursão infinita cause um estouro da pilha C e trave o Python.

O limite mais alto possível depende da plataforma. Um usuário pode precisar definir o limite mais alto quando tiver um programa que exija recursão profunda e uma plataforma que dê suporte a um limite mais alto. Isso deve ser feito com cuidado, porque um limite muito alto pode levar a uma falha.

Se o novo limite for muito baixo na profundidade de recursão atual, uma exceção RecursionError será levantada.

Alterado na versão 3.5.1: Uma exceção RecursionError agora é levantada se o novo limite for muito baixo na profundidade de recursão atual.

sys.setswitchinterval(interval)¶: Define o intervalo de troca de thread do interpretador (em segundos). Este valor de ponto flutuante determina a duração ideal das “fatias de tempo” alocadas para threads Python em execução simultânea. Observe que o valor real pode ser maior, especialmente se funções ou métodos internos de execução longa forem usados. Além disso, qual thread se torna agendada no final do intervalo é uma decisão do sistema operacional. O interpretador não tem seu próprio escalonador.

Novo na versão 3.2.

sys.settrace(tracefunc)¶

Define a função trace do sistema, que permite que você implemente um depurador de código-fonte Python em Python. A função é específica de thread; para um depurador suportar múltiplas threads, ele deve registrar uma função trace usando settrace() para cada thread que está sendo depurada ou usar threading.settrace().

As funções de rastreamento devem ter três argumentos: frame, event e arg. frame é o quadro de pilha atual. event é uma string: 'call', 'line', 'return', 'exception' ou 'opcode'. arg depende do tipo de evento.

A função de rastreamento é invocada (com event definido como 'call') sempre que um novo escopo local é inserido; ela deve retornar uma referência a uma função de rastreamento local a ser usada para o novo escopo, ou None se o escopo não deve ser rastreado.

The local trace function should return a reference to itself (or to another function for further tracing in that scope), or None to turn off tracing in that scope.

Se ocorrer algum erro na função de rastreamento, ela será desativada, assim como settrace(None) é chamado.

Os eventos têm o seguinte significado:

'call': Uma função é chamada (ou algum outro bloco de código é inserido). A função de rastreamento global é chamada; arg é None; o valor de retorno especifica a função de rastreamento local.
'line': The interpreter is about to execute a new line of code or re-execute the condition of a loop. The local trace function is called; arg is None; the return value specifies the new local trace function. See Objects/lnotab_notes.txt for a detailed explanation of how this works. Per-line events may be disabled for a frame by setting f_trace_lines to False on that frame.
'return': Uma função (ou outro bloco de código) está prestes a retornar. A função de rastreamento local é chamada; arg é o valor que será retornado, ou None se o evento for causado por uma exceção sendo levantada. O valor de retorno da função de rastreamento é ignorado.
'exception': Ocorreu uma exceção. A função de rastreamento local é chamada; arg é uma tupla (exception, value, traceback); o valor de retorno especifica a nova função de rastreamento local.
'opcode': The interpreter is about to execute a new opcode (see dis for opcode details). The local trace function is called; arg is None; the return value specifies the new local trace function. Per-opcode events are not emitted by default: they must be explicitly requested by setting f_trace_opcodes to True on the frame.

Observe que, à medida que uma exceção é propagada pela cadeia de chamadores, um evento 'exception' é gerado em cada nível.

Para um uso mais refinado, é possível definir uma função de rastreamento atribuindo frame.f_trace = tracefunc explicitamente, em vez de depender de ser definida indiretamente por meio do valor de retorno de uma função de rastreamento já instalada. Isso também é necessário para ativar a função de rastreamento no quadro atual, o que settrace() não faz. Observe que, para que isso funcione, uma função de rastreamento global deve ter sido instalada com settrace() para habilitar o maquinário de rastreamento em tempo de execução, mas não precisa ser a mesma função de rastreamento (por exemplo, pode ser uma função de rastreamento de baixa sobrecarga que simplesmente retorna None para se desabilitar imediatamente em cada quadro).

Para mais informações sobre objetos de código e quadro, consulte A hierarquia de tipos padrão.

Levanta um evento de auditoria sys.settrace sem argumentos.

CPython implementation detail: A função settrace() destina-se apenas à implementação de depuradores, perfiladores, ferramentas de cobertura e similares. Seu comportamento faz parte da plataforma de implementação, e não da definição da linguagem e, portanto, pode não estar disponível em todas as implementações do Python.

Alterado na versão 3.7: 'opcode' event type added; f_trace_lines and f_trace_opcodes attributes added to frames

sys.set_asyncgen_hooks(firstiter, finalizer)¶

Aceita dois argumentos nomeados opcionais que são chamáveis que aceitam um iterador gerador assíncrono como argumento. O chamável firstiter será chamado quando um gerador assíncrono for iterado pela primeira vez. O finalizer será chamado quando um gerador assíncrono estiver prestes a ser coletado como lixo.

Levanta um evento de auditoria sys.set_asyncgen_hooks_firstiter sem argumentos.

Levanta um evento de auditoria sys.set_asyncgen_hooks_finalizer sem argumentos.

Dois eventos de auditoria são gerados porque a API subjacente consiste em duas chamadas, cada uma das quais deve levantar seu próprio evento.

Novo na versão 3.6: Veja a PEP 525 para mais detalhes, e para um exemplo de referência de um método finalizer veja a implementação de asyncio.Loop.shutdown_asyncgens em Lib/asyncio/base_events.py

Nota

Esta função foi adicionada provisoriamente (veja PEP 411 para detalhes.)

sys.set_coroutine_origin_tracking_depth(depth)¶

Allows enabling or disabling coroutine origin tracking. When enabled, the cr_origin attribute on coroutine objects will contain a tuple of (filename, line number, function name) tuples describing the traceback where the coroutine object was created, with the most recent call first. When disabled, cr_origin will be None.

Para habilitar, passe um valor depth maior que zero; isso define o número de quadros cujas informações serão capturadas. Para desabilitar, defina depth para zero.

Esta configuração é específica do thread.

Novo na versão 3.7.

Nota

Esta função foi adicionada provisoriamente (veja PEP 411 para detalhes.) Use-a apenas para propósitos de depuração.

sys._enablelegacywindowsfsencoding()¶

Changes the default filesystem encoding and errors mode to ‘mbcs’ and ‘replace’ respectively, for consistency with versions of Python prior to 3.6.

Isso é equivalente a definir a variável de ambiente PYTHONLEGACYWINDOWSFSENCODING antes de iniciar o Python.

Disponibilidade: Windows.

Novo na versão 3.6: Veja PEP 529 para mais detalhes.

sys.stdin¶

sys.stdout¶

sys.stderr¶

Objetos arquivo usados pelo interpretador para entrada padrão, saída e erros:

stdin é usado para todas as entradas interativas (incluindo chamadas para input());
stdout é usado para a saída das instruções print() e expressões e para os prompts de input();
Os prompts do próprio interpretador e suas mensagens de erro vão para stderr.

Esses fluxos são arquivos texto regulares como aqueles retornados pela função open(). Seus parâmetros são escolhidos da seguinte forma:

The character encoding is platform-dependent. Non-Windows platforms use the locale encoding (see locale.getpreferredencoding()).

On Windows, UTF-8 is used for the console device. Non-character devices such as disk files and pipes use the system locale encoding (i.e. the ANSI codepage). Non-console character devices such as NUL (i.e. where isatty() returns True) use the value of the console input and output codepages at startup, respectively for stdin and stdout/stderr. This defaults to the system locale encoding if the process is not initially attached to a console.

O comportamento especial do console pode ser substituído definindo a variável de ambiente PYTHONLEGACYWINDOWSSTDIO antes de iniciar o Python. Nesse caso, as páginas de código do console são usadas como para qualquer outro dispositivo de caractere.

Em todas as plataformas, você pode substituir a codificação de caracteres definindo a variável de ambiente PYTHONIOENCODING antes de iniciar o Python ou usando a nova opção de linha de comando -X utf8 e a variável de ambiente PYTHONUTF8. No entanto, para o console do Windows, isso só se aplica quando PYTHONLEGACYWINDOWSSTDIO também está definido.
Em todas as plataformas, você pode substituir a codificação de caracteres definindo a variável de ambiente PYTHONIOENCODING antes de iniciar o Python ou usando a nova opção de linha de comando -X utf8 e a variável de ambiente PYTHONUTF8. No entanto, para o console do Windows, isso só se aplica quando PYTHONLEGACYWINDOWSSTDIO também está definida.

Alterado na versão 3.9: stderr não interativo agora é armazenado em buffer de linha em vez de totalmente armazenado em buffer.

Nota

Para escrever ou ler dados binários de/para os fluxos padrão, use o objeto binário subjacente buffer. Por exemplo, para escrever bytes em stdout, use sys.stdout.buffer.write(b'abc').

However, if you are writing a library (and do not control in which context its code will be executed), be aware that the standard streams may be replaced with file-like objects like io.StringIO which do not support the buffer attribute.

sys.__stdin__¶

sys.__stdout__¶

sys.__stderr__¶

Esses objetos contêm os valores originais de stdin, stderr e stdout no início do programa. Eles são usados durante a finalização e podem ser úteis para imprimir no fluxo padrão real, não importa se o objeto sys.std* foi redirecionado.

Ele também pode ser usado para restaurar os arquivos reais para objetos arquivo de trabalho conhecidos, caso tenham sido substituídos por um objeto quebrado. No entanto, a maneira preferida de fazer isso é salvar explicitamente o fluxo anterior antes de substituí-lo e restaurar o objeto salvo.

Nota

Sob algumas condições, stdin, stdout e stderr, bem como os valores originais de __stdin__, __stdout__ e __stderr__ podem ser None. Geralmente é o caso de aplicativos GUI do Windows que não estão conectados a um console e aplicativos Python iniciados com pythonw.

sys.thread_info¶

Uma tupla nomeada contendo informações sobre a implementação do thread.

Atributo

Explanação

name

Name of the thread implementation:

'nt': Windows threads

'pthread': threads POSIX

'solaris': Solaris threads

lock

Name of the lock implementation:

'semaphore': a lock uses a semaphore

'mutex+cond': a lock uses a mutex and a condition variable

None se essa informação for desconhecida

version

Name and version of the thread library. It is a string, or None if this information is unknown.

Novo na versão 3.3.

sys.tracebacklimit¶: Quando essa variável é definida como um valor inteiro, ela determina o número máximo de níveis de informações de traceback impressas quando ocorre uma exceção não tratada. O padrão é 1000. Quando definida como 0 ou menos, todas as informações de traceback são suprimidas e apenas o tipo e o valor da exceção são impressos.

sys.unraisablehook(unraisable, /)¶

Trata uma exceção não levantada

Chamada quando uma exceção ocorreu, mas não há como o Python manipulá-la. Por exemplo, quando um destrutor levanta uma exceção ou durante a coleta de lixo (gc.collect()).

O argumento unraisable tem os seguintes atributos:

exc_type: Tipo de exceção..
exc_value: Valor da exceção, pode ser None.
exc_traceback: Pilha de execução da exceção, pode ser None.
err_msg: Error message, can be None.
object: Object causing the exception, can be None.

The default hook formats err_msg and object as: f'{err_msg}: {object!r}'; use “Exception ignored in” error message if err_msg is None.

sys.unraisablehook() pode ser substituída para controlar como exceções não levantáveis são manipuladas.

Storing exc_value using a custom hook can create a reference cycle. It should be cleared explicitly to break the reference cycle when the exception is no longer needed.

Storing object using a custom hook can resurrect it if it is set to an object which is being finalized. Avoid storing object after the custom hook completes to avoid resurrecting objects.

See also excepthook() which handles uncaught exceptions.

Raise an auditing event sys.unraisablehook with arguments hook, unraisable when an exception that cannot be handled occurs. The unraisable object is the same as what will be passed to the hook. If no hook has been set, hook may be None.

Novo na versão 3.8.

sys.version¶: Uma string contendo o número da versão do interpretador Python mais informações adicionais sobre o número da construção e o compilador usado. Esta string é exibida quando o interpretador interativo é iniciado. Não extraia informações de versão dela, em vez disso, use version_info e as funções fornecidas pelo módulo platform.

sys.api_version¶: A versão da API C para este interpretador. Programadores podem achar isso útil ao depurar conflitos de versão entre Python e módulos de extensão.

sys.version_info¶: Uma tupla contendo os cinco componentes do número da versão: major, minor, micro, releaselevel e serial. Todos os valores, exceto releaselevel, são inteiros; o nível de versão é 'alpha', 'beta', 'candidate' ou 'final'. O valor version_info correspondente à versão 2.0 do Python é (2, 0, 0, 'final', 0). Os componentes também podem ser acessados por nome, então sys.version_info[0] é equivalente a sys.version_info.major e assim por diante.

Alterado na versão 3.1: Added named component attributes.

sys.warnoptions¶: Este é um detalhe de implementação do framework de avisos; não modifique este valor. Consulte o módulo warnings para obter mais informações sobre o framework de avisos.

sys.winver¶

The version number used to form registry keys on Windows platforms. This is stored as string resource 1000 in the Python DLL. The value is normally the first three characters of version. It is provided in the sys module for informational purposes; modifying this value has no effect on the registry keys used by Python.

Disponibilidade: Windows.

sys._xoptions¶

Um dicionário dos vários sinalizadores específicos de implementação passados pela opção de linha de comando -X. Os nomes de opção são mapeados para seus valores, se fornecidos explicitamente, ou para True. Exemplo:

$ ./python -Xa=b -Xc
Python 3.2a3+ (py3k, Oct 16 2010, 20:14:50)
[GCC 4.4.3] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import sys
>>> sys._xoptions
{'a': 'b', 'c': True}

CPython implementation detail: Esta é uma maneira específica do CPython de acessar opções passadas por -X. Outras implementações podem exportá-las por outros meios, ou não exportá-las.

Novo na versão 3.2.

Citações

C99: ISO/IEC 9899:1999. “Programming languages – C.” A public draft of this standard is available at http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1256.pdf.

`sys` — Parâmetros e funções específicas do sistema¶

Tópico anterior

Próximo tópico

Essa Página

sys — Parâmetros e funções específicas do sistema¶

`sys` — Parâmetros e funções específicas do sistema¶