# `site` — Gancho de configuração específico do site

Código-fonte: Lib/site.py

Este módulo é importado automaticamente durante a inicialização. A importação automática pode ser suprimida usando a opção `-S` do interpretador.

A importação deste módulo normalmente anexa caminhos específicos do site ao caminho de pesquisa de módulos e adiciona chamáveis, incluindo `help()` ao espaço de nomes embutido. No entanto, a opção de inicialização do Python `-S` bloqueia isso e este módulo pode ser importado com segurança sem modificações automáticas no caminho de pesquisa de módulos ou adições aos módulos embutidos. Para acionar explicitamente as adições usuais específicas do site, chame a função `main()`.

Alterado na versão 3.3: A importação do módulo usado para acionar a manipulação de caminhos, mesmo ao usar `-S`.

It starts by constructing up to four directories from a head and a tail part. For the head part, it uses `sys.prefix` and `sys.exec_prefix`; empty heads are skipped. For the tail part, it uses the empty string and then `lib/site-packages` (on Windows) or `lib/pythonX.Y[t]/site-packages` (on Unix and macOS). (The optional suffix “t” indicates the free-threaded build, and is appended if `"t"` is present in the `sys.abiflags` constant.) For each of the distinct head-tail combinations, it sees if it refers to an existing directory, and if so, adds it to `sys.path` and also inspects the newly added path for configuration files.

Alterado na versão 3.5: Suporte para o diretório “site-python” foi removido.

Alterado na versão 3.13: No Unix, as instalações do Python threads livres são identificadas pelo sufixo “t” no nome do diretório específico da versão, como `lib/python3.13t/`.

Alterado na versão 3.14: `site` is no longer responsible for updating `sys.prefix` and `sys.exec_prefix` on Ambientes virtuais. This is now done during the path initialization. As a result, under Ambientes virtuais, `sys.prefix` and `sys.exec_prefix` no longer depend on the `site` initialization, and are therefore unaffected by `-S`.

Ao executar em um ambiente virtual, o arquivo `pyvenv.cfg` em `sys.prefix` é verificado em busca de configurações específicas do site. Se a chave `include-system-site-packages` existir e estiver definida como `true` (sem distinção entre maiúsculas e minúsculas), os prefixos de nível de sistema serão pesquisados em busca de site-packages; caso contrário, não serão.

Um arquivo de configuração de caminho é aquele cujo nome tem o formato `name.pth` e que existe em um dos quatro diretórios mencionados acima; seu conteúdo são itens adicionais (um por linha) a serem adicionados ao `sys.path`. Itens inexistentes nunca são adicionados ao `sys.path` e não é verificado se o item se refere a um diretório, e não a um arquivo. Nenhum item é adicionado ao `sys.path` mais de uma vez. Linhas em branco e linhas iniciadas com `#` são ignoradas. Linhas iniciadas com `import` (seguidas de espaço ou tabulação) são executadas.

Nota

Uma linha executável em um arquivo `.pth` é executada a cada inicialização do Python, independentemente de um módulo em particular ser realmente usado. Seu impacto deve, portanto, ser reduzido ao mínimo. O objetivo principal das linhas executáveis é tornar o(s) módulo(s) correspondente(s) importável (carregar ganchos de importação de terceiros, ajustar `PATH` etc). Qualquer outra inicialização deve ser feita na importação real de um módulo, se e quando isso acontecer. Limitar um fragmento de código a uma única linha é uma medida deliberada para desencorajar colocar qualquer coisa mais complexa aqui.

Alterado na versão 3.13: Os arquivos `.pth` agora são decodificados primeiro por UTF-8 e depois pela codificação da localidade se falhar.

Por exemplo, suponha que `sys.prefix` e `sys.exec_prefix` sejam definidos com `/usr/local`. A biblioteca Python X.Y é instalado em `/usr/local/lib/pythonX.Y`. Suponha que isso tenha um subdiretório `/usr/local/lib/pythonX.Y/site-packages` com três subsubdiretórios, `foo`, `bar` e `spam`, e dois caminhos arquivos de configuração, `foo.pth` e `bar.pth`. Presuma que `foo.pth` contém o seguinte:

    # configuração do pacote foo

    foo
    bar
    bletch

e que `bar.pth` contém:

    # configuração do pacote bar

    bar

Em seguida, os seguintes diretórios específicos da versão são adicionados a `sys.path`, nesta ordem:

    /usr/local/lib/pythonX.Y/site-packages/bar
    /usr/local/lib/pythonX.Y/site-packages/foo

Observe que `bletch` é omitido porque não existe; o diretório `bar` precede o diretório `foo` porque `bar.pth` vem em ordem alfabética antes de `foo.pth`; e `spam` é omitido porque não é mencionado em nenhum dos arquivos de configuração de caminho.

## `sitecustomize`

Após essas manipulações de caminho, é feita uma tentativa de importar um módulo chamado `sitecustomize`, que pode executar personalizações arbitrárias específicas do site. Ele é normalmente criado por um administrador de sistema no diretório site-packages. Se essa importação falhar com uma `ImportError` ou sua exceção de subclasse, e o atributo `name` da exceção for igual a `'sitecustomize'`, ele será ignorado silenciosamente. Se o Python for iniciado sem fluxos de saída disponíveis, como com `pythonw.exe` no Windows (que é usado por padrão para iniciar o IDLE), a tentativa de saída de `sitecustomize` será ignorada. Qualquer outra exceção causa uma falha silenciosa e talvez misteriosa do processo.

## `usercustomize`

Depois disso, é feita uma tentativa de importar um módulo chamado `usercustomize`, que pode executar personalizações arbitrárias específicas do usuário, se `ENABLE_USER_SITE` for true. Este arquivo deve ser criado no diretório site-packages de usuário (veja abaixo), que faz parte de `sys.path` a menos que seja desabilitado por `-s`. Se esta importação falhar com um `ImportError` ou sua exceção de subclasse, e o atributo `name` da exceção for igual a `'usercustomize'`, ele será ignorado silenciosamente.

Observe que, para alguns sistemas não Unix, `sys.prefix` e `sys.exec_prefix` estão vazios, e as manipulações de caminho são ignoradas; no entanto, a importação de `sitecustomize` e `usercustomize` ainda é tentada.

## Configuração Readline

Em sistemas que oferecem suporte a `readline`, este módulo também importará e configurará o módulo `rlcompleter`, se o Python for iniciado em modo interativo e sem a opção `-S`. O comportamento padrão é habilitar tab-completion e usar `~/.python_history` como o arquivo de salvamento do histórico. Para desabilitá-lo, exclua (ou substitua) o atributo `sys.__interactivehook__` no seu módulo `sitecustomize` ou `usercustomize` ou no seu arquivo `PYTHONSTARTUP`.

Alterado na versão 3.4: A ativação do rlcompleter e do histórico foi feita automaticamente.

## Conteúdo do módulo

site.PREFIXES

  Uma lista de prefixos para diretórios site-package.

site.ENABLE_USER_SITE

  Sinalizador mostrando o status do diretório site-packages do usuário. `True` significa que ele está habilitado e foi adicionado a `sys.path`. `False` significa que ele foi desabilitado por solicitação do usuário (com `-s` ou `PYTHONNOUSERSITE`). `None` significa que ele foi desabilitado por motivos de segurança (incompatibilidade entre o ID do usuário ou grupo e o ID efetivo) ou por um administrador.

site.USER_SITE

  Caminho para o usuário site-packages para o Python em execução. Pode ser `None` se `getusersitepackages()` ainda não tiver sido chamado. O valor padrão é `~/.local/lib/pythonX.Y[t]/site-packages` para construções UNIX e macOS não-framework, `~/Library/Python/X.Y/lib/python/site-packages` para construções macOS framework e `%APPDATA%\Python\PythonXY\site-packages` no Windows. O “t” opcional indica a construção com threads livres. Este diretório é um diretório de site, o que significa que os arquivos `.pth` nele serão processados.

site.USER_BASE

  Caminho para o diretório base para os pacotes do site do usuário. Pode ser `None` se `getuserbase()` ainda não tiver sido chamado. O valor padrão é `~/.local` para construções não-framework UNIX e macOS, `~/Library/Python/X.Y` para construções de framework macOS e `%APPDATA%\Python` para Windows. Este valor é usado para calcular os diretórios de instalação para scripts, arquivos de dados, módulos Python, etc. para o esquema de instalação de usuário. Veja também `PYTHONUSERBASE`.

site.main()

  Adiciona todos os diretórios padrão específicos do site ao caminho de pesquisa de módulos. Esta função é chamada automaticamente quando este módulo é importado, a menos que o interpretador Python tenha sido iniciado com o sinalizador `-S`.

  Alterado na versão 3.3: Esta função costumava ser chamada incondicionalmente.

site.addsitedir(sitedir, known_paths=None)

  Adiciona um diretório a sys.path e processa seus arquivos `.pth`. Normalmente usado em `sitecustomize` ou `usercustomize` (veja acima).

site.getsitepackages()

  Retorna uma lista contendo todos os diretórios globais de pacotes de sites.

  Adicionado na versão 3.2.

site.getuserbase()

  Retorna o caminho do diretório base do usuário, `USER_BASE`. Se ele ainda não foi inicializado, esta função também o definirá, respeitando `PYTHONUSERBASE`.

  Adicionado na versão 3.2.

site.getusersitepackages()

  Retorna o caminho do diretório site-packages específico do usuário, `USER_SITE`. Se ele ainda não foi inicializado, esta função também o definirá, respeitando `USER_BASE`. Para determinar se o site-packages específico do usuário foi adicionado a `sys.path`, `ENABLE_USER_SITE` deve ser usado.

  Adicionado na versão 3.2.

## Interface de linha de comando

The `site` module also provides a way to get the user directories from the command line:

    $ python -m site --user-site
    /home/user/.local/lib/python3.11/site-packages

Se for chamado sem argumentos, ele vai exibir o conteúdo de `sys.path` na saída padrão, seguido pelo valor de `USER_BASE` e se o diretório existe, depois o mesmo para `USER_SITE` e, finalmente, o valor de `ENABLE_USER_SITE`.

--user-base

  Exibe o caminho para o diretório base do usuário.

--user-site

  Exibe o caminho para o diretório site-packages do usuário.

Se ambas as opções forem fornecidas, a base do usuário e o site do usuário serão exibidos (sempre nesta ordem), separados por `os.pathsep`.

Se qualquer opção for fornecida, o script sairá com um destes valores: `0` se o diretório site-packages do usuário estiver habilitado, `1` se ele foi desabilitado pelo usuário, `2` se ele foi desabilitado por motivos de segurança ou por um administrador, e um valor maior que 2 se houver um erro.

Ver também

- PEP 370 – Diretório site-packages por usuário.

- A inicialização do caminho de pesquisa de módulos sys.path – A inicialização de `sys.path`.